Changeset b5f2548 in git

Timestamp:

Aug 26, 2014, 11:16:33 AM (9 years ago)

Author:

Martin Lee <martinlee84@…>

Branches:

(u'spielwiese', '91e5db82acc17434e4062bcfa44e6efa7d41fd30')

Children:

91695f2af09f5a3a05d6d8c4ee652802f6d85b68

Parents:

8c5f4b2e320efaafe00bfaf0910c580fa48ffc9d

git-author:

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

git-committer:

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

Message:

moved docu from .cc to .h

Location:

factory

Files:

• cf_cyclo.cc (modified) (3 diffs)
• cf_cyclo.h (modified) (1 diff)

factory/cf_cyclo.cc

@@ -26 +26 @@
 #endif
 
-
-/// integer factorization using table look-ups,
-/// function may fail if integer contains primes which exceed the largest prime
-/// in our table
 int* integerFactorizer (const long integer, int& length, bool& fail)
 {
@@ -110 +106 @@
 }
 
-/// compute the n-th cyclotomic polynomial,
-/// function may fail if integer_factorizer fails to factorize n
 CanonicalForm cyclotomicPoly (int n, bool& fail)
 {
@@ -138 +132 @@
 
 #ifdef HAVE_NTL
-/// checks if alpha is a primitive element, alpha is assumed to be an algebraic
-/// variable over some finite prime field
 bool isPrimitive (const Variable& alpha, bool& fail)
 {

factory/cf_cyclo.h

@@ -17 +17 @@
 // #include "config.h"
 
-int* integerFactorizer (const long integer, int& length, bool& fail);
-CanonicalForm cyclotomicPoly (int n, bool& fail);
-bool isPrimitive (const Variable& alpha, bool& fail);
+/// integer factorization using table look-ups,
+/// function may fail if integer contains primes which exceed the largest prime
+/// in our table
+int* integerFactorizer (const long integer, ///< [in] some integer
+                        int& length,        ///< [in,out] number of factors
+                        bool& fail          ///< [in,out] failure?
+                       );
+
+/// compute the n-th cyclotomic polynomial,
+/// function may fail if integer_factorizer fails to factorize n
+CanonicalForm
+cyclotomicPoly (int n,     ///< [in] some integer
+                bool& fail ///< [in,out] failure?
+               );
+
+/// checks if alpha is a primitive element, alpha is assumed to be an algebraic
+/// variable over some finite prime field
+bool isPrimitive (const Variable& alpha, ///< [in] some algebraic variable
+                  bool& fail             ///< [in,out] failure?
+                 );
 
 #endif