source: git/kernel/p_polys.h @ 367c32

Last change on this file since 367c32 was 367c32, checked in by Hans Schoenemann <hannes@…>, 14 years ago
remove _pNext,_pIter,_pGetCoeff etc. git-svn-id: file:///usr/local/Singular/svn/trunk@12901 2c84dea3-7e68-4137-9b89-c4e89433aadc
  • Property mode set to 100644
File size: 17.4 KB
2*  Computer Algebra System SINGULAR     *
5 *  File:    p_polys.h
6 *  Purpose: declaration of poly stuf which are independent of
7 *           currRing
8 *  Author:  obachman (Olaf Bachmann)
9 *  Created: 9/00
10 *  Version: $Id$
11 *******************************************************************/
12#ifndef P_POLYS_H
13#define P_POLYS_H
15#include "structs.h"
16#include "polys-impl.h"
18 Some general remarks:
19 We divide poly operations into roughly 4 categories:
20 Level 2: operations on monomials/polynomials with constant time,
21          or operations which are just dispatchers to other
22          poly routines
23          - implemented in: pInline2.h
24          - debugging only if PDEBUG >= 2
25          - normally inlined, unless PDEBUG >= 2 || NO_INLINE2
26 Level 1: operations on monomials with time proportional to length
27          - implemented in: pInline1.h
28          - debugging only if PDEBUG >= 1
29          - normally inlined, unless PDEBUG >= 1 || NO_INLINE1
30 Level 0: short operations on polynomials with time proportional to
31          length of poly
32          - implemented in
33          - debugging if PDEBUG
34          - normally _not_ inlined: can be forced with
35            #define DO_PINLINE0
36            #include "pInline0.h"
37 Misc   : operations on polynomials which do not fit in any of the
38          above categories
39          - implemented in: polys*.cc
40          - never inlined
41          - debugging if PDEBUG >= 0
43 You can set PDEBUG on a per-file basis, before including "mod2.h" like
44   #define PDEBUG 2
45   #include "mod2.h"
46 However, PDEBUG will only be in effect, if !NDEBUG.
50 *
51 * Primitives for accessing and setting fields of a poly
52 * poly must be != NULL
53 *
54 ***************************************************************/
55// next
56#define pNext(p)            ((p)->next)
57#define pIter(p)            ((p) = (p)->next)
59// coeff
60#define pGetCoeff(p)        ((p)->coef)
61// deletes old coeff before setting the new one
62#define pSetCoeff0(p,n)     (p)->coef=(n)
63#define p_GetCoeff(p,r)     pGetCoeff(p)
64#define p_SetCoeff0(p,n,r)  pSetCoeff0(p,n)
65// deletes old p->coef and sets new one
66PINLINE2 number p_SetCoeff(poly p, number n, ring r);
68// get Order
69PINLINE2 long p_GetOrder(poly p, ring r);
71// Component
72#define p_GetComp(p, r)     _p_GetComp(p, r)
73PINLINE2 unsigned long p_SetComp(poly p, unsigned long c, ring r);
74PINLINE2 unsigned long p_IncrComp(poly p, ring r);
75PINLINE2 unsigned long p_DecrComp(poly p, ring r);
76PINLINE2 unsigned long p_AddComp(poly p, unsigned long v, ring r);
77PINLINE2 unsigned long p_SubComp(poly p, unsigned long v, ring r);
79// Exponent
80PINLINE2 int p_GetExp(poly p, int v, ring r);
81PINLINE2 int p_SetExp(poly p, int v, int e, ring r);
82PINLINE2 int p_IncrExp(poly p, int v, ring r);
83PINLINE2 int p_DecrExp(poly p, int v, ring r);
84PINLINE2 int p_AddExp(poly p, int v, int ee, ring r);
85PINLINE2 int p_SubExp(poly p, int v, int ee, ring r);
86PINLINE2 int p_MultExp(poly p, int v, int ee, ring r);
87PINLINE2 int p_GetExpSum(poly p1, poly p2, int i, ring r);
88PINLINE2 int p_GetExpDiff(poly p1, poly p2, int i, ring r);
91 *
92 * Allocation/Initalization/Deletion
93 * except for pHead, all polys must be != NULL
94 *
95 ***************************************************************/
96PINLINE2 poly p_New(ring r);
97PINLINE2 poly p_New(ring r, omBin bin);
98PINLINE1 poly p_Init(ring r);
99PINLINE1 poly p_Init(ring r, omBin bin);
100PINLINE1 poly p_LmInit(poly p, ring r);
101PINLINE1 poly p_LmInit(poly s_p, ring s_r, ring d_p);
102PINLINE1 poly p_LmInit(poly s_p, ring s_r, ring d_p, omBin d_bin);
103PINLINE1 poly p_Head(poly p, ring r);
104PINLINE2 void p_LmFree(poly p, ring r);
105PINLINE2 void p_LmFree(poly *p, ring r);
106PINLINE2 poly p_LmFreeAndNext(poly p, ring r);
107PINLINE2 void p_LmDelete(poly p, ring r);
108PINLINE2 void p_LmDelete(poly *p, ring r);
109PINLINE2 poly p_LmDeleteAndNext(poly p, ring r);
112 *
113 * Operation on ExpVectors: assumes polys != NULL
114 *
115 ***************************************************************/
116// ExpVextor(d_p) = ExpVector(s_p)
117PINLINE1 void p_ExpVectorCopy(poly d_p, poly s_p, ring r);
118// adjustments for negative weights
119PINLINE1 void p_MemAdd_NegWeightAdjust(poly p, ring r);
120PINLINE1 void p_MemSub_NegWeightAdjust(poly p, ring r);
121// ExpVector(p1) += ExpVector(p2)
122PINLINE1 void p_ExpVectorAdd(poly p1, poly p2, ring r);
123// ExpVector(p1) -= ExpVector(p2)
124PINLINE1 void p_ExpVectorSub(poly p1, poly p2, ring r);
125// ExpVector(p1) += ExpVector(p2) - ExpVector(p3)
126PINLINE1 void p_ExpVectorAddSub(poly p1, poly p2, poly p3, ring r);
127// ExpVector(pr) = ExpVector(p1) + ExpVector(p2)
128PINLINE1 void p_ExpVectorSum(poly pr, poly p1, poly p2, ring r);
129// ExpVector(pr) = ExpVector(p1) + ExpVector(p2)
130PINLINE1 void p_ExpVectorDiff(poly pr, poly p1, poly p2, ring r);
131// returns TRUE if ExpVector(p1) == ExpVector(p2), FALSE, otherwise
132PINLINE1 BOOLEAN p_ExpVectorEqual(poly p1, poly p2, ring r);
133// returns sum of all exponents of p
134PINLINE1 unsigned long p_ExpVectorQuerSum(poly p, ring r);
136PINLINE1 void p_GetExpV(poly p, int *ev, ring r);
137PINLINE1 void p_SetExpV(poly p, int *ev, ring r);
141 *
142 * Comparisons: they are all done without regarding coeffs
143 *
144 ***************************************************************/
145PINLINE1 int p_LmCmp(poly p, poly q, ring r);
146#define p_LmCmpAction(p, q, r, actionE, actionG, actionS) \
147  _p_LmCmpAction(p, q, r, actionE, actionG, actionS)
149// returns 1 if ExpVector(p)==ExpVector(q): does not compare numbers !!
150#define p_LmEqual(p1, p2, r) p_ExpVectorEqual(p1, p2, r)
152// pCmp: args may be NULL
153// returns: (p2==NULL ? 1 : (p1 == NULL ? -1 : p_LmCmp(p1, p2)))
154PINLINE2 int p_Cmp(poly p1, poly p2, ring r);
158 *
159 * Divisiblity tests, args must be != NULL, except for
160 * pDivisbleBy
161 *
162 ***************************************************************/
163PINLINE1 BOOLEAN p_DivisibleBy(poly a, poly b, ring r);
164PINLINE1 BOOLEAN p_LmDivisibleBy(poly a, poly b, ring r);
165PINLINE1 BOOLEAN p_LmDivisibleByNoComp(poly a, poly b, ring r);
166unsigned long p_GetShortExpVector(poly a, ring r);
167PINLINE1 BOOLEAN p_LmShortDivisibleBy(poly a, unsigned long sev_a,
168                                      poly b, unsigned long not_sev_b, ring r);
170PINLINE1 BOOLEAN p_DivisibleBy(poly a, ring r_a, poly b, ring r_b);
171PINLINE1 BOOLEAN p_LmDivisibleBy(poly a, ring r_a, poly b, ring r_b);
172PINLINE1 BOOLEAN p_LmShortDivisibleBy(poly a, unsigned long sev_a, ring r_a,
173                                      poly b, unsigned long not_sev_b, ring r_b);
176 *
177 * Misc things on Lm
178 *
179 ***************************************************************/
180// test if the monomial is a constant as a vector component
181// i.e., test if all exponents are zero
182PINLINE1 BOOLEAN p_LmIsConstantComp(const poly p, const ring r);
183PINLINE1 BOOLEAN p_LmIsConstant(const poly p, const ring r);
185// return TRUE, if p_LmExpVectorAdd stays within ExpBound of ring r,
186//       FALSE, otherwise
187PINLINE1 BOOLEAN p_LmExpVectorAddIsOk(const poly p1, const poly p2, ring r);
190 *
191 * Misc things on polys
192 *
193 ***************************************************************/
194// return the maximal exponent of p
195PINLINE2 unsigned long p_GetMaxExp(poly p, ring r);
196// return the maximal exponent of p in form of the maximal long var
197unsigned long p_GetMaxExpL(poly p, ring r, unsigned long l_max = 0);
198// return monomial r such that GetExp(r,i) is maximum of all
199// monomials in p; coeff == 0, next == NULL, ord is not set
200poly p_GetMaxExpP(poly p, ring r);
202// suppose that l is a long var in r, return maximal exponent of l
203PINLINE2 unsigned long p_GetMaxExp(unsigned long l, ring r);
204// similar, except assume that l constains number_of_exps exponents
205PINLINE2 unsigned long p_GetMaxExp(const unsigned long l, const ring r, const int number_of_exps);
207// return the TotalDegree of the long var l
208PINLINE2 unsigned long p_GetTotalDegree(const unsigned long l, const ring r);
209// return the total degree of the long var l containing number_of_exp exponents
210PINLINE2 unsigned long p_GetTotalDegree(const unsigned long l, const ring r, const int number_of_exps);
213// like the respective p_LmIs* routines, except that p might be empty
214PINLINE1 BOOLEAN p_IsConstantComp(const poly p, const ring r);
215PINLINE1 BOOLEAN p_IsConstant(const poly p, const ring r);
216PINLINE0 BOOLEAN p_IsConstantPoly(const poly p, const ring r);
218// return TRUE if all monoms have the same component
219BOOLEAN   p_OneComp(poly p, ring r);
221// return i, if head depends only on var(i)
222int       p_IsPurePower(const poly p, const ring r);
224// return i, if poly depends only on var(i)
225int       p_IsUnivariate(poly p, const ring r);
227// set entry e[i] to 1 if var(i) occurs in p, ignore var(j) if e[j]>0
228// return #(e[i]>0)
229int      p_GetVariables(poly p, int * e, const ring r);
231// returns the poly representing the integer i
232poly      p_ISet(int i, ring r);
234// returns the poly representing the number n, destroys n
235poly      p_NSet(number n, ring r);
238 *
239 * Copying/Deletion of polys: args may be NULL
240 *
241 ***************************************************************/
242// returns a copy of p
243PINLINE2 poly p_Copy(poly p, const ring r);
244// returns a copy of p with Lm(p) from lmRing and Tail(p) from tailRing
245PINLINE2 poly p_Copy(poly p, const ring lmRing, const ring tailRing);
246// deletes *p, and sets *p to NULL
247PINLINE2 void p_Delete(poly *p, const ring r);
248PINLINE2 void p_Delete(poly *p, const ring lmRing, const ring tailRing);
250// copys monomials of p, allocates new monomials from bin,
251// deletes monomoals of p
252PINLINE2 poly p_ShallowCopyDelete(poly p, const ring r, omBin bin);
253// simial but does it only for leading monomial
254PINLINE1 poly p_LmShallowCopyDelete(poly p, const ring r, omBin bin);
255// simply deletes monomials, does not free coeffs
256void p_ShallowDelete(poly *p, const ring r);
261 *
262 * Copying/Deleteion of polys: args may be NULL
263 *  - p/q as arg mean a poly
264 *  - m a monomial
265 *  - n a number
266 *  - pp (resp. qq, mm, nn) means arg is constant
267 *  - p (resp, q, m, n)     means arg is destroyed
268 *
269 ***************************************************************/
270// returns -p, p is destroyed
271PINLINE2 poly p_Neg(poly p, const ring r);
273// returns p*n, p is const (i.e. copied)
274PINLINE2 poly pp_Mult_nn(poly p, number n, const ring r);
275// returns p*n, destroys p
276PINLINE2 poly p_Mult_nn(poly p, number n, const ring r);
277PINLINE2 poly p_Mult_nn(poly p, number n, const ring lmRing, const ring tailRing);
279// returns p*m, does neither destroy p nor m
280PINLINE2 poly pp_Mult_mm(poly p, poly m, const ring r);
281// returns p*m, destroys p, const: m
282PINLINE2 poly p_Mult_mm(poly p, poly m, const ring r);
284// returns p+q, destroys p and q
285PINLINE2 poly p_Add_q(poly p, poly q, const ring r);
286// like p_Add_q, except that if lp == pLength(lp) lq == pLength(lq)
287// then lp == pLength(p+q)
288PINLINE2 poly p_Add_q(poly p, poly q, int &lp, int lq, const ring r);
290// return p - m*q, destroys p; const: q,m
291PINLINE2 poly p_Minus_mm_Mult_qq(poly p, poly m, poly q, const ring r);
292// like p_Minus_mm_Mult_qq, except that if lp == pLength(lp) lq == pLength(lq)
293// then lp == pLength(p -m*q)
294PINLINE2 poly p_Minus_mm_Mult_qq(poly p, poly m, poly q, int &lp, int lq,
295                                 poly spNoether, const ring r);
296// returns p + m*q destroys p, const: q, m
297PINLINE2 poly p_Plus_mm_Mult_qq(poly p, poly m, poly q, const ring r);
299// returns p + m*q destroys p, const: q, m
300PINLINE2 poly p_Plus_mm_Mult_qq(poly p, poly m, poly q, int &lp, int lq,
301                                const ring r);
303// returns p*q, destroys p and q
304PINLINE2 poly p_Mult_q(poly p, poly q, const ring r);
305// returns p*q, does neither destroy p nor q
306PINLINE2 poly pp_Mult_qq(poly p, poly q, const ring r);
308// returns p*Coeff(m) for such monomials pm of p, for which m is divisble by pm
309PINLINE2 poly pp_Mult_Coeff_mm_DivSelect(poly p, const poly m, const ring r);
311// returns p*Coeff(m) for such monomials pm of p, for which m is divisble by pm
312// if lp is length of p on input then lp is length of returned poly on output
313PINLINE2 poly pp_Mult_Coeff_mm_DivSelect(poly p, int &lp, const poly m, const ring r);
315// returns merged p and q, assumes p and q have no monomials which are equal
316PINLINE2 poly p_Merge_q(poly p, poly c, const ring r);
317// sorts p using bucket sort: returns sorted poly
318// assumes that monomials of p are all different
319// reverses it first, if revert == TRUE, use this if input p is "almost" sorted
320// correctly
321PINLINE2 poly p_SortMerge(poly p, const ring r, BOOLEAN revert = FALSE);
322// like SortMerge, except that p may have equal monimals
323PINLINE2 poly p_SortAdd(poly p, const ring r, BOOLEAN revert = FALSE);
326 *
327 * Misc stuff
328 *
329 ***************************************************************/
330PINLINE2 void p_Setm(poly p, const ring r);
331p_SetmProc p_GetSetmProc(ring r);
333// TODO:
334#define p_SetmComp  p_Setm
336// sets component of poly a to i, returns length of a
337PINLINE0   int p_SetCompP(poly a, int i, ring r);
338PINLINE0   int p_SetCompP(poly a, int i, ring lmRing, ring tailRing);
339PINLINE0   long p_MaxComp(poly p, ring lmRing, ring tailRing);
340inline long p_MaxComp(poly p,ring lmRing) {return p_MaxComp(p,lmRing,lmRing);}
341PINLINE0   long p_MinComp(poly p, ring lmRing, ring tailRing);
342inline long p_MinComp(poly p,ring lmRing) {return p_MinComp(p,lmRing,lmRing);}
345 *
346 * poly things which are independent of ring
347 *
348 ***************************************************************/
349PINLINE0 int       pLength(poly a);
350PINLINE0 poly      pLast(poly a, int &length);
351inline   poly      pLast(poly a) { int l; return pLast(a, l);}
352PINLINE0 poly pReverse(poly p);
356 *
357 * I/O
358 *
359 ***************************************************************/
360char*     p_String(poly p, ring lmRing, ring tailRing);
361char*     p_String0(poly p, ring lmRing, ring tailRing);
362void      p_Write(poly p, ring lmRing, ring tailRing);
363void      p_Write0(poly p, ring lmRing, ring tailRing);
364void      p_wrp(poly p, ring lmRing, ring tailRing);
366PINLINE2 char*     p_String(poly p, ring p_ring);
367PINLINE2 char*     p_String0(poly p, ring p_ring);
368PINLINE2 void      p_Write(poly p, ring p_ring);
369PINLINE2 void      p_Write0(poly p, ring p_ring);
370PINLINE2 void      p_wrp(poly p, ring p_ring);
374 *
375 * Degree stuff -- see for explainations
376 *
377 ***************************************************************/
378extern pLDegProc pLDeg;
379extern pFDegProc pFDeg;
380int  pWeight(int i, ring r);
381long pDeg(poly p, ring r);
382long pTotaldegree(poly p, ring r);
383long pWFirstTotalDegree(poly p, ring r);
384long pWTotaldegree(poly p, ring r);
385long pWDegree(poly p, ring r);
386long pLDeg0(poly p,int *l, ring r);
387long pLDeg0c(poly p,int *l, ring r);
388long pLDegb(poly p,int *l, ring r);
389long pLDeg1(poly p,int *l, ring r);
390long pLDeg1c(poly p,int *l, ring r);
391long pLDeg1_Deg(poly p,int *l, ring r);
392long pLDeg1c_Deg(poly p,int *l, ring r);
393long pLDeg1_Totaldegree(poly p,int *l, ring r);
394long pLDeg1c_Totaldegree(poly p,int *l, ring r);
395long pLDeg1_WFirstTotalDegree(poly p,int *l, ring r);
396long pLDeg1c_WFirstTotalDegree(poly p,int *l, ring r);
397BOOLEAN p_EqualPolys(poly p1, poly p2, const ring r);
399 *
400 * PDEBUG stuff
401 *
402 ***************************************************************/
403#ifdef PDEBUG
404// Returns TRUE if m is monom of p, FALSE otherwise
405BOOLEAN pIsMonomOf(poly p, poly m);
406// Returns TRUE if p and q have common monoms
407BOOLEAN pHaveCommonMonoms(poly p, poly q);
409// p_Check* routines return TRUE if everything is ok,
410// else, they report error message and return false
412// check if Lm(p) is from ring r
413BOOLEAN p_LmCheckIsFromRing(poly p, ring r);
414// check if Lm(p) != NULL, r != NULL and initialized && Lm(p) is from r
415BOOLEAN p_LmCheckPolyRing(poly p, ring r);
416// check if all monoms of p are from ring r
417BOOLEAN p_CheckIsFromRing(poly p, ring r);
418// check r != NULL and initialized && all monoms of p are from r
419BOOLEAN p_CheckPolyRing(poly p, ring r);
420// check if r != NULL and initialized
421BOOLEAN p_CheckRing(ring r);
422// only do check if cond
425#define pIfThen(cond, check) do {if (cond) {check;}} while (0)
427BOOLEAN _p_Test(poly p, ring r, int level);
428BOOLEAN _p_LmTest(poly p, ring r, int level);
429BOOLEAN _pp_Test(poly p, ring lmRing, ring tailRing, int level);
431#define p_Test(p,r)     _p_Test(p, r, PDEBUG)
432#define p_LmTest(p,r)   _p_LmTest(p, r, PDEBUG)
433#define pp_Test(p, lmRing, tailRing)    _pp_Test(p, lmRing, tailRing, PDEBUG)
435#else // ! PDEBUG
437#define pIsMonomOf(p, q)        (TRUE)
438#define pHaveCommonMonoms(p, q) (TRUE)
439#define p_LmCheckIsFromRing(p,r)  ((void)0)
440#define p_LmCheckPolyRing(p,r)    ((void)0)
441#define p_CheckIsFromRing(p,r)  ((void)0)
442#define p_CheckPolyRing(p,r)    ((void)0)
443#define p_CheckRing(r)          ((void)0)
444#define P_CheckIf(cond, check)  ((void)0)
446#define p_Test(p,r)     (1)
447#define p_LmTest(p,r)   (1)
448#define pp_Test(p, lmRing, tailRing) (1)
452#include "pInline2.h"
453#include "pInline1.h"
455#endif // P_POLYS_H
Note: See TracBrowser for help on using the repository browser.