Changeset 227efd in git for coeffs/coeffs.h

Timestamp:

Jun 16, 2010, 5:58:04 PM (14 years ago)

Author:

Hans Schoenemann <hannes@…>

Branches:

(u'spielwiese', 'fe61d9c35bf7c61f2b6cbf1b56e25e2f08d536cc')

Children:

0eb229de7f102c905e5f2b8497a9a524f8ede977

Parents:

584cbc74b85aa9f5b4e31e70416327028b017132

git-author:

Hans Schoenemann <hannes@mathematik.uni-kl.de>2010-06-16 17:58:04+02:00

git-committer:

Mohamed Barakat <mohamed.barakat@rwth-aachen.de>2011-11-09 11:55:11+01:00

Message:

debug stuff enabled
(and some names changed: always remember: we all have to type these
names: so they should be descriptive, but not longer.
For example: what other type then BOOLEAN should n_Equal return ?)

File:

• coeffs/coeffs.h (modified) (10 diffs)

coeffs/coeffs.h

@@ -10 +10 @@
 
 #include <auxiliary.h>
+/* for assume: */
+#include <reporter.h>
 #include <si_gmp.h>
 
@@ -39 +41 @@
 #endif
 
-// and the routines w.r.t. currRing:
+// the access methods (part 1) (see also part2 below):
+//
+// the routines w.r.t. currRing:
 // (should only be used in the context of currRing, i.e. in the interpreter)
 #define nCopy(n)          n_Copy(n, currRing->cf)
@@ -218 +222 @@
 inline void nSetChar(coeffs r)
 {
-  if ((r!=NULL) && (r->cfSetChar!=NULL)) r->cfSetChar(r);
+  assume(r!=NULL); // r==NULL is an error
+  if (r->cfSetChar!=NULL) r->cfSetChar(r);
 }
 
@@ -226 +231 @@
 
 
-// the access methods:
+// the access methods (part 2):
 
 /// return a copy of a
@@ -232 +237 @@
 static inline void   n_Delete(number* p, const coeffs r){ return (r)->cfDelete(p, r); }
 
-static inline BOOLEAN n_AreEqual(number a, number b, const coeffs r){ return (r)->cfEqual(a, b, r); }
+static inline BOOLEAN n_Equal(number a, number b, const coeffs r){ return (r)->cfEqual(a, b, r); }
 static inline BOOLEAN n_IsZero(number n, const coeffs r){ return (r)->cfIsZero(n,r); }
 static inline BOOLEAN n_IsOne(number n,  const coeffs r){ return (r)->cfIsOne(n,r); }
 static inline BOOLEAN n_IsMOne(number n, const coeffs r){ return (r)->cfIsMOne(n,r); }
-static inline BOOLEAN n_IsGreaterZero(number n, const coeffs r){ return (r)->cfGreaterZero(n,r); }
+static inline BOOLEAN n_GreaterZero(number n, const coeffs r){ return (r)->cfGreaterZero(n,r); }
 // cfGreater?
 
@@ -248 +253 @@
 static inline number n_Invers(number a,  const coeffs r){ return (r)->cfInvers(a,r); }
 
-/// how complicated, (0) => 0, otherwise positive
+/// use for pivot strategies, (0) => 0, otherwise positive
 static inline int    n_Size(number n,    const coeffs r){ return (r)->cfSize(n,r); }
 
@@ -254 +259 @@
 static inline void   n_Normalize(number& n, const coeffs r){ return (r)->cfNormalize(n,r); }
 
-/// Normalize and Write
+/// Normalize and Write to the output buffer of reporter
 static inline void   n_Write(number& n,  const coeffs r){ return (r)->cfWrite(n,r); }
 
@@ -267 +272 @@
 
 static inline number n_Mult(number a, number b, const coeffs r){ return (r)->cfMult(a, b, r); }
+
 /// Inplace multiplication: a := a * b
 static inline void n_InpMult(number &a, number b, const coeffs r){ return (r)->cfInpMult(a,b,r); }
@@ -279 +285 @@
 static inline number n_Gcd(number a, number b, const coeffs r){ return (r)->cfGcd(a,b,r); }
 
-/// Tests whether n is a correct number.
+#ifdef LDEBUG
+/// Tests whether n is a correct number: only used if LDEBUG is defined
 static inline BOOLEAN n_DBTest(number n, const char *filename, const int linenumber, const coeffs r)
 {
-#ifdef LDEBUG
   return (r)->cfDBTest(n, filename, linenumber, r);
-#else
-  return TRUE;
-#endif
 }
 /// BOOLEAN n_Test(number a, const coeffs r)
 #define n_Test(a,r)  n_DBTest(a, __FILE__, __LINE__, r)
+#else
+#define n_Test(a,r)  (1)
+#endif
 
 // Missing wrappers for:
@@ -297 +303 @@
 
 // Deprecated:
-static inline BOOLEAN n_GreaterZero(number n, const coeffs r){ return n_IsGreaterZero(n,r); }
-static inline BOOLEAN n_Equal(number a, number b, const coeffs r){ return n_AreEqual(a, b, r); }
-
-// Deprecated:
 static inline int n_GetChar(const coeffs r){ return nInternalChar(r); }