source: git/kernel/polys.h @ 9f34ee

Last change on this file since 9f34ee was 9f34ee, checked in by Hans Schoenemann <hannes@…>, 14 years ago
code cleanup: pSimpleContent git-svn-id: file:///usr/local/Singular/svn/trunk@13705 2c84dea3-7e68-4137-9b89-c4e89433aadc
  • Property mode set to 100644
File size: 16.4 KB
1#ifndef POLYS_H
2#define POLYS_H
4*  Computer Algebra System SINGULAR     *
6/* $Id$ */
8* ABSTRACT - all basic methods to manipulate polynomials of the
9             currRing
12#include <kernel/p_polys.h>
14 Some general remarks:
15 We divide poly operations into roughly 4 categories:
16 Level 2: operations on monomials/polynomials with constant time,
17          or operations which are just dispatchers to other
18          poly routines
19          - implemented in: pInline2.h
20          - debugging only if PDEBUG >= 2
21          - normally inlined, unless PDEBUG >= 2 || NO_INLINE2
22 Level 1: operations on monomials with time proportional to length
23          - implemented in: pInline1.h
24          - debugging only if PDEBUG >= 1
25          - normally inlined, unless PDEBUG >= 1 || NO_INLINE1
26 Level 0: short operations on polynomials with time proportional to
27          length of poly
28          - implemented in
29          - debugging if PDEBUG
30          - normally _not_ inlined: can be forced with
31            #define DO_PINLINE0
32            #include "pInline0.h"
33 Misc   : operations on polynomials which do not fit in any of the
34          above categories
35          - implemented in: polys*.cc
36          - never inlined
37          - debugging if PDEBUG >= 0
39 You can set PDEBUG on a per-file basis, before including "mod2.h" like
40   #define PDEBUG 2
41   #include "mod2.h"
42 However, PDEBUG will only be in effect, if !NDEBUG.
44 All p_* operations take as last argument a ring
45 and are ring independent. Their corresponding p* operations are usually
46 just macros to the respective p_*(..,currRing).
51 *
52 * Primitives for accessing and setting fields of a poly
53 * poly must be != NULL
54 *
55 ***************************************************************/
56// deletes old coeff before setting the new one
57#define pSetCoeff(p,n)      p_SetCoeff(p,n,currRing)
59// Order
60#define pGetOrder(p)        p_GetOrder(p, currRing)
62// Component
63#define pGetComp(p)         _p_GetComp(p, currRing)
64#define pSetComp(p,v)       p_SetComp(p,v, currRing)
65#define pAddComp(p,v)       p_AddComp(p,v,currRing)
66#define pSubComp(p,v)       p_SubComp(p,v,currRing)
68// Exponent
69#define pGetExp(p,i)        p_GetExp(p, i, currRing)
70#define pSetExp(p,i,v)      p_SetExp(p, i, v, currRing)
71#define pIncrExp(p,i)       p_IncrExp(p,i, currRing)
72#define pDecrExp(p,i)       p_DecrExp(p,i, currRing)
73#define pAddExp(p,i,v)      p_AddExp(p,i,v, currRing)
74#define pSubExp(p,i,v)      p_SubExp(p,i,v, currRing)
75#define pMultExp(p,i,v)     p_MultExp(p,i,v, currRing)
76#define pGetExpSum(p1, p2, i)    p_GetExpSum(p1, p2, i, currRing)
77#define pGetExpDiff(p1, p2, i)   p_GetExpDiff(p1, p2, i, currRing)
80 *
81 * Allocation/Initalization/Deletion
82 * except for pHead, all polys must be != NULL
83 *
84 ***************************************************************/
85// allocates the space for a new monomial -- no initialization !!!
86#define pNew()          p_New(currRing)
87// allocates a new monomial and initializes everything to 0
88#define pInit()         p_Init(currRing)
89// like pInit, except that expvector is initialized to that of p,
90// p must be != NULL
91#define pLmInit(p)  p_LmInit(p, currRing)
92// returns newly allocated copy of Lm(p), coef is copied, next=NULL,
93// p might be NULL
94#define pHead(p)        p_Head(p, currRing)
95// frees the space of the monomial m, assumes m != NULL
96// coef is not freed, m is not advanced
97static inline void pLmFree(poly p)    {p_LmFree(p, currRing);}
98// like pLmFree, but advances p
99static inline void pLmFree(poly *p)   {p_LmFree(p, currRing);}
100// assumes p != NULL, deletes p, returns pNext(p)
101#define pLmFreeAndNext(p) p_LmFreeAndNext(p, currRing)
102// assume p != NULL, deletes Lm(p)->coef and Lm(p)
103#define pLmDelete(p)    p_LmDelete(p, currRing)
104// like pLmDelete, returns pNext(p)
105#define pLmDeleteAndNext(p) p_LmDeleteAndNext(p, currRing)
106// used by
107extern poly pHeadProc(poly p);
110 *
111 * Operation on ExpVectors: assumes polys != NULL
112 *
113 ***************************************************************/
115#define pExpVectorCopy(d_p, s_p)    p_ExpVectorCopy(d_p, s_p, currRing)
116#define pExpVectorAdd(p1, p2)       p_ExpVectorAdd(p1, p2, currRing)
117#define pExpVectorSub(p1, p2)       p_ExpVectorSub(p1, p2, currRing)
118#define pExpVectorAddSub(p1, p2, p3)p_ExpVectorAddSub(p1, p2, p3, currRing)
119#define pExpVectorSum(pr, p1, p2)   p_ExpVectorSum(pr, p1, p2, currRing)
120#define pExpVectorDiff(pr, p1, p2)  p_ExpVectorDiff(pr, p1, p2, currRing)
121#define pExpVectorEqual(p1, p2)     p_ExpVectorEqual(p1, p2, currRing)
123// Gets a copy of (resp. set) the exponent vector, where e is assumed
124// to point to (r->N +1)*sizeof(long) memory. Exponents are
125// filled in as follows: comp, e_1, .., e_n
126#define pGetExpV(p, e)      p_GetExpV(p, e, currRing)
127#define pSetExpV(p, e)      p_SetExpV(p, e, currRing)
130 *
131 * Comparisons: they are all done without regarding coeffs
132 *
133 ***************************************************************/
134// returns 0|1|-1 if p=q|p>q|p<q w.r.t monomial ordering
135#define pLmCmp(p,q)         p_LmCmp(p,q,currRing)
136// executes axtionE|actionG|actionS if p=q|p>q|p<q w.r.t monomial ordering
137// action should be a "goto ..."
138#define pLmCmpAction(p,q, actionE, actionG, actionS)  \
139  _p_LmCmpAction(p,q,currRing, actionE, actionG,actionS)
141#define pLmEqual(p1, p2)     pExpVectorEqual(p1, p2)
143// pCmp: args may be NULL
144// returns: (p2==NULL ? 1 : (p1 == NULL ? -1 : p_LmCmp(p1, p2)))
145#define pCmp(p1, p2)    p_Cmp(p1, p2, currRing)
149 *
150 * Divisiblity tests, args must be != NULL, except for
151 * pDivisbleBy
152 *
153 ***************************************************************/
154// returns TRUE, if leading monom of a divides leading monom of b
155// i.e., if there exists a expvector c > 0, s.t. b = a + c;
156#define pDivisibleBy(a, b)  p_DivisibleBy(a,b,currRing)
157// like pDivisibleBy, except that it is assumed that a!=NULL, b!=NULL
158#define pLmDivisibleBy(a,b)  p_LmDivisibleBy(a,b,currRing)
159// like pLmDivisibleBy, does not check components
160#define pLmDivisibleByNoComp(a, b) p_LmDivisibleByNoComp(a,b,currRing)
161// Divisibility tests based on Short Exponent vectors
162// sev_a     == pGetShortExpVector(a)
163// not_sev_b == ~ pGetShortExpVector(b)
164#define pLmShortDivisibleBy(a, sev_a, b, not_sev_b) \
165  p_LmShortDivisibleBy(a, sev_a, b, not_sev_b, currRing)
166#define pLmRingShortDivisibleBy(a, sev_a, b, not_sev_b) \
167  p_LmRingShortDivisibleBy(a, sev_a, b, not_sev_b, currRing)
168// returns the "Short Exponent Vector" -- used to speed up divisibility
169// tests (see )
170#define pGetShortExpVector(a)   p_GetShortExpVector(a, currRing)
173 *
174 * Copying/Deleteion of polys: args may be NULL
175 *
176 ***************************************************************/
177// return a copy of the poly
178#define pCopy(p) p_Copy(p, currRing)
179#define pDelete(p_ptr)  p_Delete(p_ptr, currRing)
182 *
183 * Copying/Deletion of polys: args may be NULL
184 *  - p/q as arg mean a poly
185 *  - m a monomial
186 *  - n a number
187 *  - pp (resp. qq, mm, nn) means arg is constant
188 *  - p (resp, q, m, n)     means arg is destroyed
189 *
190 ***************************************************************/
191#define pNeg(p)                     p_Neg(p, currRing)
192#define ppMult_nn(p, n)             pp_Mult_nn(p, n, currRing)
193#define pMult_nn(p, n)              p_Mult_nn(p, n, currRing)
194#define ppMult_mm(p, m)             pp_Mult_mm(p, m, currRing)
195#define pMult_mm(p, m)              p_Mult_mm(p, m, currRing)
196#define pAdd(p, q)                  p_Add_q(p, q, currRing)
197#define pPower(p, q)                p_Power(p, q, currRing)
198#define pMinus_mm_Mult_qq(p, m, q)  p_Minus_mm_Mult_qq(p, m, q, currRing)
199#define pPlus_mm_Mult_qq(p, m, q)   p_Plus_mm_Mult_qq(p, m, q, currRing)
200#define pMult(p, q)                 p_Mult_q(p, q, currRing)
201#define ppMult_qq(p, q)             pp_Mult_qq(p, q, currRing)
202// p*Coeff(m) for such monomials pm of p, for which m is divisble by pm
203#define ppMult_Coeff_mm_DivSelect(p, m)   pp_Mult_Coeff_mm_DivSelect(p, m, currRing)
205 *
206 * Sort routines
207 *
208 *************************************************************************/
209// sorts p, assumes all monomials in p are different
210#define pSortMerger(p)          pSort(p)
211#define pSort(p)                p_SortMerge(p, currRing)
213// sorts p, p may have equal monomials
214#define pSortAdd(p)             p_SortAdd(p, currRing)
217// Assume: If considerd only as poly in any component of p
218// (say, monomials of other components of p are set to 0),
219// then p is already sorted correctly
220#define pSortCompCorrect(p) pSort(p)
223 *
224 * Predicates on polys/Lm's
225 *
226 ***************************************************************/
227// return true if all p is eihter NULL, or if all exponents
228// of p are 0 and Comp of p is zero
229#define   pIsConstantComp(p)        p_IsConstantComp(p, currRing)
230// like above, except that Comp might be != 0
231#define   pIsConstant(p)            p_IsConstant(p,currRing)
232// return true if the Lm is a constant <>0
233#define   pIsUnit(p)            p_IsUnit(p,currRing)
234// like above, except that p must be != NULL
235#define   pLmIsConstantComp(p)      p_LmIsConstantComp(p, currRing)
236#define   pLmIsConstant(p)          p_LmIsConstant(p,currRing)
238// return TRUE if all monomials of p are constant
239#define   pIsConstantPoly(p)        p_IsConstantPoly(p, currRing)
241#define   pIsPurePower(p)   p_IsPurePower(p, currRing)
242#define   pIsUnivariate(p)  p_IsUnivariate(p, currRing)
243#define   pIsVector(p)      (pGetComp(p)>0)
244#define   pGetVariables(p,e)  p_GetVariables(p, e, currRing)
247 *
248 * Old stuff
249 *
250 ***************************************************************/
252typedef poly*   polyset;
253extern int      pVariables;
254extern int      pOrdSgn;
255extern BOOLEAN  pLexOrder;
256extern poly     ppNoether;
257extern BOOLEAN  pVectorOut;
259/*-------------predicate on polys ----------------------*/
260BOOLEAN   pHasNotCF(poly p1, poly p2);   /*has no common factor ?*/
261void      pSplit(poly p, poly * r);   /*p => IN(p), r => REST(p) */
265/*-------------ring management:----------------------*/
266//extern void pChangeRing(ring newRing);
267extern void pSetGlobals(const ring r, BOOLEAN complete = TRUE);
268// resets the pFDeg and pLDeg: if pLDeg is not given, it is
269// set to currRing->pLDegOrig, i.e. to the respective LDegProc which
270// only uses pFDeg (and not pDeg, or pTotalDegree, etc).
271// If you use this, make sure your procs does not make any assumptions
272// on oredering and/or OrdIndex -- otherwise they might return wrong results
273// on strat->tailRing
274extern void pSetDegProcs(pFDegProc new_FDeg, pLDegProc new_lDeg = NULL);
275// restores pFDeg and pLDeg:
276extern void pRestoreDegProcs(pFDegProc old_FDeg, pLDegProc old_lDeg);
278/*-----------the ordering of monomials:-------------*/
279#define pSetm(p)    p_Setm(p, currRing)
280// TODO:
281#define pSetmComp   pSetm
284 *
285 * Degree stuff -- see for explainations
286 *
287 ***************************************************************/
288extern pLDegProc pLDeg;
289extern pFDegProc pFDeg;
290int  pWeight(int c, const ring r = currRing);
291long pDeg(poly p,const ring r = currRing);
292static inline long pTotaldegree(poly p) { return p_Totaldegree(p,currRing); }
293long pWTotaldegree(poly p,const ring r = currRing);
294long pWDegree(poly p,const ring r = currRing);
295long pLDeg0(poly p,int *l,const ring r = currRing);
296long pLDeg0c(poly p,int *l,const ring r = currRing);
297long pLDegb(poly p,int *l,const ring r = currRing);
298long pLDeg1(poly p,int *l,const ring r = currRing);
299long pLDeg1c(poly p,int *l,const ring r = currRing);
300long pLDeg1_Deg(poly p,int *l,const ring r = currRing);
301long pLDeg1c_Deg(poly p,int *l,const ring r = currRing);
302long pLDeg1_Totaldegree(poly p,int *l,const ring r = currRing);
303long pLDeg1c_Totaldegree(poly p,int *l,const ring r = currRing);
304long pLDeg1_WFirstTotalDegree(poly p,int *l,const ring r=currRing);
305long pLDeg1c_WFirstTotalDegree(poly p,int *l,const ring r=currRing);
307/*-------------pComp for syzygies:-------------------*/
309void pSetModDeg(intvec *w);
314poly      pmInit(const char *s, BOOLEAN &ok); /* monom -> poly, interpreter */
315const char *    p_Read(const char *s, poly &p,const ring r); /* monom -> poly */
317/*-------------operations on polynomials:------------*/
318poly      pSub(poly a, poly b);
319poly      p_Power(poly p, int i, const ring r);
321// ----------------- define to enable new p_procs -----*/
323poly      pDivide(poly a, poly b);
324poly      pDivideM(poly a, poly b);
325void      pLcm(poly a, poly b, poly m);
326poly      pDiff(poly a, int k);
327poly      pDiffOp(poly a, poly b,BOOLEAN multiply);
329#define   pMaxComp(p)   p_MaxComp(p, currRing)
330#define   pMinComp(p)   p_MinComp(p, currRing)
331int pMaxCompProc(poly p);
333#define   pOneComp(p)       p_OneComp(p, currRing)
334#define   pSetCompP(a,i)    p_SetCompP(a, i, currRing)
336// let's inline those, so that we can call them from the debugger
337inline char*   pString(poly p)    {return p_String(p, currRing, currRing);}
338inline char*   pString0(poly p)   {return p_String0(p, currRing, currRing);}
339inline void    pWrite(poly p)     {p_Write(p, currRing, currRing);}
340inline void    pWrite0(poly p)    {p_Write0(p, currRing, currRing);}
341inline void    wrp(poly p)        {p_wrp(p, currRing, currRing);}
343void      pEnlargeSet(polyset *p, int length, int increment);
344#define   pISet(i) p_ISet(i,currRing)
345#define   pNSet(n) p_NSet(n,currRing)
347poly p_One(const ring r);
348#define   pOne()   p_One(currRing)
350void      p_Content(poly p, const ring r);
351//void      pSimpleContent(poly p, int s);
352poly      p_Cleardenom(poly p, const ring r);
353void      p_Cleardenom_n(poly p, const ring r,number &c);
354void      p_Normalize(poly p,const ring r);
355number    p_GetAllDenom(poly ph, const ring r);
356#define   pNormalize(p) p_Normalize(p,currRing)
357int       pSize( poly p );
360// homogenizes p by multiplying certain powers of the varnum-th variable
361poly      pHomogen (poly p, int varnum);
363BOOLEAN   pIsHomogeneous (poly p);
365poly      pPermPoly (poly p, int * perm,const ring OldRing, nMapFunc nMap,
366                     int *par_perm=NULL, int OldPar=0);
368/*BOOLEAN   pVectorHasUnitM(poly p, int * k);*/
369BOOLEAN   pVectorHasUnitB(poly p, int * k);
370void      pVectorHasUnit(poly p, int * k, int * len);
371poly      pTakeOutComp1(poly * p, int k);
372// Splits *p into two polys: *q which consists of all monoms with
373// component == comp and *p of all other monoms *lq == pLength(*q)
374// On return all components pf *q == 0
375void pTakeOutComp(poly *p, long comp, poly *q, int *lq);
377// This is something weird -- Don't use it, unless you know what you are doing
378poly      pTakeOutComp(poly * p, int k);
379void      pSetPolyComp(poly p, int comp);
380void      pDeleteComp(poly * p,int k);
381void      pNorm(poly p);
382poly      pSubst(poly p, int n, poly e);
383poly      ppJet(poly p, int m);
384poly      pJet(poly p, int m);
385poly      ppJetW(poly p, int m, short * iv);
386poly      pJetW(poly p, int m, short * iv);
387int pMinDeg(poly p,intvec *w=NULL);
388poly      pSeries(int n,poly p,poly u=NULL,intvec *w=NULL);
389poly      pInvers(int n, poly p,intvec *w=NULL);
390// maximum weigthed degree of all monomials of p, w is indexed from
391// 1..pVariables
392long      pDegW(poly p, const short *w);
394/*-----------type conversions ----------------------------*/
395poly  pPolys2Vec(polyset p, int len);
396void  pVec2Polys(poly v, polyset *p, int *len);
397int   p_Var(poly mi,const ring r);
398#define   pVar(m) p_Var(m,currRing)
400/*-----------specials for spoly-computations--------------*/
401BOOLEAN pCompareChain (poly p,poly p1,poly p2,poly lcm);
402BOOLEAN pCompareChainPart (poly p,poly p1,poly p2,poly lcm);
403#define  pEqualPolys(p1,p2) p_EqualPolys(p1,p2,currRing)
404BOOLEAN pComparePolys(poly p1,poly p2);
409 *
410 * PDEBUG stuff
411 *
412 ***************************************************************/
413#ifdef PDEBUG
414#define pTest(p)        _p_Test(p, currRing, PDEBUG)
415#define pLmTest(p)      _p_LmTest(p, currRing, PDEBUG)
417#else // ! PDEBUG
419#define pTest(p)        ((void)0)
420#define pLmTest(p)      ((void)0)
423#endif // POLYS_H
Note: See TracBrowser for help on using the repository browser.