Changeset 73e699 in git

Timestamp:

Jun 3, 2014, 2:23:10 PM (10 years ago)

Author:

Martin Lee <martinlee84@…>

Branches:

(u'fieker-DuVal', '117eb8c30fc9e991c4decca4832b1d19036c4c65')(u'spielwiese', '38077648e7239f98078663eb941c3c979511150a')

Children:

17f7438e0f4860ab1688bce1faa8ee72ca1ea450

Parents:

c8b90752475f4b6ebb4c4b011e72d0d04b5449e4

git-author:

Martin Lee <martinlee84@web.de>2014-06-03 14:23:10+02:00

git-committer:

Martin Lee <martinlee84@web.de>2014-06-04 11:54:58+02:00

Message:

chg: more documentation for factory
chg: more documentation for factorization over alg. func. fields

Location:

factory

Files:

• facAlgFunc.cc (modified) (1 diff)
• facAlgFunc.h (modified) (1 diff)
• factory.dox (modified) (1 diff)

factory/facAlgFunc.cc

@@ -600 +600 @@
 
 
-/// map elements in AS into a PIE L and record where the variables are mapped to
-/// in varsMapLevel, i.e varsMapLevel contains a list of pairs of variables
-/// $v_i$ and integers $e_i$ such that
-/// $L=K(\sqrt[p^{e_1}]{v_1}, \ldots, \sqrt[p^{e_n}]{v_n})$
+/// map elements in @a AS into a PIE \f$ L \f$ and record where the variables
+/// are mapped to in @a varsMapLevel, i.e @a varsMapLevel contains a list of
+/// pairs of variables \f$ v_i \f$ and integers \f$ e_i \f$ such that
+/// \f$ L=K(\sqrt[p^{e_1}]{v_1}, \ldots, \sqrt[p^{e_n}]{v_n}) \f$
 CFList
 mapIntoPIE (CFFList& varsMapLevel, CanonicalForm& lcmVars, const CFList & AS)

factory/facAlgFunc.h

@@ -22 +22 @@
 CanonicalForm alg_gcd(const CanonicalForm &, const CanonicalForm &, const CFList &);
 /*BEGINPUBLIC*/
-CFFList facAlgFunc2 (const CanonicalForm & f, const CFList & as);
-CFFList facAlgFunc (const CanonicalForm & f, const CFList & as);
+
+/// factorize a polynomial @a f that is irreducible over the ground field modulo
+/// an extension given by an irreducible characteristic set @a as, @a f is
+/// assumed to be integral, i.e. \f$ f\in K[x_1,\ldots,x_n]/(as) \f$, and each
+/// element of @a as is assumed to be integral as well. \f$ K \f$ must be either
+/// \f$ F_p \f$ or \f$ Q \f$.
+///
+/// @return the returned factors are not necessarily monic but only primitive
+/// and the product of the factors equals @a f up to a unit.
+CFFList facAlgFunc2 (const CanonicalForm & f,///<[in] univariate poly
+                     const CFList & as       ///<[in] irreducible characteristic
+                                             ///< set
+                    );
+
+/// factorize a polynomial @a f modulo an extension given by an irreducible
+/// characteristic set as, @a f is assumed to be integral, i.e.
+/// \f$ f\in K[x_1,\ldots,x_n]/(as) \f$, and each element of @a as is assumed to
+/// be integral as well. \f$ K \f$ must be either \f$ F_p \f$ or \f$ Q \f$.
+///
+/// @return the returned factors are not necessarily monic but only primitive
+/// and the product of the factors equals @a f up to a unit.
+CFFList facAlgFunc (const CanonicalForm & f, ///<[in] univariate poly
+                    const CFList & as        ///<[in] irreducible characteristic
+                                             ///< set
+                   );
 /*ENDPUBLIC*/
 

factory/factory.dox

@@ -1 +1 @@
 /*! \page factory_page Factory
  *
- * A library for univ.-poly. factorization over several simple fields(?)
- * (this is a part of Singular which may also be used standalone e.g. by M2 with some restrictions).
+ * Factory is a C++ class library that implements a recursive representation
+ * of multivariate polynomial data.
  *
- * ?extensions? parameters??
+ * Factory handles sparse multivariate polynomials over different
+ * coefficient domains, such as Z, Q and GF(q), as well as algebraic
+ * extensions over Q and GF(q) in an efficient way.  Factory includes
+ * algorithms for computing univariate and multivariate gcds, resultants,
+ * chinese remainders, algorithms to factorize multivariate polynomials,
+ * univariate polynomials over alg. function fields, and to compute the
+ * absolute factorization of multivariate polynomials with integer coefficients.
  *
- * TODO: here should be a high level description for factory + references to
- * its main structures (\ref CanonicalForm) and maybe some important functions (e.g. factorization)?
- * 
- * 
- * NOTE: it now also contains the functionality from the obsolete package libfac.
+ * The interface to the polynomial system of Factory is provided by a single
+ * class `CanonicalForm' which can deal with elements of the coefficient
+ * domain as well as polynomials.
+ *
+ * \note For more information on how to configure, install and add new code to
+ * factory, see README.
  *
  */