Changeset 91695f in git

Timestamp:

Aug 26, 2014, 11:18:18 AM (9 years ago)

Author:

Martin Lee <martinlee84@…>

Branches:

(u'spielwiese', '91e5db82acc17434e4062bcfa44e6efa7d41fd30')

Children:

b53ff6a932a721af73802744f9ad0feefc3dce66

Parents:

b5f2548db5f32142a798dc79e2f5704aeaa91143

git-author:

Martin Lee <martinlee84@web.de>2014-08-26 11:18:18+02:00

git-committer:

Martin Lee <martinlee84@web.de>2014-08-26 12:29:12+02:00

Message:

more docu in cfModGcd.h

File:

• factory/cfModGcd.h (modified) (8 diffs)

factory/cfModGcd.h

@@ -22 +22 @@
 
 CanonicalForm modGCDFq (const CanonicalForm& F, const CanonicalForm& G,
-                  Variable & alpha, CFList& l, bool& top_level);
+                        Variable & alpha, CFList& l, bool& top_level);
 
 /// GCD of A and B over \f$ F_{p}(\alpha ) \f$
-static inline CanonicalForm modGCDFq (const CanonicalForm& A, const CanonicalForm& B,
-                                Variable & alpha)
+static inline
+CanonicalForm modGCDFq (const CanonicalForm& A, ///<[in] poly over F_q
+                        const CanonicalForm& B, ///<[in] poly over F_q
+                        Variable & alpha        ///<[in] algebraic variable
+                       )
 {
   CFList list;
@@ -34 +37 @@
 
 
-CanonicalForm modGCDFp (const CanonicalForm& F, const CanonicalForm&  G,
-                           bool& top_level, CFList& l);
+CanonicalForm
+modGCDFp (const CanonicalForm& F, const CanonicalForm& G, bool& top_level,
+          CFList& l);
 
-CanonicalForm modGCDFp (const CanonicalForm& F, const CanonicalForm&  G, CanonicalForm& coF, CanonicalForm& coG,
-                           bool& topLevel, CFList& l);
+CanonicalForm
+modGCDFp (const CanonicalForm& F, const CanonicalForm& G,
+          CanonicalForm& coF, CanonicalForm& coG,
+          bool& topLevel, CFList& l);
 
 ///GCD of A and B over \f$ F_{p} \f$
-static inline CanonicalForm modGCDFp (const CanonicalForm& A, const CanonicalForm& B)
+static inline
+CanonicalForm modGCDFp (const CanonicalForm& A, ///<[in] poly over F_p
+                        const CanonicalForm& B  ///<[in] poly over F_p
+                       )
 {
   CFList list;
@@ -48 +57 @@
 }
 
-static inline CanonicalForm modGCDFp (const CanonicalForm& A, const CanonicalForm& B, CanonicalForm& coA, CanonicalForm& coB)
+static inline
+CanonicalForm modGCDFp (const CanonicalForm& A, const CanonicalForm& B,
+                        CanonicalForm& coA, CanonicalForm& coB)
 {
   CFList list;
@@ -55 +66 @@
 }
 
-CanonicalForm modGCDGF (const CanonicalForm& F, const CanonicalForm& G, CFList& l,
-        bool& top_level);
+CanonicalForm
+modGCDGF (const CanonicalForm& F, const CanonicalForm& G, CFList& l,
+          bool& top_level);
 
 /// GCD of A and B over GF
-static inline CanonicalForm modGCDGF (const CanonicalForm& A, const CanonicalForm& B)
+static inline
+CanonicalForm modGCDGF (const CanonicalForm& A, ///<[in] poly over GF
+                        const CanonicalForm& B  ///<[in] poly over GF
+                       )
 {
   ASSERT (CFFactory::gettype() == GaloisFieldDomain,
@@ -73 +88 @@
 /// Zippel's sparse GCD over Fp
 static inline
-CanonicalForm sparseGCDFp (const CanonicalForm& A, const CanonicalForm& B)
+CanonicalForm sparseGCDFp (const CanonicalForm& A, ///<[in] poly over F_p
+                           const CanonicalForm& B  ///<[in] poly over F_p
+                          )
 {
   ASSERT (CFFactory::gettype() == FiniteFieldDomain,
@@ -82 +99 @@
 }
 
-/// Zippel's sparse GCD over Fq
+
 CanonicalForm
 sparseGCDFq (const CanonicalForm& F, const CanonicalForm& G,
              const Variable& alpha, CFList& l, bool& topLevel);
 
+/// Zippel's sparse GCD over Fq
 static inline
-CanonicalForm sparseGCDFq (const CanonicalForm& A, const CanonicalForm& B,
-                           const Variable& alpha)
+CanonicalForm sparseGCDFq (const CanonicalForm& A, ///<[in] poly over F_q
+                           const CanonicalForm& B, ///<[in] poly over F_q
+                           const Variable& alpha   ///<[in] algebraic variable
+                          )
 {
   CFList list;
@@ -96 +116 @@
 }
 
+/// extract monomials of F, parts in algebraic variable are considered
+/// coefficients
 CFArray
-getMonoms (const CanonicalForm& F);
+getMonoms (const CanonicalForm& F ///<[in] some poly
+          );
 
 bool
@@ -104 +127 @@
                  const CanonicalForm& cand);
 
-CanonicalForm modGCDZ ( const CanonicalForm & FF, const CanonicalForm & GG );
+/// modular GCD over Z
+CanonicalForm modGCDZ (const CanonicalForm & FF, ///<[in] poly over Z
+                       const CanonicalForm & GG  ///<[in] poly over Z
+                      );
 #endif