pDebug.cc
Go to the documentation of this file.
1 /****************************************
2 * Computer Algebra System SINGULAR *
3 ****************************************/
4 /***************************************************************
5  * File: pDebug.h
6  * Purpose: implementation of debug related poly routines
7  * Author: obachman (Olaf Bachmann)
8  * Created: 8/00
9  *******************************************************************/
10 
11 #ifndef PDEBUG_CC
12 #define PDEBUG_CC
13 
14 #include <stdarg.h>
15 #include <stdio.h>
16 
17 
18 
19 
20 
21 #include <misc/auxiliary.h>
22 
23 
24 #ifdef PDEBUG
25 
26 // do the following to always enforce checking of pSetm
27 // #undef PDEBUG
28 // #define PDEBUG 2
29 
30 #include <omalloc/omalloc.h>
31 
32 #include <polys/monomials/ring.h>
34 
35 #include <coeffs/coeffs.h>
36 
37 /***************************************************************
38  *
39  * Error reporting
40  *
41  ***************************************************************/
42 // avoid recursive calls
44 BOOLEAN dPolyReportError(poly p, ring r, const char* fmt, ...)
45 {
46  if (d_poly_error_reporting) return FALSE;
48  va_list ap;
49  va_start(ap, fmt);
50 
51  fprintf(stderr, "\n// ***dPolyReportError: ");
52  vfprintf(stderr, fmt, ap);
53  fprintf(stderr, "\n occurred at\n");
54  omPrintCurrentBackTraceMax(stderr, 8);
55  if (p != NULL)
56  {
57  fprintf(stderr, " occurred for poly: ");
58  p_wrp(p, r);
59  omPrintAddrInfo(stderr, p, " ");
60  }
61  dErrorBreak();
63  return FALSE;
64 }
65 
66 /***************************************************************
67  *
68  * checking for ring stuff
69  *
70  ***************************************************************/
72 {
73  if (p != NULL)
74  {
75  #if (OM_TRACK > 0) && defined(OM_TRACK_CUSTOM)
76  void* custom = omGetCustomOfAddr(p);
77  if (custom != NULL)
78  {
79  pPolyAssumeReturnMsg(custom == r ||
80  // be more sloppy for qrings
81  (r->qideal != NULL &&
82  omIsBinPageAddr(p) &&
83  omSizeWOfAddr(p)==omSizeWOfBin(r->PolyBin)) ||
84  rSamePolyRep((ring) custom, r),
85  "monomial not from specified ring",p,r);
86  return TRUE;
87  }
88  else
89  #endif
90  #ifndef X_OMALLOC
91  {
93  return TRUE;
94  }
95  return FALSE;
96  #endif
97  }
98  return TRUE;
99 }
100 
102 {
103  while (p!=NULL)
104  {
106  pIter(p);
107  }
108  return TRUE;
109 }
110 
112 {
113  #ifndef X_OMALLOC
114  pAssumeReturn(r != NULL && r->PolyBin != NULL);
115  #endif
116  return p_CheckIsFromRing(p, r);
117 }
118 
120 {
121  #ifndef X_OMALLOC
122  pAssumeReturn(r != NULL && r->PolyBin != NULL);
123  #endif
124  pAssumeReturn(p != NULL);
125  return p_LmCheckIsFromRing(p, r);
126 }
128 {
129  #ifndef X_OMALLOC
130  pAssumeReturn(r != NULL && r->PolyBin != NULL);
131  #endif
132  return TRUE;
133 }
134 
135 /***************************************************************
136  *
137  * Debugging/statistics of pDivisibleBy
138  *
139  ***************************************************************/
141 {
142  int i=r->N;
143 
144  do
145  {
146  if (p_GetExp(a,i,r) > p_GetExp(b,i,r))
147  return FALSE;
148  i--;
149  }
150  while (i);
151 #ifdef HAVE_RINGS
152  return n_DivBy(pGetCoeff(b), pGetCoeff(a), r->cf);
153 #else
154  return TRUE;
155 #endif
156  }
157 
158 
159 /***************************************************************
160  *
161  * Misc things helpful for debugging
162  *
163  ***************************************************************/
165 {
166  if (m == NULL) return TRUE;
167  while (p != NULL)
168  {
169  if (p == m) return TRUE;
170  pIter(p);
171  }
172  return FALSE;
173 }
175 {
176  while (p != NULL)
177  {
178  if (pIsMonomOf(q, p))
179  {
180  return TRUE;
181  }
182  pIter(p);
183  }
184  return FALSE;
185 }
186 
187 /***************************************************************
188  *
189  * Testing of polys
190  *
191  ***************************************************************/
192 extern void p_Setm_General(poly p, ring r);
193 
194 static poly p_DebugInit(poly p, ring src_ring, ring dest_ring)
195 {
196  poly d_p = p_Init(dest_ring);
197  int i;
198  assume(dest_ring->N == src_ring->N);
199 
200  for (i=1; i<= src_ring->N; i++)
201  {
202  p_SetExp(d_p, i, p_GetExp(p, i, src_ring), dest_ring);
203  }
204  if (rRing_has_Comp(dest_ring))
205  p_SetComp(d_p, p_GetComp(p, src_ring), dest_ring);
206 
207  p_Setm_General(d_p, dest_ring);
208  return d_p;
209 }
210 
212 {
213  assume(r->cf !=NULL);
214 
215  if (PDEBUG > level) level = PDEBUG;
216  if (level < 0 || p == NULL) return TRUE;
217 
218  poly p_prev = NULL;
219 
220  #ifndef OM_NDEBUG
221  #ifndef X_OMALLOC
222  // check addr with level+1 so as to check bin/page of addr
223  _pPolyAssumeReturnMsg(omTestBinAddrSize(p, (omSizeWOfBin(r->PolyBin))*SIZEOF_LONG, level+1)
224  == omError_NoError, "memory error",p,r);
225  #endif
226  #endif
227 
229 
230  // this checks that p does not contain a loop: rather expensive O(length^2)
231  #ifndef OM_NDEBUG
232  if (level > 1)
234  #endif
235 
236  int ismod = p_GetComp(p, r) != 0;
237 
238  while (p != NULL)
239  {
240  // ring check
242  #ifndef OM_NDEBUG
243  #ifndef X_OMALLOC
244  // omAddr check
245  _pPolyAssumeReturnMsg(omTestBinAddrSize(p, (omSizeWOfBin(r->PolyBin))*SIZEOF_LONG, 1)
246  == omError_NoError, "memory error",p,r);
247  #endif
248  #endif
249  // number/coef check
250  _pPolyAssumeReturnMsg(p->coef != NULL || (n_GetChar(r->cf) >= 2), "NULL coef",p,r);
251 
252  #ifdef LDEBUG
253  _pPolyAssumeReturnMsg(n_Test(p->coef,r->cf),"coeff err",p,r);
254  #endif
255  _pPolyAssumeReturnMsg(!n_IsZero(p->coef, r->cf), "Zero coef",p,r);
256 
257  // check for valid comp
258  _pPolyAssumeReturnMsg(p_GetComp(p, r) >= 0 && (p_GetComp(p, r)<65000), "component out of range ?",p,r);
259  // check for mix poly/vec representation
260  _pPolyAssumeReturnMsg(ismod == (p_GetComp(p, r) != 0), "mixed poly/vector",p,r);
261 
262  // special check for ringorder_s/S
263  if ((r->typ!=NULL) && (r->typ[0].ord_typ == ro_syzcomp))
264  {
265  long c1, cc1, ccc1, ec1;
266  sro_ord* o = &(r->typ[0]);
267 
268  c1 = p_GetComp(p, r);
269  if (o->data.syzcomp.Components!=NULL)
270  {
271  cc1 = o->data.syzcomp.Components[c1];
272  ccc1 = o->data.syzcomp.ShiftedComponents[cc1];
273  }
274  else { cc1=0; ccc1=0; }
275  _pPolyAssumeReturnMsg(c1 == 0 || cc1 != 0, "Component <-> TrueComponent zero mismatch",p,r);
276  _pPolyAssumeReturnMsg(c1 == 0 || ccc1 != 0,"Component <-> ShiftedComponent zero mismatch",p,r);
277  ec1 = p->exp[o->data.syzcomp.place];
278  //pPolyAssumeReturnMsg(ec1 == ccc1, "Shifted comp out of sync. should %d, is %d");
279  if (ec1 != ccc1)
280  {
281  dPolyReportError(p,r,"Shifted comp out of sync. should %d, is %d",ccc1,ec1);
282  return FALSE;
283  }
284  }
285 
286  // check that p_Setm works ok
287  if (level > 0)
288  {
289  poly p_should_equal = p_DebugInit(p, r, r);
290  _pPolyAssumeReturnMsg(p_ExpVectorEqual(p, p_should_equal, r), "p_Setm field(s) out of sync",p,r);
291  p_LmFree(p_should_equal, r);
292  }
293 
294  // check order
295  if (p_prev != NULL)
296  {
297  int cmp = p_LmCmp(p_prev, p, r);
298  if (cmp == 0)
299  {
300  _pPolyAssumeReturnMsg(0, "monoms p and p->next are equal", p_prev, r);
301  }
302  else
303  _pPolyAssumeReturnMsg(p_LmCmp(p_prev, p, r) == 1, "wrong order", p_prev, r);
304 
305  // check that compare worked sensibly
306  if (level > 1 && p_GetComp(p_prev, r) == p_GetComp(p, r))
307  {
308  int i;
309  for (i=r->N; i>0; i--)
310  {
311  if (p_GetExp(p_prev, i, r) != p_GetExp(p, i, r)) break;
312  }
313  _pPolyAssumeReturnMsg(i > 0, "Exponents equal but compare different", p_prev, r);
314  }
315  }
316  p_prev = p;
317  pIter(p);
318  }
319  return TRUE;
320 }
321 
323 {
324  if (level < 0 || p == NULL) return TRUE;
325  poly pnext = pNext(p);
326  pNext(p) = NULL;
327  BOOLEAN test_res = _p_Test(p, r, level);
328  pNext(p) = pnext;
329  return test_res;
330 }
331 
333 {
334  if (PDEBUG > level) level = PDEBUG;
335  if (level < 0 || p == NULL) return TRUE;
336  if (pNext(p) == NULL || lmRing == tailRing) return _p_Test(p, lmRing, level);
337 
338  pFalseReturn(_p_LmTest(p, lmRing, level));
339  pFalseReturn(_p_Test(pNext(p), tailRing, level));
340 
341  // check that lm > Lm(tail)
342  if (level > 1)
343  {
344  poly lm = p;
345  poly tail = p_DebugInit(pNext(p), tailRing, lmRing);
346  poly pnext = pNext(lm);
347  pNext(lm) = tail;
348  BOOLEAN cmp = p_LmCmp(lm, tail, lmRing);
349  if (cmp != 1)
350  dPolyReportError(lm, lmRing, "wrong order: lm <= Lm(tail)");
351  p_LmFree(tail, lmRing);
352  pNext(lm) = pnext;
353  return (cmp == 1);
354  }
355  return TRUE;
356 }
357 
358 #endif // PDEBUG
359 
360 #if defined(PDEBUG) || defined(PDIV_DEBUG)
361 static unsigned long pDivisibleBy_number = 1;
362 static unsigned long pDivisibleBy_FALSE = 1;
363 static unsigned long pDivisibleBy_ShortFalse = 1;
364 
365 BOOLEAN pDebugLmShortDivisibleBy(poly p1, unsigned long sev_1, ring r_1,
366  poly p2, unsigned long not_sev_2, ring r_2)
367 {
368  _pPolyAssume(p_GetShortExpVector(p1, r_1) == sev_1, p1, r_1);
369  _pPolyAssume(p_GetShortExpVector(p2, r_2) == ~ not_sev_2, p2, r_2);
370 
372  BOOLEAN ret;
373  if (r_1 == r_2)
374  ret = p_LmDivisibleBy(p1, p2, r_1);
375  else
376  ret = p_LmDivisibleBy(p1, r_1, p2, r_2);
377 
378  if (! ret) pDivisibleBy_FALSE++;
379  if (sev_1 & not_sev_2)
380  {
382  if (ret)
383  dReportError("p1 divides p2, but sev's are wrong");
384  }
385  return ret;
386 }
387 
388 BOOLEAN pDebugLmShortDivisibleByNoComp(poly p1, unsigned long sev_1, ring r_1,
389  poly p2, unsigned long not_sev_2, ring r_2)
390 {
391 // _pPolyAssume((p_GetComp(p1, r_1) == p_GetComp(p2, r_2)) || (p_GetComp(p1, r_1) == 0));
392  _pPolyAssume(p_GetShortExpVector(p1, r_1) == sev_1, p1, r_1);
393  _pPolyAssume(p_GetShortExpVector(p2, r_2) == ~ not_sev_2, p2, r_2);
394 
396  BOOLEAN ret;
397  if (r_1 == r_2)
398  ret = p_LmDivisibleByNoComp(p1, p2, r_1);
399  else
400  ret = p_LmDivisibleByNoComp(p1, r_1, p2, r_2);
401 
402  if (! ret) pDivisibleBy_FALSE++;
403  if (sev_1 & not_sev_2)
404  {
406  if (ret)
407  dReportError("p1 divides p2, but sev's are wrong");
408  }
409  return ret;
410 }
411 
413 {
414  Print("#Tests: %ld; #FALSE %ld(%ld); #SHORT %ld(%ld)\n",
416  pDivisibleBy_FALSE, (unsigned long) ((double)pDivisibleBy_FALSE*((double) 100)/(double)pDivisibleBy_number),
417  pDivisibleBy_ShortFalse, (unsigned long) ((double)pDivisibleBy_ShortFalse*((double)100)/(double)pDivisibleBy_FALSE));
418 }
419 
420 #endif // PDEBUG
421 
422 #endif // PDEBUG_CC
const poly a
Definition: syzextra.cc:212
void p_Setm_General(poly p, ring r)
Definition: p_polys.cc:163
int level(const CanonicalForm &f)
#define Print
Definition: emacs.cc:83
static poly p_DebugInit(poly p, ring src_ring, ring dest_ring)
Definition: pDebug.cc:194
BEGIN_NAMESPACE_SINGULARXX const ring lmRing
Definition: DebugPrint.h:30
int omPrintCurrentBackTraceMax(FILE *fd, int max)
Definition: omRet2Info.c:165
BOOLEAN pDebugLmShortDivisibleByNoComp(poly p1, unsigned long sev_1, ring r_1, poly p2, unsigned long not_sev_2, ring r_2)
Definition: pDebug.cc:388
#define FALSE
Definition: auxiliary.h:94
return P p
Definition: myNF.cc:203
static BOOLEAN p_LmDivisibleByNoComp(poly a, poly b, const ring r)
Definition: p_polys.h:1754
BOOLEAN p_LmCheckPolyRing(poly p, ring r)
Definition: pDebug.cc:119
static unsigned long pDivisibleBy_FALSE
Definition: pDebug.cc:362
static unsigned long p_SetComp(poly p, unsigned long c, ring r)
Definition: p_polys.h:242
#define omTestList(ptr, level)
Definition: omList.h:81
#define p_GetComp(p, r)
Definition: monomials.h:72
BOOLEAN p_DebugLmDivisibleByNoComp(poly a, poly b, ring r)
Definition: pDebug.cc:140
BEGIN_NAMESPACE_SINGULARXX const ring const ring tailRing
Definition: DebugPrint.h:30
omError_t omTestBinAddrSize(void *addr, size_t size, int check_level)
Definition: omDebug.c:44
static FORCE_INLINE int n_GetChar(const coeffs r)
Return the characteristic of the coeff. domain.
Definition: coeffs.h:448
#define TRUE
Definition: auxiliary.h:98
BOOLEAN pHaveCommonMonoms(poly p, poly q)
Definition: pDebug.cc:174
size_t omSizeWOfAddr(void *addr)
#define pAssumeReturn(cond)
Definition: monomials.h:86
static unsigned long pDivisibleBy_number
Definition: pDebug.cc:361
static number & pGetCoeff(poly p)
return an alias to the leading coefficient of p assumes that p != NULL NOTE: not copy ...
Definition: monomials.h:51
BOOLEAN dPolyReportError(poly p, ring r, const char *fmt,...)
Definition: pDebug.cc:44
#define _pPolyAssumeReturn(cond, p, r)
Definition: monomials.h:109
static void p_LmFree(poly p, ring)
Definition: p_polys.h:678
union sro_ord::@0 data
BOOLEAN _p_LmTest(poly p, ring r, int level)
Definition: pDebug.cc:322
#define pIter(p)
Definition: monomials.h:44
#define pFalseReturn(cond)
Definition: monomials.h:147
void omPrintAddrInfo(FILE *fd, void *addr, const char *s)
Definition: omDebugCheck.c:445
BOOLEAN p_LmCheckIsFromRing(poly p, ring r)
Definition: pDebug.cc:71
const ring r
Definition: syzextra.cc:208
Coefficient rings, fields and other domains suitable for Singular polynomials.
static long p_GetExp(const poly p, const unsigned long iBitmask, const int VarOffset)
get a single variable exponent : the integer VarOffset encodes:
Definition: p_polys.h:464
#define assume(x)
Definition: mod2.h:394
BOOLEAN pIsMonomOf(poly p, poly m)
Definition: pDebug.cc:164
#define PDEBUG
Definition: auxiliary.h:169
static FORCE_INLINE BOOLEAN n_DivBy(number a, number b, const coeffs r)
test whether &#39;a&#39; is divisible &#39;b&#39;; for r encoding a field: TRUE iff &#39;b&#39; does not represent zero in Z:...
Definition: coeffs.h:787
static BOOLEAN d_poly_error_reporting
Definition: pDebug.cc:43
#define n_Test(a, r)
BOOLEAN n_Test(number a, const coeffs r)
Definition: coeffs.h:742
Definition: ring.h:226
All the auxiliary stuff.
static int p_LmCmp(poly p, poly q, const ring r)
Definition: p_polys.h:1467
int m
Definition: cfEzgcd.cc:119
BOOLEAN rSamePolyRep(ring r1, ring r2)
returns TRUE, if r1 and r2 represents the monomials in the same way FALSE, otherwise this is an analo...
Definition: ring.cc:1677
static unsigned long pDivisibleBy_ShortFalse
Definition: pDebug.cc:363
int i
Definition: cfEzgcd.cc:123
static FORCE_INLINE BOOLEAN n_IsZero(number n, const coeffs r)
TRUE iff &#39;n&#39; represents the zero element.
Definition: coeffs.h:468
static BOOLEAN p_LmDivisibleBy(poly a, poly b, const ring r)
Definition: p_polys.h:1768
#define _pPolyAssume(cond, p, r)
Definition: monomials.h:121
#define rRing_has_Comp(r)
Definition: monomials.h:274
unsigned long p_GetShortExpVector(const poly p, const ring r)
Definition: p_polys.cc:4635
static unsigned long p_SetExp(poly p, const unsigned long e, const unsigned long iBitmask, const int VarOffset)
set a single variable exponent : VarOffset encodes the position in p->exp
Definition: p_polys.h:483
BOOLEAN p_CheckRing(ring r)
Definition: pDebug.cc:127
#define NULL
Definition: omList.c:10
BOOLEAN p_CheckPolyRing(poly p, ring r)
Definition: pDebug.cc:111
#define omIsBinPageAddr(addr)
Definition: omBinPage.h:68
#define omSizeWOfBin(bin_ptr)
#define pPolyAssumeReturnMsg(cond, msg)
Definition: monomials.h:145
#define pNext(p)
Definition: monomials.h:43
void pPrintDivisbleByStat()
Definition: pDebug.cc:412
int dReportError(const char *fmt,...)
Definition: dError.cc:45
END_NAMESPACE const void * p2
Definition: syzextra.cc:202
void p_wrp(poly p, ring lmRing, ring tailRing)
Definition: polys0.cc:237
BOOLEAN _p_Test(poly p, ring r, int level)
Definition: pDebug.cc:211
static BOOLEAN p_ExpVectorEqual(poly p1, poly p2, const ring r1, const ring r2)
Definition: p_polys.cc:4381
polyrec * poly
Definition: hilb.h:10
int BOOLEAN
Definition: auxiliary.h:85
static poly p_Init(const ring r, omBin bin)
Definition: p_polys.h:1243
const poly b
Definition: syzextra.cc:213
#define _pPolyAssumeReturnMsg(cond, msg, p, r)
Definition: monomials.h:132
BOOLEAN pDebugLmShortDivisibleBy(poly p1, unsigned long sev_1, ring r_1, poly p2, unsigned long not_sev_2, ring r_2)
Definition: pDebug.cc:365
void dErrorBreak()
Definition: dError.cc:141
BOOLEAN p_CheckIsFromRing(poly p, ring r)
Definition: pDebug.cc:101
BOOLEAN _pp_Test(poly p, ring lmRing, ring tailRing, int level)
Definition: pDebug.cc:332