Changeset 3b6f1b in git for factory/facMul.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/facMul.h (modified) (5 diffs)

factory/facMul.h

@@ -19 +19 @@
 
 #ifdef HAVE_NTL
-/// multiplication of univariate polys over a finite field using NTL, if we are
-/// in GF factory's default multiplication is used.
+/// multiplication of univariate polys using FLINT/NTL over F_p, F_q, Z/p^k,
+/// Z/p^k[t]/(f), Z, Q, Q(a), if we are in GF factory's default multiplication
+/// is used. If @a b!= 0 and getCharacteristic() == 0 the input will be
+/// considered as elements over Z/p^k or Z/p^k[t]/(f).
 ///
 /// @return @a mulNTL returns F*G
@@ -29 +31 @@
        );
 
-/// mod of univariate polys over a finite field using NTL, if we are
-/// in GF factory's default mod is used.
+/// mod of univariate polys using FLINT/NTL over F_p, F_q, Z/p^k,
+/// Z/p^k[t]/(f), Z, Q, Q(a), if we are in GF factory's default multiplication
+/// is used. If @a b!= 0 and getCharacteristic() == 0 the input will be
+/// considered as elements over Z/p^k or Z/p^k[t]/(f); in this case invertiblity
+/// of Lc(G) is not checked
 ///
 /// @return @a modNTL returns F mod G
@@ -39 +44 @@
        );
 
-/// division of univariate polys over a finite field using NTL, if we are
-/// in GF factory's default division is used.
+/// division of univariate polys using FLINT/NTL over F_p, F_q, Z/p^k,
+/// Z/p^k[t]/(f), Z, Q, Q(a), if we are in GF factory's default multiplication
+/// is used. If @a b!= 0 and getCharacteristic() == 0 the input will be
+/// considered as elements over Z/p^k or Z/p^k[t]/(f); in this case invertiblity
+/// of Lc(G) is not checked
 ///
 /// @return @a divNTL returns F/G
@@ -49 +57 @@
        );
 
-/// division with remainder of @a F by
-/// @a G wrt Variable (1) modulo @a M.
+/// division with remainder of @a F by @a G wrt Variable (1) modulo @a M.
+/// Uses an algorithm based on Burnikel, Ziegler "Fast recursive division".
 ///
 /// @return @a Q returns the dividend, @a R returns the remainder.
@@ -62 +70 @@
              );
 
-/// division with remainder of @a F by
-/// @a G wrt Variable (1) modulo @a MOD.
+/// division with remainder of @a F by @a G wrt Variable (1) modulo @a MOD.
+/// Uses an algorithm based on Burnikel, Ziegler "Fast recursive division".
 ///
 /// @sa divrem2()