Changeset 3b6f1b in git for factory/facBivar.h

Timestamp:

Sep 12, 2014, 2:11:16 PM (10 years ago)

Author:

Hans Schoenemann <hannes@…>

Branches:

(u'spielwiese', '17f1d200f27c5bd38f5dfc6e8a0879242279d1d8')

Children:

750a0ef0a22f27fddb8987152aad2b122395dd60

Parents:

eb7c6b1e58d5e8f567c011a4a28afa0700b274e35ce0932fba9e2d08b5823f3de76db0209913f4ae

Message:

Merge pull request #639 from mmklee/docu

Docu+charsets

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