Changeset 6fcd65b in git

Timestamp:

Apr 22, 2013, 3:16:46 PM (9 years ago)

Author:

Martin Lee <martinlee84@…>

Branches:

(u'jengelh-datetime', 'ceac47cbc86fe4a15902392bdbb9bd2ae0ea02c6')(u'spielwiese', '5bec8f88c9ee2573d328cf7c3aff2bcb301d2395')

Children:

102daaa5edc8d6b8e7efc450bf1a3ca866ac627a

Parents:

19440966f58621d18daa0987fbb4e8aa899440d7

git-author:

Martin Lee <martinlee84@web.de>2013-04-22 15:16:46+02:00

git-committer:

Martin Lee <martinlee84@web.de>2013-05-02 11:42:40+02:00

Message:

chg: docu

File:

• factory/facAbsFact.h (modified) (3 diffs)

factory/facAbsFact.h

@@ -21 +21 @@
 #include "cfNewtonPolygon.h"
 
-CFAFList absFactorizeMain (const CanonicalForm& F);
+/// main absolute factorization routine, expects bivariate poly which is
+/// primitive wrt. any of its variables and irreducible over Q
+///
+/// @return absFactorizeMain returns a list whose entries contain three entities:
+///         an absolute irreducible factor, an irreducible univariate polynomial
+///         that defines the minimal field extension over which the irreducible
+///         factor is defined and the multiplicity of the absolute irreducible
+///         factor
+CFAFList absFactorizeMain (const CanonicalForm& F ///<[in] s.a.
+                          );
 
+
+/// normalize factors, i.e. make factors monic
 static inline
 void normalize (CFAFList & L)
@@ -31 +42 @@
 }
 
+/// univariate absolute factorization over Q
+///
+/// @return uniAbsFactorize returns a list whose entries contain three entities:
+///         an absolute irreducible factor, an irreducible univariate polynomial
+///         that defines the minimal field extension over which the irreducible
+///         factor is defined and the multiplicity of the absolute irreducible
+///         factor
 static inline
-CFAFList uniAbsFactorize (const CanonicalForm& F)
+CFAFList uniAbsFactorize (const CanonicalForm& F ///<[in] univariate poly over Q
+                         )
 {
   CFFList rationalFactors= factorize (F);
@@ -75 +94 @@
 /*ENDPUBLIC*/
 
-CFAFList absFactorize (const CanonicalForm& G)
+/// absolute factorization of bivariate poly over Q
+///
+/// @return absFactorize returns a list whose entries contain three entities:
+///         an absolute irreducible factor, an irreducible univariate polynomial
+///         that defines the minimal field extension over which the irreducible
+///         factor is defined and the multiplicity of the absolute irreducible
+///         factor
+CFAFList absFactorize (const CanonicalForm& G ///<[in] bivariate poly over Q
+                      )
 {
   //TODO handle homogeneous input