source: git/kernel/polys.h @ cc94f7e

fieker-DuValspielwiese
Last change on this file since cc94f7e was 459ec94, checked in by Adi Popescu <adi_popescum@…>, 8 years ago
add: sba gcd-pair replacement while reduction
  • Property mode set to 100644
File size: 15.5 KB
Line 
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>
16#include <polys/monomials/p_polys.h>
17
18extern ring currRing;
19void 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)
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
70static inline void pLmFree(poly p)    {p_LmFree(p, currRing);}
71/// like pLmFree, but advances p
72static 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/***************************************************************
163 *
164 * Copying/Deleteion of polys: args may be NULL
165 *
166 ***************************************************************/
167/// return a copy of the poly
168#define pCopy(p) p_Copy(p, currRing)
169#define pDelete(p_ptr)  p_Delete(p_ptr, currRing)
170
171/***************************************************************
172 *
173 * Copying/Deletion of polys: args may be NULL
174 *  - p/q as arg mean a poly
175 *  - m a monomial
176 *  - n a number
177 *  - pp (resp. qq, mm, nn) means arg is constant
178 *  - p (resp, q, m, n)     means arg is destroyed
179 *
180 ***************************************************************/
181#define pNeg(p)                     p_Neg(p, currRing)
182#define ppMult_nn(p, n)             pp_Mult_nn(p, n, currRing)
183#define pMult_nn(p, n)              p_Mult_nn(p, n, currRing)
184#define ppMult_mm(p, m)             pp_Mult_mm(p, m, currRing)
185#define pMult_mm(p, m)              p_Mult_mm(p, m, currRing)
186#define pAdd(p, q)                  p_Add_q(p, q, currRing)
187#define pPower(p, q)                p_Power(p, q, currRing)
188#define pMinus_mm_Mult_qq(p, m, q)  p_Minus_mm_Mult_qq(p, m, q, currRing)
189#define pPlus_mm_Mult_qq(p, m, q)   p_Plus_mm_Mult_qq(p, m, q, currRing)
190#define pMult(p, q)                 p_Mult_q(p, q, currRing)
191#define ppMult_qq(p, q)             pp_Mult_qq(p, q, currRing)
192// p*Coeff(m) for such monomials pm of p, for which m is divisble by pm
193#define ppMult_Coeff_mm_DivSelect(p, m)   pp_Mult_Coeff_mm_DivSelect(p, m, currRing)
194/*************************************************************************
195 *
196 * Sort routines
197 *
198 *************************************************************************/
199/// sorts p, assumes all monomials in p are different
200#define pSortMerger(p)          p_SortMerge(p, currRing)
201#define pSort(p)                p_SortMerge(p, currRing)
202
203/// sorts p, p may have equal monomials
204#define pSortAdd(p)             p_SortAdd(p, currRing)
205
206
207/// Assume: If considerd only as poly in any component of p
208/// (say, monomials of other components of p are set to 0),
209/// then p is already sorted correctly
210#define pSortCompCorrect(p) pSort(p)
211
212/***************************************************************
213 *
214 * Predicates on polys/Lm's
215 *
216 ***************************************************************/
217/// return true if all p is eihter NULL, or if all exponents
218/// of p are 0 and Comp of p is zero
219#define   pIsConstantComp(p)        p_IsConstantComp(p, currRing)
220/// like above, except that Comp might be != 0
221#define   pIsConstant(p)            p_IsConstant(p,currRing)
222/// return true if the Lm is a constant <>0
223#define   pIsUnit(p)            p_IsUnit(p,currRing)
224/// like above, except that p must be != NULL
225#define   pLmIsConstantComp(p)      p_LmIsConstantComp(p, currRing)
226#define   pLmIsConstant(p)          p_LmIsConstant(p,currRing)
227
228/// return TRUE if all monomials of p are constant
229#define   pIsConstantPoly(p)        p_IsConstantPoly(p, currRing)
230
231#define   pIsPurePower(p)   p_IsPurePower(p, currRing)
232#define   pIsUnivariate(p)  p_IsUnivariate(p, currRing)
233#define   pIsVector(p)      (pGetComp(p)>0)
234#define   pGetVariables(p,e)  p_GetVariables(p, e, currRing)
235
236/***************************************************************
237 *
238 * Old stuff
239 *
240 ***************************************************************/
241
242typedef poly*   polyset;
243
244/*-------------predicate on polys ----------------------*/
245#define  pHasNotCF(p1,p2)   p_HasNotCF(p1,p2,currRing)
246                                /*has no common factor ?*/
247#define  pSplit(p,r)        p_Split(p,r)
248                                /*p => IN(p), r => REST(p) */
249
250
251
252/*-----------the ordering of monomials:-------------*/
253#define pSetm(p)    p_Setm(p, currRing)
254/// TODO:
255#define pSetmComp(p)   p_Setm(p, currRing)
256
257/***************************************************************
258 *
259 * Degree stuff -- see p_polys.cc for explainations
260 *
261 ***************************************************************/
262inline int pWeight(int i, const ring R = currRing){ return p_Weight(i, R); }
263
264
265static inline long pTotaldegree(poly p) { return p_Totaldegree(p,currRing); }
266#define pWTotaldegree(p) p_WTotaldegree(p,currRing)
267#define pWDegree(p) p_WDegree(p,currRing)
268
269/*-------------operations on polynomials:------------*/
270#define   pSub(a,b) p_Sub(a,b,currRing)
271
272#define pmInit(a,b) p_mInit(a,b,currRing)
273
274/* ----------------- define to enable new p_procs -----*/
275
276#define pDivide(a,b) p_Divide(a,b,currRing)
277#define pDivideM(a,b) p_DivideM(a,b,currRing)
278#define pLcm(a,b,m) p_Lcm(a,b,m,currRing)
279#define pDiff(a,b)  p_Diff(a,b,currRing)
280#define pDiffOp(a,b,m) p_DiffOp(a,b,m,currRing)
281
282#define   pMaxComp(p)   p_MaxComp(p, currRing)
283#define   pMinComp(p)   p_MinComp(p, currRing)
284
285#define   pOneComp(p)       p_OneComp(p, currRing)
286#define   pSetCompP(a,i)    p_SetCompP(a, i, currRing)
287
288// let's inline those, so that we can call them from the debugger
289inline char*   pString(poly p)    {return p_String(p, currRing, currRing);}
290inline void    pString0(poly p)   {p_String0(p, currRing, currRing);}
291inline void    pWrite(poly p)     {p_Write(p, currRing, currRing);}
292inline void    pWrite0(poly p)    {p_Write0(p, currRing, currRing);}
293inline void    wrp(poly p)        {p_wrp(p, currRing, currRing);}
294
295#define   pISet(i) p_ISet(i,currRing)
296#define   pNSet(n) p_NSet(n,currRing)
297
298#define   pOne()   p_One(currRing)
299
300#define   pNormalize(p) p_Normalize(p,currRing)
301#define   pSize(p)      p_Size(p,currRing)
302
303
304/// homogenizes p by multiplying certain powers of the varnum-th variable
305#define  pHomogen(p,varnum) p_Homogen(p,varnum,currRing)
306
307BOOLEAN   pIsHomogeneous (poly p);
308// // replaces the maximal powers of the leading monomial of p2 in p1 by
309// // the same powers of n, utility for dehomogenization
310// #define   pDehomogen(p1,p2,n) p_Dehomgen(p1,p2,n,currRing)
311// #define   pIsHomogen(p)       p_IsHomggen(p,currRing)
312#define   pIsHomogen(p)       p_IsHomogen(p,currRing)
313
314/*BOOLEAN   pVectorHasUnitM(poly p, int * k);*/
315#define   pVectorHasUnitB(p,k) p_VectorHasUnitB(p,k,currRing)
316#define   pVectorHasUnit(p,k,l) p_VectorHasUnit(p,k,l,currRing)
317#define   pTakeOutComp1(p,k)    p_TakeOutComp1(p,k,currRing)
318
319/// Splits *p into two polys: *q which consists of all monoms with
320/// component == comp and *p of all other monoms *lq == pLength(*q)
321/// On return all components pf *q == 0
322inline void pTakeOutComp(poly *p, long comp, poly *q, int *lq, const ring R = currRing)
323{
324  return p_TakeOutComp(p, comp, q, lq, R);
325}
326
327
328/// This is something weird -- Don't use it, unless you know what you are doing
329inline poly      pTakeOutComp(poly * p, int k, const ring R = currRing)
330{
331  return p_TakeOutComp(p, k, R);
332}
333
334/* old spielwiese
335#define   pTakeOutComp(p,k,q,lq)    p_TakeOutComp(p,k,q,lq,currRing)
336
337// Similar to pTakeOutComp, except that only those components are
338// taken out whose Order == order
339// ASSUME: monomial ordering is Order compatible, i.e., if m1, m2 Monoms then
340//         m1 >= m2 ==> pGetOrder(m1) >= pGetOrder(m2)
341#define   pDecrOrdTakeOutComp(p,c,o,q,lq) p_DecrOrdTakeOutComp(p,c,o,q,lq,currRing)
342*/
343void      pSetPolyComp(poly p, int comp);
344#define   pDeleteComp(p,k) p_DeleteComp(p,k,currRing)
345
346inline void pNorm(poly p, const ring R = currRing){ p_Norm(p, R); }
347
348
349#define   pSubst(p,n,e) p_Subst(p,n,e,currRing)
350#define   ppJet(p,m) pp_Jet(p,m,currRing)
351#define   pJet(p,m)  p_Jet(p,m,currRing)
352#define   ppJetW(p,m,iv) pp_JetW(p,m,iv,currRing)
353#define   pJetW(p,m,iv) p_JetW(p,m,iv,currRing)
354#define   pMinDeg(p,w) p_MinDeg(p,w,currRing)
355#define   pSeries(n,p,u,w) p_Series(n,p,u,w,currRing)
356#define   pInvers(n,p,w) p_Invers(n,p,w,currRing)
357// maximum weigthed degree of all monomials of p, w is indexed from
358// 1..pVariables
359
360/// Deprecated: only for compatibility with older code!
361#define    pDegW(p,w) p_DegW(p,w,currRing)
362
363/*-----------type conversions ----------------------------*/
364// void  pVec2Polys(poly v, polyset *p, int *len);
365#define   pVar(m) p_Var(m,currRing)
366
367/*-----------specials for spoly-computations--------------*/
368
369/// Returns TRUE if
370///      * LM(p) | LM(lcm)
371///      * LC(p) | LC(lcm) only if ring
372///      * Exists i, j:
373///          * LE(p, i)  != LE(lcm, i)
374///          * LE(p1, i) != LE(lcm, i)   ==> LCM(p1, p) != lcm
375///          * LE(p, j)  != LE(lcm, j)
376///          * LE(p2, j) != LE(lcm, j)   ==> LCM(p2, p) != lcm
377BOOLEAN pCompareChain (poly p, poly p1, poly p2, poly lcm, const ring R = currRing);
378
379#ifdef HAVE_RATGRING
380BOOLEAN pCompareChainPart (poly p, poly p1, poly p2, poly lcm, const ring R = currRing);
381#endif
382
383
384#define  pEqualPolys(p1,p2) p_EqualPolys(p1,p2,currRing)
385
386
387
388/// returns the length of a polynomial (numbers of monomials)
389/// respect syzComp
390static inline poly pLast(poly a, int &length) { return p_Last (a, length, currRing); }
391static inline poly pLast(poly a) { int l; return pLast(a, l); }
392
393/***************************************************************
394 *
395 * PDEBUG stuff
396 *
397 ***************************************************************/
398#ifdef PDEBUG
399#define pTest(p)        _p_Test(p, currRing, PDEBUG)
400#define pLmTest(p)      _p_LmTest(p, currRing, PDEBUG)
401
402#else // ! PDEBUG
403
404#define pTest(p)        do {} while (0)
405#define pLmTest(p)      do {} while (0)
406#endif
407
408#endif // POLYS_H
Note: See TracBrowser for help on using the repository browser.