Changeset 30e27f in git for factory/facBivar.h

Timestamp:

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

Author:

Martin Lee <martinlee84@…>

Branches:

(u'spielwiese', 'e7cc1ebecb61be8b9ca6c18016352af89940b21a')

Children:

53e6c3ed92a09bfcbead81b6adcaa7ab3eed1a88

Parents:

b53ff6a932a721af73802744f9ad0feefc3dce66

git-author:

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

git-committer:

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

Message:

more docu in facBivar.h

File:

• factory/facBivar.h (modified) (1 diff)

factory/facBivar.h

@@ -281 +281 @@
             );
 
+/// compute p^k larger than the bound on the coefficients of a factor of @a f
+/// over Q (mipo)
 modpk
-coeffBound ( const CanonicalForm & f, int p, const CanonicalForm& mipo );
-
-void findGoodPrime(const CanonicalForm &f, int &start);
-
+coeffBound (const CanonicalForm & f,  ///< [in] poly over Z[a]
+            int p,                    ///< [in] some positive integer
+            const CanonicalForm& mipo ///< [in] minimal polynomial with
+                                      ///< denominator 1
+           );
+
+/// find a big prime p from our tables such that no term of f vanishes mod p
+void findGoodPrime(const CanonicalForm &f, ///< [in] poly over Z or Z[a]
+                   int &start              ///< [in,out] index of big prime in
+                                           /// cf_primetab.h
+                  );
+
+/// compute p^k larger than the bound on the coefficients of a factor of @a f
+/// over Z
 modpk
-coeffBound ( const CanonicalForm & f, int p );
+coeffBound (const CanonicalForm & f, ///< [in] poly over Z
+            int p                    ///< [in] some positive integer
+           );
 
 #endif