Changeset 642e65 in git for kernel/F5cData.h

Timestamp:

Jul 7, 2009, 8:54:56 PM (14 years ago)

Author:

Christian Eder

Branches:

(u'spielwiese', '8e0ad00ce244dfd0756200662572aef8402f13d5')

Children:

ab3db62fd566bf974e5dcf6da2405b18b464b0c4

Parents:

e9f5b23f3e4572bcb33e40a8f5debc2ca9bd11a6

Message:

implementation of classes Label and CPair in F5cData.*


git-svn-id: file:///usr/local/Singular/svn/trunk@11957 2c84dea3-7e68-4137-9b89-c4e89433aadc

File:

• kernel/F5cData.h (modified) (1 diff)

kernel/F5cData.h

@@ +1 @@
+/*!
+ * \file F5cData.h
+ * \author Christian Eder
+ * \date 07/07/2009
+ * \version 0.01
+ * \brief Declarations of the classes CPair and Rule.
+ * \details This file contains the declarations of the class \c CPair, representing
+ * critical pairs, and the class \c Label, representing the labels, in the F5C
+ * Algorithm. All methods are inlined.
+ */
+
 #ifndef F5CDATA_HEADER
 #define F5CDATA_HEADER
 #ifdef HAVE_F5C
+
+/*!
+ * class definitions of the needed datatypes in the F5C algorithm:
+ * (a) critical pairs
+ * (b) labels
+ */
+class CPair;
+class Label;
+
+
+/*!
+ * \class CPair
+ * \author Christian Eder
+ * \brief This is the data structure of a critical pair in the F5C implementation.
+ * \details
+ */
+class CPair {
+  private:
+  
+  public:
+
+};
+// end CPair
+
+
+/*!
+ * \class Label
+ * \author Christian Eder
+ * \brief This is the data structure of a rule, i.e. a label in the F5C
+ * Algorithm.
+ * \details
+ */
+class Label {
+  private:
+    int*              m_pExpVec;
+    unsigned long     m_nShortExpVec;
+  public:
+    /*!
+     * \fn Label(int* expVec);
+     * \param[in] expVec The exponent vector of some monomial defining a label
+     * \brief Constructor of an object of class \c Label
+     */
+    Label(int* expVec);
+    /*!
+     * \fn ~Label();
+     * \brief Destructor of an object of class \c Label
+     */
+    ~Label();
+    /*!
+     * \fn static inline int getExpVec();
+     * \return The first entry of the \c integer vector at the address \c m_pExpVec
+     * \brief Getter of the \c integer vector at the address \c m_pExpVec
+     */
+    inline int* getExpVec();
+    /*!
+     * \fn static inline long getShortExpVec();
+     * \return The short exponent vector \c m_nShortExpVec of the label
+     * \brief Getter of the \code unsigned long m_nShortExpVec \endcode
+     * 
+     */
+    inline unsigned long getShortExpVec();
+    /*!
+     * \fn static inline unsigned long computeShortExpVec(int* expVec);
+     * \param[in] expVec The exponent vector of some monomial defining a label
+     * \return Short exponent vector of type \code unsigned long \endcode
+     * \brief Computation of the short exponent vector of type \code unsigned 
+     * long \endcode of the exponent vector \c expVec
+     * \note This method is originally in polys-impl.cc, in this version here it
+     * is optimized for the case of working with exponent vectors and not with
+     * polys as input data.
+     */
+    static inline unsigned long computeShortExpVec(int* expVec);
+    /*!
+     * \fn static inline unsigned long getBitFields(int e, unsigned int s,
+     * unsigned int n);
+     * \param[in] e Entry of the exponent vector
+     * \param[in] s Integer smaller than the bitsize of \c long
+     * \param[in] n Integer representing the number of bits per entry of the
+     * exponent vector \c expVec
+     * \return \code unsigned long \endcode the bitfield for the input data
+     * \brief Computation of the bitfield of type \code unsigned long \endcode
+     * for an entry \c e of the given exponent vector \c expVec at an iteration 
+     * step where \c s iterates over all \c integers smaller than the bitsize of 
+     * \c long, and \c n iterates over the number of bits per entry of the 
+     * exponent vector \c expVec
+     * \note This method is originally in polys-impl.cc, in this version here it
+     * is optimized for the case of working with exponent vectors and not with
+     * polys as input data.
+     */
+    static inline unsigned long getBitFields(int e, unsigned int s, unsigned int n);
+};
+// end Label
 
 #endif