include/cln/univpoly_modint.h

   1 // Univariate Polynomials over modular integers.
   2
   3 #ifndef _CL_UNIVPOLY_MODINT_H
   4 #define _CL_UNIVPOLY_MODINT_H
   5
   6 #include "cln/ring.h"
   7 #include "cln/univpoly.h"
   8 #include "cln/modinteger.h"
   9 #include "cln/integer_class.h"
  10
  11 namespace cln {
  12
  13 // Normal univariate polynomials with stricter static typing:
  14 // `cl_MI' instead of `cl_ring_element'.
  15
  16 class cl_heap_univpoly_modint_ring;
  17
  18 class cl_univpoly_modint_ring : public cl_univpoly_ring {
  19 public:
  20         // Default constructor.
  21         cl_univpoly_modint_ring () : cl_univpoly_ring () {}
  22         // Copy constructor.
  23         cl_univpoly_modint_ring (const cl_univpoly_modint_ring&);
  24         // Assignment operator.
  25         cl_univpoly_modint_ring& operator= (const cl_univpoly_modint_ring&);
  26         // Automatic dereferencing.
  27         cl_heap_univpoly_modint_ring* operator-> () const
  28         { return (cl_heap_univpoly_modint_ring*)heappointer; }
  29 };
  30 // Copy constructor and assignment operator.
  31 CL_DEFINE_COPY_CONSTRUCTOR2(cl_univpoly_modint_ring,cl_univpoly_ring)
  32 CL_DEFINE_ASSIGNMENT_OPERATOR(cl_univpoly_modint_ring,cl_univpoly_modint_ring)
  33
  34 class cl_UP_MI : public cl_UP {
  35 public:
  36         const cl_univpoly_modint_ring& ring () const { return The(cl_univpoly_modint_ring)(_ring); }
  37         // Conversion.
  38         CL_DEFINE_CONVERTER(cl_ring_element)
  39         // Destructive modification.
  40         void set_coeff (uintL index, const cl_MI& y);
  41         void finalize();
  42         // Evaluation.
  43         const cl_MI operator() (const cl_MI& y) const;
  44 public: // Ability to place an object at a given address.
  45         void* operator new (size_t size) { return malloc_hook(size); }
  46         void* operator new (size_t size, void* ptr) { (void)size; return ptr; }
  47         void operator delete (void* ptr) { free_hook(ptr); }
  48 };
  49
  50 class cl_heap_univpoly_modint_ring : public cl_heap_univpoly_ring {
  51         SUBCLASS_cl_heap_univpoly_ring()
  52         const cl_modint_ring& basering () const { return The(cl_modint_ring)(_basering); }
  53         // High-level operations.
  54         void fprint (std::ostream& stream, const cl_UP_MI& x)
  55         {
  56                 cl_heap_univpoly_ring::fprint(stream,x);
  57         }
  58         cl_boolean equal (const cl_UP_MI& x, const cl_UP_MI& y)
  59         {
  60                 return cl_heap_univpoly_ring::equal(x,y);
  61         }
  62         const cl_UP_MI zero ()
  63         {
  64                 return The2(cl_UP_MI)(cl_heap_univpoly_ring::zero());
  65         }
  66         cl_boolean zerop (const cl_UP_MI& x)
  67         {
  68                 return cl_heap_univpoly_ring::zerop(x);
  69         }
  70         const cl_UP_MI plus (const cl_UP_MI& x, const cl_UP_MI& y)
  71         {
  72                 return The2(cl_UP_MI)(cl_heap_univpoly_ring::plus(x,y));
  73         }
  74         const cl_UP_MI minus (const cl_UP_MI& x, const cl_UP_MI& y)
  75         {
  76                 return The2(cl_UP_MI)(cl_heap_univpoly_ring::minus(x,y));
  77         }
  78         const cl_UP_MI uminus (const cl_UP_MI& x)
  79         {
  80                 return The2(cl_UP_MI)(cl_heap_univpoly_ring::uminus(x));
  81         }
  82         const cl_UP_MI one ()
  83         {
  84                 return The2(cl_UP_MI)(cl_heap_univpoly_ring::one());
  85         }
  86         const cl_UP_MI canonhom (const cl_I& x)
  87         {
  88                 return The2(cl_UP_MI)(cl_heap_univpoly_ring::canonhom(x));
  89         }
  90         const cl_UP_MI mul (const cl_UP_MI& x, const cl_UP_MI& y)
  91         {
  92                 return The2(cl_UP_MI)(cl_heap_univpoly_ring::mul(x,y));
  93         }
  94         const cl_UP_MI square (const cl_UP_MI& x)
  95         {
  96                 return The2(cl_UP_MI)(cl_heap_univpoly_ring::square(x));
  97         }
  98         const cl_UP_MI expt_pos (const cl_UP_MI& x, const cl_I& y)
  99         {
 100                 return The2(cl_UP_MI)(cl_heap_univpoly_ring::expt_pos(x,y));
 101         }
 102         const cl_UP_MI scalmul (const cl_MI& x, const cl_UP_MI& y)
 103         {
 104                 return The2(cl_UP_MI)(cl_heap_univpoly_ring::scalmul(x,y));
 105         }
 106         sintL degree (const cl_UP_MI& x)
 107         {
 108                 return cl_heap_univpoly_ring::degree(x);
 109         }
 110         const cl_UP_MI monomial (const cl_MI& x, uintL e)
 111         {
 112                 return The2(cl_UP_MI)(cl_heap_univpoly_ring::monomial(x,e));
 113         }
 114         const cl_MI coeff (const cl_UP_MI& x, uintL index)
 115         {
 116                 return The2(cl_MI)(cl_heap_univpoly_ring::coeff(x,index));
 117         }
 118         const cl_UP_MI create (sintL deg)
 119         {
 120                 return The2(cl_UP_MI)(cl_heap_univpoly_ring::create(deg));
 121         }
 122         void set_coeff (cl_UP_MI& x, uintL index, const cl_MI& y)
 123         {
 124                 cl_heap_univpoly_ring::set_coeff(x,index,y);
 125         }
 126         void finalize (cl_UP_MI& x)
 127         {
 128                 cl_heap_univpoly_ring::finalize(x);
 129         }
 130         const cl_MI eval (const cl_UP_MI& x, const cl_MI& y)
 131         {
 132                 return The2(cl_MI)(cl_heap_univpoly_ring::eval(x,y));
 133         }
 134 private:
 135         // No need for any constructors.
 136         cl_heap_univpoly_modint_ring ();
 137 };
 138
 139 // Lookup of polynomial rings.
 140 inline const cl_univpoly_modint_ring find_univpoly_ring (const cl_modint_ring& r)
 141 { return The(cl_univpoly_modint_ring) (find_univpoly_ring((const cl_ring&)r)); }
 142 inline const cl_univpoly_modint_ring find_univpoly_ring (const cl_modint_ring& r, const cl_symbol& varname)
 143 { return The(cl_univpoly_modint_ring) (find_univpoly_ring((const cl_ring&)r,varname)); }
 144
 145 // Operations on polynomials.
 146
 147 // Add.
 148 inline const cl_UP_MI operator+ (const cl_UP_MI& x, const cl_UP_MI& y)
 149         { return x.ring()->plus(x,y); }
 150
 151 // Negate.
 152 inline const cl_UP_MI operator- (const cl_UP_MI& x)
 153         { return x.ring()->uminus(x); }
 154
 155 // Subtract.
 156 inline const cl_UP_MI operator- (const cl_UP_MI& x, const cl_UP_MI& y)
 157         { return x.ring()->minus(x,y); }
 158
 159 // Multiply.
 160 inline const cl_UP_MI operator* (const cl_UP_MI& x, const cl_UP_MI& y)
 161         { return x.ring()->mul(x,y); }
 162
 163 // Squaring.
 164 inline const cl_UP_MI square (const cl_UP_MI& x)
 165         { return x.ring()->square(x); }
 166
 167 // Exponentiation x^y, where y > 0.
 168 inline const cl_UP_MI expt_pos (const cl_UP_MI& x, const cl_I& y)
 169         { return x.ring()->expt_pos(x,y); }
 170
 171 // Scalar multiplication.
 172 #if 0 // less efficient
 173 inline const cl_UP_MI operator* (const cl_I& x, const cl_UP_MI& y)
 174         { return y.ring()->mul(y.ring()->canonhom(x),y); }
 175 inline const cl_UP_MI operator* (const cl_UP_MI& x, const cl_I& y)
 176         { return x.ring()->mul(x.ring()->canonhom(y),x); }
 177 #endif
 178 inline const cl_UP_MI operator* (const cl_I& x, const cl_UP_MI& y)
 179         { return y.ring()->scalmul(y.ring()->basering()->canonhom(x),y); }
 180 inline const cl_UP_MI operator* (const cl_UP_MI& x, const cl_I& y)
 181         { return x.ring()->scalmul(x.ring()->basering()->canonhom(y),x); }
 182 inline const cl_UP_MI operator* (const cl_MI& x, const cl_UP_MI& y)
 183         { return y.ring()->scalmul(x,y); }
 184 inline const cl_UP_MI operator* (const cl_UP_MI& x, const cl_MI& y)
 185         { return x.ring()->scalmul(y,x); }
 186
 187 // Coefficient.
 188 inline const cl_MI coeff (const cl_UP_MI& x, uintL index)
 189         { return x.ring()->coeff(x,index); }
 190
 191 // Destructive modification.
 192 inline void set_coeff (cl_UP_MI& x, uintL index, const cl_MI& y)
 193         { x.ring()->set_coeff(x,index,y); }
 194 inline void finalize (cl_UP_MI& x)
 195         { x.ring()->finalize(x); }
 196 inline void cl_UP_MI::set_coeff (uintL index, const cl_MI& y)
 197         { ring()->set_coeff(*this,index,y); }
 198 inline void cl_UP_MI::finalize ()
 199         { ring()->finalize(*this); }
 200
 201 // Evaluation. (No extension of the base ring allowed here for now.)
 202 inline const cl_MI cl_UP_MI::operator() (const cl_MI& y) const
 203 {
 204         return ring()->eval(*this,y);
 205 }
 206
 207 // Derivative.
 208 inline const cl_UP_MI deriv (const cl_UP_MI& x)
 209         { return The2(cl_UP_MI)(deriv((const cl_UP&)x)); }
 210
 211 }  // namespace cln
 212
 213 #endif /* _CL_UNIVPOLY_MODINT_H */