source: git/libpolys/coeffs/rmodulon.cc @ 45cc512

jengelh-datetimespielwiese
Last change on this file since 45cc512 was 45cc512, checked in by Hans Schoenemann <hannes@…>, 9 years ago
chg: rCharstr is now a wrapper for r->cf->cfCoeffString fixes also: charstr for integer,2,3
  • Property mode set to 100644
File size: 17.0 KB
Line 
1/****************************************
2*  Computer Algebra System SINGULAR     *
3****************************************/
4/*
5* ABSTRACT: numbers modulo n
6*/
7
8#ifdef HAVE_CONFIG_H
9#include "libpolysconfig.h"
10#endif /* HAVE_CONFIG_H */
11#include <misc/auxiliary.h>
12
13#ifdef HAVE_RINGS
14
15#include <misc/mylimits.h>
16#include <coeffs/coeffs.h>
17#include <reporter/reporter.h>
18#include <omalloc/omalloc.h>
19#include <coeffs/numbers.h>
20#include <coeffs/longrat.h>
21#include <coeffs/mpr_complex.h>
22#include <coeffs/rmodulon.h>
23#include "si_gmp.h"
24
25#include <string.h>
26
27/// Our Type!
28static const n_coeffType ID = n_Zn;
29static const n_coeffType ID2 = n_Znm;
30
31extern omBin gmp_nrz_bin;
32
33void    nrnCoeffWrite  (const coeffs r, BOOLEAN /*details*/)
34{
35  long l = (long)mpz_sizeinbase(r->modBase, 10) + 2;
36  char* s = (char*) omAlloc(l);
37  s= mpz_get_str (s, 10, r->modBase);
38  if (nCoeff_is_Ring_ModN(r)) Print("//   coeff. ring is : Z/%s\n", s);
39  else if (nCoeff_is_Ring_PtoM(r)) Print("//   coeff. ring is : Z/%s^%lu\n", s, r->modExponent);
40  omFreeSize((ADDRESS)s, l);
41}
42
43static BOOLEAN nrnCoeffsEqual(const coeffs r, n_coeffType n, void * parameter)
44{
45  /* test, if r is an instance of nInitCoeffs(n,parameter) */
46  return (n==n_Zn) && (mpz_cmp_ui(r->modNumber,(long)parameter)==0);
47}
48
49static char* nrnCoeffString(const coeffs r)
50{
51  char* s = (char*) omAlloc(7+11+2);
52  sprintf(s,"integer,%lu",r->modExponent);
53  return s;
54}
55
56/* for initializing function pointers */
57BOOLEAN nrnInitChar (coeffs r, void* p)
58{
59  assume( (getCoeffType(r) == ID) || (getCoeffType (r) == ID2) );
60  ZnmInfo * info= (ZnmInfo *) p;
61  r->modBase= info->base;
62
63  nrnInitExp (info->exp, r);
64
65  /* next computation may yield wrong characteristic as r->modNumber
66     is a GMP number */
67  r->ch = mpz_get_ui(r->modNumber);
68
69  r->cfCoeffString = nrnCoeffString;
70
71  r->cfInit        = nrnInit;
72  r->cfDelete      = nrnDelete;
73  r->cfCopy        = nrnCopy;
74  r->cfSize        = nrnSize;
75  r->cfInt         = nrnInt;
76  r->cfAdd         = nrnAdd;
77  r->cfSub         = nrnSub;
78  r->cfMult        = nrnMult;
79  r->cfDiv         = nrnDiv;
80  r->cfIntDiv      = nrnIntDiv;
81  r->cfIntMod      = nrnMod;
82  r->cfExactDiv    = nrnDiv;
83  r->cfNeg         = nrnNeg;
84  r->cfInvers      = nrnInvers;
85  r->cfDivBy       = nrnDivBy;
86  r->cfDivComp     = nrnDivComp;
87  r->cfGreater     = nrnGreater;
88  r->cfEqual       = nrnEqual;
89  r->cfIsZero      = nrnIsZero;
90  r->cfIsOne       = nrnIsOne;
91  r->cfIsMOne      = nrnIsMOne;
92  r->cfGreaterZero = nrnGreaterZero;
93  r->cfWriteLong   = nrnWrite;
94  r->cfRead        = nrnRead;
95  r->cfPower       = nrnPower;
96  r->cfSetMap      = nrnSetMap;
97  r->cfNormalize   = ndNormalize;
98  r->cfLcm         = nrnLcm;
99  r->cfGcd         = nrnGcd;
100  r->cfIsUnit      = nrnIsUnit;
101  r->cfGetUnit     = nrnGetUnit;
102  r->cfExtGcd      = nrnExtGcd;
103  r->cfName        = ndName;
104  r->cfCoeffWrite  = nrnCoeffWrite;
105  r->nCoeffIsEqual = nrnCoeffsEqual;
106  r->cfInit_bigint = nrnMapQ;
107  r->cfKillChar    = ndKillChar;
108#ifdef LDEBUG
109  r->cfDBTest      = nrnDBTest;
110#endif
111  return FALSE;
112}
113
114/*
115 * create a number from int
116 */
117number nrnInit(long i, const coeffs r)
118{
119  int_number erg = (int_number) omAllocBin(gmp_nrz_bin);
120  mpz_init_set_si(erg, i);
121  mpz_mod(erg, erg, r->modNumber);
122  return (number) erg;
123}
124
125void nrnDelete(number *a, const coeffs)
126{
127  if (*a == NULL) return;
128  mpz_clear((int_number) *a);
129  omFreeBin((void *) *a, gmp_nrz_bin);
130  *a = NULL;
131}
132
133number nrnCopy(number a, const coeffs)
134{
135  int_number erg = (int_number) omAllocBin(gmp_nrz_bin);
136  mpz_init_set(erg, (int_number) a);
137  return (number) erg;
138}
139
140int nrnSize(number a, const coeffs)
141{
142  if (a == NULL) return 0;
143  return sizeof(mpz_t);
144}
145
146/*
147 * convert a number to int
148 */
149int nrnInt(number &n, const coeffs)
150{
151  return (int)mpz_get_si((int_number) n);
152}
153
154/*
155 * Multiply two numbers
156 */
157number nrnMult(number a, number b, const coeffs r)
158{
159  int_number erg = (int_number)omAllocBin(gmp_nrz_bin);
160  mpz_init(erg);
161  mpz_mul(erg, (int_number)a, (int_number) b);
162  mpz_mod(erg, erg, r->modNumber);
163  return (number) erg;
164}
165
166void nrnPower(number a, int i, number * result, const coeffs r)
167{
168  int_number erg = (int_number)omAllocBin(gmp_nrz_bin);
169  mpz_init(erg);
170  mpz_powm_ui(erg, (int_number)a, i, r->modNumber);
171  *result = (number) erg;
172}
173
174number nrnAdd(number a, number b, const coeffs r)
175{
176  int_number erg = (int_number)omAllocBin(gmp_nrz_bin);
177  mpz_init(erg);
178  mpz_add(erg, (int_number)a, (int_number) b);
179  mpz_mod(erg, erg, r->modNumber);
180  return (number) erg;
181}
182
183number nrnSub(number a, number b, const coeffs r)
184{
185  int_number erg = (int_number)omAllocBin(gmp_nrz_bin);
186  mpz_init(erg);
187  mpz_sub(erg, (int_number)a, (int_number) b);
188  mpz_mod(erg, erg, r->modNumber);
189  return (number) erg;
190}
191
192number nrnNeg(number c, const coeffs r)
193{
194  if( !nrnIsZero(c, r) )
195    // Attention: This method operates in-place.
196    mpz_sub((int_number)c, r->modNumber, (int_number)c);
197  return c;
198}
199
200number nrnInvers(number c, const coeffs r)
201{
202  int_number erg = (int_number)omAllocBin(gmp_nrz_bin);
203  mpz_init(erg);
204  mpz_invert(erg, (int_number)c, r->modNumber);
205  return (number) erg;
206}
207
208/*
209 * Give the smallest k, such that a * x = k = b * y has a solution
210 * TODO: lcm(gcd,gcd) better than gcd(lcm) ?
211 */
212number nrnLcm(number a, number b, const coeffs r)
213{
214  number erg = nrnGcd(NULL, a, r);
215  number tmp = nrnGcd(NULL, b, r);
216  mpz_lcm((int_number)erg, (int_number)erg, (int_number)tmp);
217  nrnDelete(&tmp, NULL);
218  return (number)erg;
219}
220
221/*
222 * Give the largest k, such that a = x * k, b = y * k has
223 * a solution.
224 */
225number nrnGcd(number a, number b, const coeffs r)
226{
227  if ((a == NULL) && (b == NULL)) return nrnInit(0,r);
228  int_number erg = (int_number)omAllocBin(gmp_nrz_bin);
229  mpz_init_set(erg, r->modNumber);
230  if (a != NULL) mpz_gcd(erg, erg, (int_number)a);
231  if (b != NULL) mpz_gcd(erg, erg, (int_number)b);
232  return (number)erg;
233}
234
235/* Not needed any more, but may have room for improvement
236   number nrnGcd3(number a,number b, number c,ring r)
237{
238  int_number erg = (int_number) omAllocBin(gmp_nrz_bin);
239  mpz_init(erg);
240  if (a == NULL) a = (number)r->modNumber;
241  if (b == NULL) b = (number)r->modNumber;
242  if (c == NULL) c = (number)r->modNumber;
243  mpz_gcd(erg, (int_number)a, (int_number)b);
244  mpz_gcd(erg, erg, (int_number)c);
245  mpz_gcd(erg, erg, r->modNumber);
246  return (number)erg;
247}
248*/
249
250/*
251 * Give the largest k, such that a = x * k, b = y * k has
252 * a solution and r, s, s.t. k = s*a + t*b
253 */
254number nrnExtGcd(number a, number b, number *s, number *t, const coeffs r)
255{
256  int_number erg = (int_number)omAllocBin(gmp_nrz_bin);
257  int_number bs  = (int_number)omAllocBin(gmp_nrz_bin);
258  int_number bt  = (int_number)omAllocBin(gmp_nrz_bin);
259  mpz_init(erg);
260  mpz_init(bs);
261  mpz_init(bt);
262  mpz_gcdext(erg, bs, bt, (int_number)a, (int_number)b);
263  mpz_mod(bs, bs, r->modNumber);
264  mpz_mod(bt, bt, r->modNumber);
265  *s = (number)bs;
266  *t = (number)bt;
267  return (number)erg;
268}
269
270BOOLEAN nrnIsZero(number a, const coeffs)
271{
272#ifdef LDEBUG
273  if (a == NULL) return FALSE;
274#endif
275  return 0 == mpz_cmpabs_ui((int_number)a, 0);
276}
277
278BOOLEAN nrnIsOne(number a, const coeffs)
279{
280#ifdef LDEBUG
281  if (a == NULL) return FALSE;
282#endif
283  return 0 == mpz_cmp_si((int_number)a, 1);
284}
285
286BOOLEAN nrnIsMOne(number a, const coeffs r)
287{
288#ifdef LDEBUG
289  if (a == NULL) return FALSE;
290#endif
291  mpz_t t; mpz_init_set(t, (int_number)a);
292  mpz_add_ui(t, t, 1);
293  bool erg = (0 == mpz_cmp(t, r->modNumber));
294  mpz_clear(t);
295  return erg;
296}
297
298BOOLEAN nrnEqual(number a, number b, const coeffs)
299{
300  return 0 == mpz_cmp((int_number)a, (int_number)b);
301}
302
303BOOLEAN nrnGreater(number a, number b, const coeffs)
304{
305  return 0 < mpz_cmp((int_number)a, (int_number)b);
306}
307
308BOOLEAN nrnGreaterZero(number k, const coeffs)
309{
310  return 0 < mpz_cmp_si((int_number)k, 0);
311}
312
313BOOLEAN nrnIsUnit(number a, const coeffs r)
314{
315  number tmp = nrnGcd(a, (number)r->modNumber, r);
316  bool res = nrnIsOne(tmp, r);
317  nrnDelete(&tmp, NULL);
318  return res;
319}
320
321number nrnGetUnit(number k, const coeffs r)
322{
323  if (mpz_divisible_p(r->modNumber, (int_number)k)) return nrnInit(1,r);
324
325  int_number unit = (int_number)nrnGcd(k, 0, r);
326  mpz_tdiv_q(unit, (int_number)k, unit);
327  int_number gcd = (int_number)nrnGcd((number)unit, 0, r);
328  if (!nrnIsOne((number)gcd,r))
329  {
330    int_number ctmp;
331    // tmp := unit^2
332    int_number tmp = (int_number) nrnMult((number) unit,(number) unit,r);
333    // gcd_new := gcd(tmp, 0)
334    int_number gcd_new = (int_number) nrnGcd((number) tmp, 0, r);
335    while (!nrnEqual((number) gcd_new,(number) gcd,r))
336    {
337      // gcd := gcd_new
338      ctmp = gcd;
339      gcd = gcd_new;
340      gcd_new = ctmp;
341      // tmp := tmp * unit
342      mpz_mul(tmp, tmp, unit);
343      mpz_mod(tmp, tmp, r->modNumber);
344      // gcd_new := gcd(tmp, 0)
345      mpz_gcd(gcd_new, tmp, r->modNumber);
346    }
347    // unit := unit + modNumber / gcd_new
348    mpz_tdiv_q(tmp, r->modNumber, gcd_new);
349    mpz_add(unit, unit, tmp);
350    mpz_mod(unit, unit, r->modNumber);
351    nrnDelete((number*) &gcd_new, NULL);
352    nrnDelete((number*) &tmp, NULL);
353  }
354  nrnDelete((number*) &gcd, NULL);
355  return (number)unit;
356}
357
358BOOLEAN nrnDivBy(number a, number b, const coeffs r)
359{
360  if (a == NULL)
361    return mpz_divisible_p(r->modNumber, (int_number)b);
362  else
363  { /* b divides a iff b/gcd(a, b) is a unit in the given ring: */
364    number n = nrnGcd(a, b, r);
365    mpz_tdiv_q((int_number)n, (int_number)b, (int_number)n);
366    bool result = nrnIsUnit(n, r);
367    nrnDelete(&n, NULL);
368    return result;
369  }
370}
371
372int nrnDivComp(number a, number b, const coeffs r)
373{
374  if (nrnEqual(a, b,r)) return 2;
375  if (mpz_divisible_p((int_number) a, (int_number) b)) return -1;
376  if (mpz_divisible_p((int_number) b, (int_number) a)) return 1;
377  return 0;
378}
379
380number nrnDiv(number a, number b, const coeffs r)
381{
382  if (a == NULL) a = (number)r->modNumber;
383  int_number erg = (int_number)omAllocBin(gmp_nrz_bin);
384  mpz_init(erg);
385  if (mpz_divisible_p((int_number)a, (int_number)b))
386  {
387    mpz_divexact(erg, (int_number)a, (int_number)b);
388    return (number)erg;
389  }
390  else
391  {
392    int_number gcd = (int_number)nrnGcd(a, b, r);
393    mpz_divexact(erg, (int_number)b, gcd);
394    if (!nrnIsUnit((number)erg, r))
395    {
396      WerrorS("Division not possible, even by cancelling zero divisors.");
397      WerrorS("Result is integer division without remainder.");
398      mpz_tdiv_q(erg, (int_number) a, (int_number) b);
399      nrnDelete((number*) &gcd, NULL);
400      return (number)erg;
401    }
402    // a / gcd(a,b) * [b / gcd (a,b)]^(-1)
403    int_number tmp = (int_number)nrnInvers((number) erg,r);
404    mpz_divexact(erg, (int_number)a, gcd);
405    mpz_mul(erg, erg, tmp);
406    nrnDelete((number*) &gcd, NULL);
407    nrnDelete((number*) &tmp, NULL);
408    mpz_mod(erg, erg, r->modNumber);
409    return (number)erg;
410  }
411}
412
413number nrnMod(number a, number b, const coeffs r)
414{
415  /*
416    We need to return the number rr which is uniquely determined by the
417    following two properties:
418      (1) 0 <= rr < |b| (with respect to '<' and '<=' performed in Z x Z)
419      (2) There exists some k in the integers Z such that a = k * b + rr.
420    Consider g := gcd(n, |b|). Note that then |b|/g is a unit in Z/n.
421    Now, there are three cases:
422      (a) g = 1
423          Then |b| is a unit in Z/n, i.e. |b| (and also b) divides a.
424          Thus rr = 0.
425      (b) g <> 1 and g divides a
426          Then a = (a/g) * (|b|/g)^(-1) * b (up to sign), i.e. again rr = 0.
427      (c) g <> 1 and g does not divide a
428          Then denote the division with remainder of a by g as this:
429          a = s * g + t. Then t = a - s * g = a - s * (|b|/g)^(-1) * |b|
430          fulfills (1) and (2), i.e. rr := t is the correct result. Hence
431          in this third case, rr is the remainder of division of a by g in Z.
432     Remark: according to mpz_mod: a,b are always non-negative
433  */
434  int_number g = (int_number)omAllocBin(gmp_nrz_bin);
435  int_number rr = (int_number)omAllocBin(gmp_nrz_bin);
436  mpz_init(g);
437  mpz_init_set_si(rr, 0);
438  mpz_gcd(g, (int_number)r->modNumber, (int_number)b); // g is now as above
439  if (mpz_cmp_si(g, (long)1) != 0) mpz_mod(rr, (int_number)a, g); // the case g <> 1
440  mpz_clear(g);
441  omFreeBin(g, gmp_nrz_bin);
442  return (number)rr;
443}
444
445number nrnIntDiv(number a, number b, const coeffs r)
446{
447  int_number erg = (int_number)omAllocBin(gmp_nrz_bin);
448  mpz_init(erg);
449  if (a == NULL) a = (number)r->modNumber;
450  mpz_tdiv_q(erg, (int_number)a, (int_number)b);
451  return (number)erg;
452}
453
454/*
455 * Helper function for computing the module
456 */
457
458int_number nrnMapCoef = NULL;
459
460number nrnMapModN(number from, const coeffs /*src*/, const coeffs dst)
461{
462  return nrnMult(from, (number) nrnMapCoef, dst);
463}
464
465number nrnMap2toM(number from, const coeffs /*src*/, const coeffs dst)
466{
467  int_number erg = (int_number)omAllocBin(gmp_nrz_bin);
468  mpz_init(erg);
469  mpz_mul_ui(erg, nrnMapCoef, (NATNUMBER)from);
470  mpz_mod(erg, erg, dst->modNumber);
471  return (number)erg;
472}
473
474number nrnMapZp(number from, const coeffs /*src*/, const coeffs dst)
475{
476  int_number erg = (int_number)omAllocBin(gmp_nrz_bin);
477  mpz_init(erg);
478  // TODO: use npInt(...)
479  mpz_mul_si(erg, nrnMapCoef, (NATNUMBER)from);
480  mpz_mod(erg, erg, dst->modNumber);
481  return (number)erg;
482}
483
484number nrnMapGMP(number from, const coeffs /*src*/, const coeffs dst)
485{
486  int_number erg = (int_number)omAllocBin(gmp_nrz_bin);
487  mpz_init(erg);
488  mpz_mod(erg, (int_number)from, dst->modNumber);
489  return (number)erg;
490}
491
492number nrnMapQ(number from, const coeffs src, const coeffs dst)
493{
494  int_number erg = (int_number)omAllocBin(gmp_nrz_bin);
495  mpz_init(erg);
496  nlGMP(from, (number)erg, src);
497  mpz_mod(erg, erg, dst->modNumber);
498  return (number)erg;
499}
500
501nMapFunc nrnSetMap(const coeffs src, const coeffs dst)
502{
503  /* dst = currRing->cf */
504  if (nCoeff_is_Ring_Z(src))
505  {
506    return nrnMapGMP;
507  }
508  if (nCoeff_is_Q(src))
509  {
510    return nrnMapQ;
511  }
512  // Some type of Z/n ring / field
513  if (nCoeff_is_Ring_ModN(src) || nCoeff_is_Ring_PtoM(src) ||
514      nCoeff_is_Ring_2toM(src) || nCoeff_is_Zp(src))
515  {
516    if (   (!nCoeff_is_Zp(src))
517        && (mpz_cmp(src->modBase, dst->modBase) == 0)
518        && (src->modExponent == dst->modExponent)) return nrnMapGMP;
519    else
520    {
521      int_number nrnMapModul = (int_number) omAllocBin(gmp_nrz_bin);
522      // Computing the n of Z/n
523      if (nCoeff_is_Zp(src))
524      {
525        mpz_init_set_si(nrnMapModul, src->ch);
526      }
527      else
528      {
529        mpz_init(nrnMapModul);
530        mpz_set(nrnMapModul, src->modNumber);
531      }
532      // nrnMapCoef = 1 in dst       if dst is a subring of src
533      // nrnMapCoef = 0 in dst / src if src is a subring of dst
534      if (nrnMapCoef == NULL)
535      {
536        nrnMapCoef = (int_number) omAllocBin(gmp_nrz_bin);
537        mpz_init(nrnMapCoef);
538      }
539      if (mpz_divisible_p(nrnMapModul, dst->modNumber))
540      {
541        mpz_set_si(nrnMapCoef, 1);
542      }
543      else
544      if (nrnDivBy(NULL, (number) nrnMapModul,dst))
545      {
546        mpz_divexact(nrnMapCoef, dst->modNumber, nrnMapModul);
547        int_number tmp = dst->modNumber;
548        dst->modNumber = nrnMapModul;
549        if (!nrnIsUnit((number) nrnMapCoef,dst))
550        {
551          dst->modNumber = tmp;
552          nrnDelete((number*) &nrnMapModul, dst);
553          return NULL;
554        }
555        int_number inv = (int_number) nrnInvers((number) nrnMapCoef,dst);
556        dst->modNumber = tmp;
557        mpz_mul(nrnMapCoef, nrnMapCoef, inv);
558        mpz_mod(nrnMapCoef, nrnMapCoef, dst->modNumber);
559        nrnDelete((number*) &inv, dst);
560      }
561      else
562      {
563        nrnDelete((number*) &nrnMapModul, dst);
564        return NULL;
565      }
566      nrnDelete((number*) &nrnMapModul, dst);
567      if (nCoeff_is_Ring_2toM(src))
568        return nrnMap2toM;
569      else if (nCoeff_is_Zp(src))
570        return nrnMapZp;
571      else
572        return nrnMapModN;
573    }
574  }
575  return NULL;      // default
576}
577
578/*
579 * set the exponent (allocate and init tables) (TODO)
580 */
581
582void nrnSetExp(unsigned long m, coeffs r)
583{
584  /* clean up former stuff */
585  if (r->modNumber != NULL) mpz_clear(r->modNumber);
586
587  r->modExponent= m;
588  r->modNumber = (int_number)omAllocBin(gmp_nrz_bin);
589  mpz_init_set (r->modNumber, r->modBase);
590  mpz_pow_ui (r->modNumber, r->modNumber, m);
591}
592
593/* We expect this ring to be Z/n^m for some m > 0 and for some n > 2 which is not a prime. */
594void nrnInitExp(unsigned long m, coeffs r)
595{
596  nrnSetExp(m, r);
597  assume (r->modNumber != NULL);
598  if (mpz_cmp_ui(r->modNumber,2) <= 0)
599    WarnS("nrnInitExp failed (m in Z/m too small)");
600}
601
602#ifdef LDEBUG
603BOOLEAN nrnDBTest (number a, const char *, const int, const coeffs r)
604{
605  if (a==NULL) return TRUE;
606  if ( (mpz_cmp_si((int_number) a, 0) < 0) || (mpz_cmp((int_number) a, r->modNumber) > 0) )
607  {
608    return FALSE;
609  }
610  return TRUE;
611}
612#endif
613
614/*2
615* extracts a long integer from s, returns the rest    (COPY FROM longrat0.cc)
616*/
617static const char * nlCPEatLongC(char *s, mpz_ptr i)
618{
619  const char * start=s;
620  if (!(*s >= '0' && *s <= '9'))
621  {
622    mpz_init_set_si(i, 1);
623    return s;
624  }
625  mpz_init(i);
626  while (*s >= '0' && *s <= '9') s++;
627  if (*s=='\0')
628  {
629    mpz_set_str(i,start,10);
630  }
631  else
632  {
633    char c=*s;
634    *s='\0';
635    mpz_set_str(i,start,10);
636    *s=c;
637  }
638  return s;
639}
640
641const char * nrnRead (const char *s, number *a, const coeffs r)
642{
643  int_number z = (int_number) omAllocBin(gmp_nrz_bin);
644  {
645    s = nlCPEatLongC((char *)s, z);
646  }
647  mpz_mod(z, z, r->modNumber);
648  *a = (number) z;
649  return s;
650}
651#endif
652/* #ifdef HAVE_RINGS */
Note: See TracBrowser for help on using the repository browser.