Changeset bbcc98 in git for factory

Timestamp:

Jan 10, 2013, 4:58:48 PM (11 years ago)

Author:

Martin Lee <martinlee84@…>

Branches:

(u'spielwiese', 'fe61d9c35bf7c61f2b6cbf1b56e25e2f08d536cc')

Children:

a60b8bed450e0ed0680beff9febf2b8c0daf5140

Parents:

074fe740d62bf760e61d3a4d06d754c2dbca7c01

git-author:

Martin Lee <martinlee84@web.de>2013-01-10 16:58:48+01:00

git-committer:

Martin Lee <martinlee84@web.de>2013-02-18 15:01:48+01:00

Message:

chg: more docu

Location:

factory

Files:

• facFqFactorize.cc (modified) (1 diff)
• facFqFactorize.h (modified) (1 diff)

factory/facFqFactorize.cc

@@ -2583 +2583 @@
   {
     cont= content (iter.getItem(), 1);
-    cont= gcd (cont , LCmultiplier);
+    cont= gcd (cont, LCmultiplier);
     contents.append (cont);
     if (cont.inCoeffDomain()) // trivial content->LCmultiplier needs to go there

factory/facFqFactorize.h

@@ -737 +737 @@
                  );
 
-void
-LCHeuristic2 (const CanonicalForm& LCmultiplier,
-              const CFList& factors,
-              CFList& leadingCoeffs,
-              CFList& contents,
-              CFList& LCs,
-              bool& foundTrueMultiplier
+/// heuristic to distribute @a LCmultiplier onto factors based on the contents
+/// of @a factors. @a factors are assumed to come from LucksWangSparseHeuristic.
+/// If not successful @a contents will contain the content of each element of @a
+/// factors and @a LCs will contain the LC of each element of @a factors divided
+/// by its content
+void
+LCHeuristic2 (const CanonicalForm& LCmultiplier,///<[in] divisor of LC (A,1)
+              const CFList& factors,            ///<[in] result of
+                                                ///< LucksWangSparseHeuristic
+              CFList& leadingCoeffs,            ///<[in,out] leading coeffs
+              CFList& contents,                 ///<[in,out] content of factors
+              CFList& LCs,                      ///<[in,out] LC of factors
+                                                ///< divided by content of
+                                                ///< factors
+              bool& foundTrueMultiplier         ///<[in,out] success?
              );
 
-void
-LCHeuristic3 (const CanonicalForm& LCmultiplier,
-              const CFList& factors,
-              const CFList& oldBiFactors,
-              const CFList& contents,
-              const CFList* oldAeval,
-              CanonicalForm& A,
-              CFList*& leadingCoeffs,
-              int lengthAeval,
-              bool& foundMultiplier
+/// heuristic to remove @a LCmultiplier from a factor based on the contents
+/// of @a factors. @a factors are assumed to come from LucksWangSparseHeuristic.
+void
+LCHeuristic3 (const CanonicalForm& LCmultiplier,///<[in] divisor of LC (A,1)
+              const CFList& factors,            ///<[in] result of
+                                                ///< LucksWangSparseHeuristic
+              const CFList& oldBiFactors,       ///<[in] bivariate factors
+                                                ///< without LCmultiplier
+                                                ///< distributed on them
+              const CFList& contents,           ///<[in] content of factors
+              const CFList* oldAeval,           ///<[in] bivariate factors wrt.
+                                                ///< different second vars
+              CanonicalForm& A,                 ///<[in,out] poly
+              CFList*& leadingCoeffs,           ///<[in,out] leading coeffs
+              int lengthAeval,                  ///<[in] length of oldAeval
+              bool& foundMultiplier             ///<[in,out] success?
              );
 
-void
-LCHeuristic4 (const CFList& oldBiFactors,
-              const CFList* oldAeval,
-              const CFList& contents,
-              const CFList& factors,
-              const CanonicalForm& testVars,
-              int lengthAeval,
-              CFList*& leadingCoeffs,
-              CanonicalForm& A,
-              CanonicalForm& LCmultiplier,
-              bool& foundMultiplier
+/// heuristic to remove factors of @a LCmultiplier from @a factors.
+/// More precisely checks if elements of @a contents divide @a LCmultiplier.
+/// Assumes LCHeuristic3 is run before it and was successful.
+void
+LCHeuristic4 (const CFList& oldBiFactors,   ///<[in] bivariate factors
+                                            ///< without LCmultiplier
+                                            ///< distributed on them
+              const CFList* oldAeval,       ///<[in] bivariate factors wrt.
+                                            ///< different second vars
+              const CFList& contents,       ///<[in] content of factors
+              const CFList& factors,        ///<[in] result of
+                                            ///< LucksWangSparseHeuristic
+              const CanonicalForm& testVars,///<[in] product of second vars that
+                                            ///< occur among oldAeval
+              int lengthAeval,              ///<[in] length of oldAeval
+              CFList*& leadingCoeffs,       ///<[in,out] leading coeffs
+              CanonicalForm& A,             ///<[in,out] poly
+              CanonicalForm& LCmultiplier,  ///<[in,out] divisor of LC (A,1)
+              bool& foundMultiplier         ///<[in] success?
              );