polys.h
Go to the documentation of this file.
1 /*! \file kernel/polys.h Compatiblity layer for legacy polynomial operations (over @ref currRing)
2 
3  Macro defines for legacy polynomial operations used in @ref kernel_page and @ref singular_page.
4  They take no ring argument since they work with @ref currRing by default.
5  Notice that they have different prefix: `p` instead of `p_`.
6 
7  See also related global ring variable and the correct ring changeing routine:
8  - \ref currRing
9  - \ref rChangeCurrRing
10 */
11 
12 #ifndef POLYS_H
13 #define POLYS_H
14 
15 #include "polys/monomials/ring.h"
17 
18 extern ring currRing;
19 void rChangeCurrRing(ring r);
20 
21 #include "coeffs/numbers.h"
22 
23 /***************************************************************
24  *
25  * Primitives for accessing and setting fields of a poly
26  * poly must be != NULL
27  *
28  ***************************************************************/
29 
30 /// deletes old coeff before setting the new one
31 #define pSetCoeff(p,n) p_SetCoeff(p,n,currRing)
32 
33 /// Order
34 #define pGetOrder(p) p_GetOrder(p, currRing)
35 
36 /// Component
37 #define pGetComp(p) (int)__p_GetComp(p, currRing)
38 #define pSetComp(p,v) p_SetComp(p,v, currRing)
39 
40 /// Exponent
41 #define pGetExp(p,i) p_GetExp(p, i, currRing)
42 #define pSetExp(p,i,v) p_SetExp(p, i, v, currRing)
43 #define pIncrExp(p,i) p_IncrExp(p,i, currRing)
44 #define pDecrExp(p,i) p_DecrExp(p,i, currRing)
45 #define pAddExp(p,i,v) p_AddExp(p,i,v, currRing)
46 #define pSubExp(p,i,v) p_SubExp(p,i,v, currRing)
47 #define pMultExp(p,i,v) p_MultExp(p,i,v, currRing)
48 #define pGetExpSum(p1, p2, i) p_GetExpSum(p1, p2, i, currRing)
49 #define pGetExpDiff(p1, p2, i) p_GetExpDiff(p1, p2, i, currRing)
50 
51 
52 /***************************************************************
53  *
54  * Allocation/Initalization/Deletion
55  * except for pHead, all polys must be != NULL
56  *
57  ***************************************************************/
58 /// allocates the space for a new monomial -- no initialization !!!
59 #define pNew() p_New(currRing)
60 /// allocates a new monomial and initializes everything to 0
61 #define pInit() p_Init(currRing,currRing->PolyBin)
62 /// like pInit, except that expvector is initialized to that of p,
63 /// p must be != NULL
64 #define pLmInit(p) p_LmInit(p, currRing)
65 /// returns newly allocated copy of Lm(p), coef is copied, next=NULL,
66 /// p might be NULL
67 #define pHead(p) p_Head(p, currRing)
68 /// frees the space of the monomial m, assumes m != NULL
69 /// coef is not freed, m is not advanced
70 static inline void pLmFree(poly p) {p_LmFree(p, currRing);}
71 /// like pLmFree, but advances p
72 static inline void pLmFree(poly *p) {p_LmFree(p, currRing);}
73 /// assumes p != NULL, deletes p, returns pNext(p)
74 #define pLmFreeAndNext(p) p_LmFreeAndNext(p, currRing)
75 /// assume p != NULL, deletes Lm(p)->coef and Lm(p)
76 #define pLmDelete(p) p_LmDelete(p, currRing)
77 /// like pLmDelete, returns pNext(p)
78 #define pLmDeleteAndNext(p) p_LmDeleteAndNext(p, currRing)
79 
80 /***************************************************************
81  *
82  * Operation on ExpVectors: assumes polys != NULL
83  *
84  ***************************************************************/
85 
86 #define pExpVectorCopy(d_p, s_p) p_ExpVectorCopy(d_p, s_p, currRing)
87 #define pExpVectorAdd(p1, p2) p_ExpVectorAdd(p1, p2, currRing)
88 #define pExpVectorSub(p1, p2) p_ExpVectorSub(p1, p2, currRing)
89 #define pExpVectorAddSub(p1, p2, p3) p_ExpVectorAddSub(p1, p2, p3, currRing)
90 #define pExpVectorSum(pr, p1, p2) p_ExpVectorSum(pr, p1, p2, currRing)
91 #define pExpVectorDiff(pr, p1, p2) p_ExpVectorDiff(pr, p1, p2, currRing)
92 
93 /// Gets a copy of (resp. set) the exponent vector, where e is assumed
94 /// to point to (r->N +1)*sizeof(long) memory. Exponents are
95 /// filled in as follows: comp, e_1, .., e_n
96 #define pGetExpV(p, e) p_GetExpV(p, e, currRing)
97 #define pSetExpV(p, e) p_SetExpV(p, e, currRing)
98 
99 /***************************************************************
100  *
101  * Comparisons: they are all done without regarding coeffs
102  *
103  ***************************************************************/
104 /// returns 0|1|-1 if p=q|p>q|p<q w.r.t monomial ordering
105 #define pLmCmp(p,q) p_LmCmp(p,q,currRing)
106 /// executes axtionE|actionG|actionS if p=q|p>q|p<q w.r.t monomial ordering
107 /// action should be a "goto ..."
108 #define pLmCmpAction(p,q, actionE, actionG, actionS) \
109  _p_LmCmpAction(p,q,currRing, actionE, actionG,actionS)
110 
111 #define pLmEqual(p1, p2) p_ExpVectorEqual(p1, p2, currRing)
112 
113 /// pCmp: args may be NULL
114 /// returns: (p2==NULL ? 1 : (p1 == NULL ? -1 : p_LmCmp(p1, p2)))
115 #define pCmp(p1, p2) p_Cmp(p1, p2, currRing)
116 
117 /***************************************************************
118  *
119  * Comparisons: these are all done regarding coeffs
120  *
121  ***************************************************************/
122 
123 #define pLtCmp(p,q) p_LtCmp(p,q,currRing)
124 #define pLtCmpNoAbs(p,q) p_LtCmpNoAbs(p,q,currRing)
125 #define pLtCmpOrdSgnDiffM(p,q) p_LtCmpOrdSgnDiffM(p,q,currRing)
126 #define pLtCmpOrdSgnDiffP(p,q) p_LtCmpOrdSgnDiffP(p,q,currRing)
127 #define pLtCmpOrdSgnEqM(p,q) p_LtCmpOrdSgnEqM(p,q,currRing)
128 #define pLtCmpOrdSgnEqP(p,q) p_LtCmpOrdSgnEqP(p,q,currRing)
129 
130 /***************************************************************
131  *
132  * Divisiblity tests, args must be != NULL, except for
133  * pDivisbleBy
134  *
135  ***************************************************************/
136 /// returns TRUE, if leading monom of a divides leading monom of b
137 /// i.e., if there exists a expvector c > 0, s.t. b = a + c;
138 #define pDivisibleBy(a, b) p_DivisibleBy(a,b,currRing)
139 /// like pDivisibleBy, except that it is assumed that a!=NULL, b!=NULL
140 #define pLmDivisibleBy(a,b) p_LmDivisibleBy(a,b,currRing)
141 /// like pLmDivisibleBy, does not check components
142 #define pLmDivisibleByNoComp(a, b) p_LmDivisibleByNoComp(a,b,currRing)
143 /// Divisibility tests based on Short Exponent vectors
144 /// sev_a == pGetShortExpVector(a)
145 /// not_sev_b == ~ pGetShortExpVector(b)
146 #define pLmShortDivisibleBy(a, sev_a, b, not_sev_b) \
147  p_LmShortDivisibleBy(a, sev_a, b, not_sev_b, currRing)
148 #define pLmRingShortDivisibleBy(a, sev_a, b, not_sev_b) \
149  p_LmRingShortDivisibleBy(a, sev_a, b, not_sev_b, currRing)
150 /// returns the "Short Exponent Vector" -- used to speed up divisibility
151 /// tests (see polys-impl.cc )
152 #define pGetShortExpVector(a) p_GetShortExpVector(a, currRing)
153 
154 #ifdef HAVE_RINGS
155 /// divisibility check over ground ring (which may contain zero divisors);
156 /// TRUE iff LT(f) divides LT(g), i.e., LT(f)*c*m = LT(g), for some
157 /// coefficient c and some monomial m;
158 /// does not take components into account */
159 #define pDivisibleByRingCase(f,g) p_DivisibleByRingCase(f,g,currRing)
160 #endif
161 
162 /// polynomial division, ignoring the rest
163 /// via singclap_pdiive resp. idLift
164 /// destroyes a,b
165 poly p_Divide(poly a, poly b, const ring r);
166 /***************************************************************
167  *
168  * Copying/Deleteion of polys: args may be NULL
169  *
170  ***************************************************************/
171 /// return a copy of the poly
172 #define pCopy(p) p_Copy(p, currRing)
173 #define pDelete(p_ptr) p_Delete(p_ptr, currRing)
174 
175 /***************************************************************
176  *
177  * Copying/Deletion of polys: args may be NULL
178  * - p/q as arg mean a poly
179  * - m a monomial
180  * - n a number
181  * - pp (resp. qq, mm, nn) means arg is constant
182  * - p (resp, q, m, n) means arg is destroyed
183  *
184  ***************************************************************/
185 #define pNeg(p) p_Neg(p, currRing)
186 #define ppMult_nn(p, n) pp_Mult_nn(p, n, currRing)
187 #define pMult_nn(p, n) p_Mult_nn(p, n, currRing)
188 #define ppMult_mm(p, m) pp_Mult_mm(p, m, currRing)
189 #define pMult_mm(p, m) p_Mult_mm(p, m, currRing)
190 #define pAdd(p, q) p_Add_q(p, q, currRing)
191 #define pPower(p, q) p_Power(p, q, currRing)
192 #define pMinus_mm_Mult_qq(p, m, q) p_Minus_mm_Mult_qq(p, m, q, currRing)
193 #define pPlus_mm_Mult_qq(p, m, q) p_Plus_mm_Mult_qq(p, m, q, currRing)
194 #define pMult(p, q) p_Mult_q(p, q, currRing)
195 #define ppMult_qq(p, q) pp_Mult_qq(p, q, currRing)
196 // p*Coeff(m) for such monomials pm of p, for which m is divisble by pm
197 #define ppMult_Coeff_mm_DivSelect(p, m) pp_Mult_Coeff_mm_DivSelect(p, m, currRing)
198 /*************************************************************************
199  *
200  * Sort routines
201  *
202  *************************************************************************/
203 /// sorts p, assumes all monomials in p are different
204 #define pSortMerger(p) p_SortMerge(p, currRing)
205 #define pSort(p) p_SortMerge(p, currRing)
206 
207 /// sorts p, p may have equal monomials
208 #define pSortAdd(p) p_SortAdd(p, currRing)
209 
210 
211 /// Assume: If considerd only as poly in any component of p
212 /// (say, monomials of other components of p are set to 0),
213 /// then p is already sorted correctly
214 #define pSortCompCorrect(p) pSort(p)
215 
216 /***************************************************************
217  *
218  * Predicates on polys/Lm's
219  *
220  ***************************************************************/
221 /// return true if all p is eihter NULL, or if all exponents
222 /// of p are 0 and Comp of p is zero
223 #define pIsConstantComp(p) p_IsConstantComp(p, currRing)
224 /// like above, except that Comp might be != 0
225 #define pIsConstant(p) p_IsConstant(p,currRing)
226 /// return true if the Lm is a constant <>0
227 #define pIsUnit(p) p_IsUnit(p,currRing)
228 /// like above, except that p must be != NULL
229 #define pLmIsConstantComp(p) p_LmIsConstantComp(p, currRing)
230 #define pLmIsConstant(p) p_LmIsConstant(p,currRing)
231 
232 /// return TRUE if all monomials of p are constant
233 #define pIsConstantPoly(p) p_IsConstantPoly(p, currRing)
234 
235 #define pIsPurePower(p) p_IsPurePower(p, currRing)
236 #define pIsUnivariate(p) p_IsUnivariate(p, currRing)
237 #define pIsVector(p) (pGetComp(p)>0)
238 #define pGetVariables(p,e) p_GetVariables(p, e, currRing)
239 
240 /***************************************************************
241  *
242  * Old stuff
243  *
244  ***************************************************************/
245 
246 typedef poly* polyset;
247 
248 /*-------------predicate on polys ----------------------*/
249 #define pHasNotCF(p1,p2) p_HasNotCF(p1,p2,currRing)
250  /*has no common factor ?*/
251 #define pSplit(p,r) p_Split(p,r)
252  /*p => IN(p), r => REST(p) */
253 
254 
255 
256 /*-----------the ordering of monomials:-------------*/
257 #define pSetm(p) p_Setm(p, currRing)
258 /// TODO:
259 #define pSetmComp(p) p_Setm(p, currRing)
260 
261 /***************************************************************
262  *
263  * Degree stuff -- see p_polys.cc for explainations
264  *
265  ***************************************************************/
266 #define pWeight(i) p_Weight(i,currRing)
267 
268 static inline long pTotaldegree(poly p) { return p_Totaldegree(p,currRing); }
269 #define pWTotaldegree(p) p_WTotaldegree(p,currRing)
270 #define pWDegree(p) p_WDegree(p,currRing)
271 
272 /*-------------operations on polynomials:------------*/
273 #define pSub(a,b) p_Sub(a,b,currRing)
274 
275 #define pmInit(a,b) p_mInit(a,b,currRing)
276 
277 /* ----------------- define to enable new p_procs -----*/
278 
279 #define pMDivide(a,b) p_MDivide(a,b,currRing)
280 #define pDivideM(a,b) p_DivideM(a,b,currRing)
281 #define pLcm(a,b,m) p_Lcm(a,b,m,currRing)
282 #define pDiff(a,b) p_Diff(a,b,currRing)
283 #define pDiffOp(a,b,m) p_DiffOp(a,b,m,currRing)
284 
285 #define pMaxComp(p) p_MaxComp(p, currRing)
286 #define pMinComp(p) p_MinComp(p, currRing)
287 
288 #define pOneComp(p) p_OneComp(p, currRing)
289 #define pSetCompP(a,i) p_SetCompP(a, i, currRing)
290 
291 // let's inline those, so that we can call them from the debugger
292 inline char* pString(poly p) {return p_String(p, currRing, currRing);}
293 inline void pString0(poly p) {p_String0(p, currRing, currRing);}
294 inline void pWrite(poly p) {p_Write(p, currRing, currRing);}
295 inline void pWrite0(poly p) {p_Write0(p, currRing, currRing);}
296 inline void wrp(poly p) {p_wrp(p, currRing, currRing);}
297 
298 #define pISet(i) p_ISet(i,currRing)
299 #define pNSet(n) p_NSet(n,currRing)
300 
301 #define pOne() p_One(currRing)
302 
303 #define pNormalize(p) p_Normalize(p,currRing)
304 #define pSize(p) p_Size(p,currRing)
305 
306 
307 /// homogenizes p by multiplying certain powers of the varnum-th variable
308 #define pHomogen(p,varnum) p_Homogen(p,varnum,currRing)
309 
310 BOOLEAN pIsHomogeneous (poly p);
311 // // replaces the maximal powers of the leading monomial of p2 in p1 by
312 // // the same powers of n, utility for dehomogenization
313 // #define pDehomogen(p1,p2,n) p_Dehomgen(p1,p2,n,currRing)
314 // #define pIsHomogen(p) p_IsHomggen(p,currRing)
315 #define pIsHomogen(p) p_IsHomogen(p,currRing)
316 
317 /*BOOLEAN pVectorHasUnitM(poly p, int * k);*/
318 #define pVectorHasUnitB(p,k) p_VectorHasUnitB(p,k,currRing)
319 #define pVectorHasUnit(p,k,l) p_VectorHasUnit(p,k,l,currRing)
320 #define pTakeOutComp1(p,k) p_TakeOutComp1(p,k,currRing)
321 
322 /// Splits *p into two polys: *q which consists of all monoms with
323 /// component == comp and *p of all other monoms *lq == pLength(*q)
324 /// On return all components pf *q == 0
325 inline void pTakeOutComp(poly *p, long comp, poly *q, int *lq, const ring R = currRing)
326 {
327  return p_TakeOutComp(p, comp, q, lq, R);
328 }
329 
330 
331 /// This is something weird -- Don't use it, unless you know what you are doing
332 inline poly pTakeOutComp(poly * p, int k, const ring R = currRing)
333 {
334  return p_TakeOutComp(p, k, R);
335 }
336 
337 /* old spielwiese
338 #define pTakeOutComp(p,k,q,lq) p_TakeOutComp(p,k,q,lq,currRing)
339 
340 // Similar to pTakeOutComp, except that only those components are
341 // taken out whose Order == order
342 // ASSUME: monomial ordering is Order compatible, i.e., if m1, m2 Monoms then
343 // m1 >= m2 ==> pGetOrder(m1) >= pGetOrder(m2)
344 #define pDecrOrdTakeOutComp(p,c,o,q,lq) p_DecrOrdTakeOutComp(p,c,o,q,lq,currRing)
345 */
346 void pSetPolyComp(poly p, int comp);
347 #define pDeleteComp(p,k) p_DeleteComp(p,k,currRing)
348 
349 inline void pNorm(poly p, const ring R = currRing){ p_Norm(p, R); }
350 
351 
352 #define pSubst(p,n,e) p_Subst(p,n,e,currRing)
353 #define ppJet(p,m) pp_Jet(p,m,currRing)
354 #define pJet(p,m) p_Jet(p,m,currRing)
355 #define ppJetW(p,m,iv) pp_JetW(p,m,iv,currRing)
356 #define pJetW(p,m,iv) p_JetW(p,m,iv,currRing)
357 #define pMinDeg(p,w) p_MinDeg(p,w,currRing)
358 #define pSeries(n,p,u,w) p_Series(n,p,u,w,currRing)
359 // maximum weigthed degree of all monomials of p, w is indexed from
360 // 1..pVariables
361 
362 /// Deprecated: only for compatibility with older code!
363 #define pDegW(p,w) p_DegW(p,w,currRing)
364 
365 /*-----------type conversions ----------------------------*/
366 // void pVec2Polys(poly v, polyset *p, int *len);
367 #define pVar(m) p_Var(m,currRing)
368 
369 /*-----------specials for spoly-computations--------------*/
370 
371 /// Returns TRUE if
372 /// * LM(p) | LM(lcm)
373 /// * LC(p) | LC(lcm) only if ring
374 /// * Exists i, j:
375 /// * LE(p, i) != LE(lcm, i)
376 /// * LE(p1, i) != LE(lcm, i) ==> LCM(p1, p) != lcm
377 /// * LE(p, j) != LE(lcm, j)
378 /// * LE(p2, j) != LE(lcm, j) ==> LCM(p2, p) != lcm
379 BOOLEAN pCompareChain (poly p, poly p1, poly p2, poly lcm, const ring R = currRing);
380 
381 #ifdef HAVE_RATGRING
382 BOOLEAN pCompareChainPart (poly p, poly p1, poly p2, poly lcm, const ring R = currRing);
383 #endif
384 
385 
386 #define pEqualPolys(p1,p2) p_EqualPolys(p1,p2,currRing)
387 
388 
389 
390 /// returns the length of a polynomial (numbers of monomials)
391 /// respect syzComp
392 static inline poly pLast(poly a, int &length) { return p_Last (a, length, currRing); }
393 static inline poly pLast(poly a) { int l; return pLast(a, l); }
394 
395 /***************************************************************
396  *
397  * PDEBUG stuff
398  *
399  ***************************************************************/
400 #ifdef PDEBUG
401 #define pTest(p) _p_Test(p, currRing, PDEBUG)
402 #define pLmTest(p) _p_LmTest(p, currRing, PDEBUG)
403 
404 #else // ! PDEBUG
405 
406 #define pTest(p) do {} while (0)
407 #define pLmTest(p) do {} while (0)
408 #endif
409 
410 #endif // POLYS_H
static poly pLast(poly a, int &length)
returns the length of a polynomial (numbers of monomials) respect syzComp
Definition: polys.h:392
char * pString(poly p)
Definition: polys.h:292
int lcm(unsigned long *l, unsigned long *a, unsigned long *b, unsigned long p, int dega, int degb)
Definition: minpoly.cc:709
char * p_String(poly p, ring lmRing, ring tailRing)
Definition: polys0.cc:184
void p_TakeOutComp(poly *p, long comp, poly *q, int *lq, const ring r)
Definition: p_polys.cc:3446
BOOLEAN pIsHomogeneous(poly p)
static long p_Totaldegree(poly p, const ring r)
Definition: p_polys.h:1453
void pWrite(poly p)
Definition: polys.h:294
int k
Definition: cfEzgcd.cc:92
void p_Norm(poly p1, const ring r)
Definition: p_polys.cc:3656
void pWrite0(poly p)
Definition: polys.h:295
static void p_LmFree(poly p, ring)
Definition: p_polys.h:683
poly p_Divide(poly a, poly b, const ring r)
polynomial division, ignoring the rest via singclap_pdiive resp. idLift destroyes a...
Definition: polys.cc:31
int comp(const CanonicalForm &A, const CanonicalForm &B)
compare polynomials
CanonicalForm b
Definition: cfModGcd.cc:4044
void rChangeCurrRing(ring r)
Definition: polys.cc:15
ring currRing
Widely used global variable which specifies the current polynomial ring for Singular interpreter and ...
Definition: polys.cc:13
static long pTotaldegree(poly p)
Definition: polys.h:268
BOOLEAN pCompareChain(poly p, poly p1, poly p2, poly lcm, const ring R=currRing)
Returns TRUE if.
Definition: kpolys.cc:20
poly * polyset
Definition: polys.h:246
void p_Write0(poly p, ring lmRing, ring tailRing)
Definition: polys0.cc:194
void pString0(poly p)
Definition: polys.h:293
void pTakeOutComp(poly *p, long comp, poly *q, int *lq, const ring R=currRing)
Splits *p into two polys: *q which consists of all monoms with component == comp and *p of all other ...
Definition: polys.h:325
poly p_Last(const poly p, int &l, const ring r)
Definition: p_polys.cc:4505
#define R
Definition: sirandom.c:26
void pNorm(poly p, const ring R=currRing)
Definition: polys.h:349
static BOOLEAN length(leftv result, leftv arg)
Definition: interval.cc:267
static void pLmFree(poly p)
frees the space of the monomial m, assumes m != NULL coef is not freed, m is not advanced ...
Definition: polys.h:70
Definition: lq.h:39
void p_wrp(poly p, ring lmRing, ring tailRing)
Definition: polys0.cc:235
void p_String0(poly p, ring lmRing, ring tailRing)
print p according to ShortOut in lmRing & tailRing
Definition: polys0.cc:134
void p_Write(poly p, ring lmRing, ring tailRing)
Definition: polys0.cc:204
int p
Definition: cfModGcd.cc:4019
void wrp(poly p)
Definition: polys.h:296
BOOLEAN pCompareChainPart(poly p, poly p1, poly p2, poly lcm, const ring R=currRing)
Definition: kpolys.cc:74
int BOOLEAN
Definition: auxiliary.h:85
void pSetPolyComp(poly p, int comp)
int l
Definition: cfEzgcd.cc:93