mdw@git.distorted.org.uk Git - catacomb-python/blob - field.c

   1 /* -*-c-*-
   2  *
   3  * Abstract fields
   4  *
   5  * (c) 2004 Straylight/Edgeware
   6  */
   7
   8 /*----- Licensing notice --------------------------------------------------*
   9  *
  10  * This file is part of the Python interface to Catacomb.
  11  *
  12  * Catacomb/Python is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * Catacomb/Python is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with Catacomb/Python; if not, write to the Free Software Foundation,
  24  * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  25  */
  26
  27 /*----- Header files ------------------------------------------------------*/
  28
  29 #include "catacomb-python.h"
  30
  31 /*----- Various utilities -------------------------------------------------*/
  32
  33 PyTypeObject *field_pytype;
  34 PyTypeObject *primefield_pytype;
  35 PyTypeObject *niceprimefield_pytype;
  36 PyTypeObject *binfield_pytype;
  37 PyTypeObject *binpolyfield_pytype;
  38 PyTypeObject *binnormfield_pytype;
  39 PyTypeObject *fe_pytype;
  40
  41 static PyObject *fe_pynew(PyTypeObject *ty, PyObject *arg, PyObject *kw)
  42 {
  43   PyObject *x;
  44   mp *z;
  45   static const char *const kwlist[] = { "x", 0 };
  46
  47   if (!PyArg_ParseTupleAndKeywords(arg, kw, "O:fe", KWLIST, &x))
  48     return (0);
  49   if (FE_PYCHECK(x) && FE_F(x) == FIELD_F(ty)) RETURN_OBJ(x);
  50   if ((z = getmp(x)) == 0) return (0);
  51   z = F_IN(FIELD_F(ty), z, z);
  52   return (fe_pywrap((PyObject *)ty, z));
  53 }
  54
  55 static PyObject *field_dopywrap(PyTypeObject *ty, field *f)
  56 {
  57   field_pyobj *fobj = newtype(ty, 0, f->ops->name);
  58   fobj->f = f;
  59   fobj->ty.ht_type.tp_basicsize = sizeof(fe_pyobj);
  60   fobj->ty.ht_type.tp_base = fe_pytype;
  61   Py_INCREF(fe_pytype);
  62   fobj->ty.ht_type.tp_flags = (Py_TPFLAGS_DEFAULT |
  63                                Py_TPFLAGS_BASETYPE |
  64                                Py_TPFLAGS_CHECKTYPES |
  65                                Py_TPFLAGS_HEAPTYPE);
  66   fobj->ty.ht_type.tp_alloc = PyType_GenericAlloc;
  67   fobj->ty.ht_type.tp_free = 0;
  68   fobj->ty.ht_type.tp_new = fe_pynew;
  69   typeready(&fobj->ty.ht_type);
  70   return ((PyObject *)fobj);
  71 }
  72
  73 PyObject *field_pywrap(field *f)
  74 {
  75   PyTypeObject *ty;
  76
  77   if (STRCMP(F_NAME(f), ==, "prime")) ty = primefield_pytype;
  78   else if (STRCMP(F_NAME(f), ==, "niceprime")) ty = niceprimefield_pytype;
  79   else if (STRCMP(F_NAME(f), ==, "binpoly")) ty = binpolyfield_pytype;
  80   else if (STRCMP(F_NAME(f), ==, "binnorm")) ty = binnormfield_pytype;
  81   else abort();
  82   return (field_dopywrap(ty, f));
  83 }
  84
  85 field *field_copy(field *f)
  86 {
  87   if (STRCMP(F_NAME(f), ==, "prime"))
  88     f = field_prime(f->m);
  89   else if (STRCMP(F_NAME(f), ==, "niceprime"))
  90     f = field_niceprime(f->m);
  91   else if (STRCMP(F_NAME(f), ==, "binpoly"))
  92     f = field_binpoly(f->m);
  93   else if (STRCMP(F_NAME(f), ==, "binnorm")) {
  94     fctx_binnorm *fc = (fctx_binnorm *)f;
  95     f = field_binnorm(f->m, fc->ntop.r[fc->ntop.n - 1]);
  96   } else
  97     abort();
  98   return (f);
  99 }
 100
 101 PyObject *fe_pywrap(PyObject *fobj, mp *x)
 102 {
 103   fe_pyobj *z = PyObject_New(fe_pyobj, (PyTypeObject *)fobj);
 104   z->f = FIELD_F(fobj);
 105   Py_INCREF(fobj);
 106   z->x = x;
 107   return ((PyObject *)z);
 108 }
 109
 110 static mp *tofe(field *f, PyObject *o)
 111 {
 112   mp *x = 0, *y = 0;
 113
 114   if (FE_PYCHECK(o)) {
 115     if (FE_F(o) != f && !field_samep(FE_F(o), f)) return (0);
 116     y = MP_COPY(FE_X(o));
 117   } else if ((x = tomp(o)) != 0) {
 118     if (MP_ZEROP(x))
 119       y = MP_COPY(f->zero);
 120     else if (MP_EQ(x, MP_ONE))
 121       y = MP_COPY(f->one);
 122     else
 123       y = F_IN(f, MP_NEW, x);
 124     MP_DROP(x);
 125   }
 126   return (y);
 127 }
 128
 129 /*----- Field elements ----------------------------------------------------*/
 130
 131 static int febinop(PyObject *x, PyObject *y,
 132                    field **f, PyObject **fobj, mp **xx, mp **yy)
 133 {
 134   if (FE_PYCHECK(x)) *fobj = FE_FOBJ(x);
 135   else if (FE_PYCHECK(y)) *fobj = FE_FOBJ(y);
 136   else return (-1);
 137   *f = FIELD_F(*fobj);
 138   if ((*xx = tofe(*f, x)) == 0)
 139     return (-1);
 140   if ((*yy = tofe(*f, y)) == 0) {
 141     MP_DROP(*xx);
 142     return (-1);
 143   }
 144   return (0);
 145 }
 146
 147 #define BINOP(name)                                                     \
 148   static PyObject *fe_py##name(PyObject *x, PyObject *y) {              \
 149     PyObject *fobj;                                                     \
 150     field *ff;                                                          \
 151     mp *xx, *yy, *zz;                                                   \
 152     if (febinop(x, y, &ff, &fobj, &xx, &yy)) RETURN_NOTIMPL;            \
 153     zz = ff->ops->name(ff, MP_NEW, xx, yy);                             \
 154     MP_DROP(xx); MP_DROP(yy);                                           \
 155     return (fe_pywrap(fobj, zz));                                       \
 156   }
 157 BINOP(add)
 158 BINOP(sub)
 159 BINOP(mul)
 160 #undef BINOP
 161
 162 static PyObject *fe_pydiv(PyObject *x, PyObject *y)
 163 {
 164   PyObject *fobj;
 165   field *ff;
 166   mp *xx, *yy;
 167   PyObject *z = 0;
 168   if (febinop(x, y, &ff, &fobj, &xx, &yy)) RETURN_NOTIMPL;
 169   if (F_ZEROP(ff, yy)) ZDIVERR("division by zero");
 170   yy = F_INV(ff, yy, yy);
 171   z = fe_pywrap(fobj, F_MUL(ff, MP_NEW, xx, yy));
 172 end:
 173   MP_DROP(xx); MP_DROP(yy);
 174   return (z);
 175 }
 176
 177 static PyObject *fe_pyexp(PyObject *x, PyObject *y, PyObject *z)
 178 {
 179   field *ff;
 180   mp *xx, *yy;
 181
 182   if (z != Py_None || !FE_PYCHECK(x) || (yy = tomp(y)) == 0)
 183     RETURN_NOTIMPL;
 184   ff = FE_F(x); xx = FE_X(x); MP_COPY(xx);
 185   if (MP_NEGP(yy) && F_ZEROP(ff, xx)) ZDIVERR("division by zero");
 186   z = fe_pywrap(FE_FOBJ(x), field_exp(ff, MP_NEW, xx, yy));
 187 end:
 188   MP_DROP(xx); MP_DROP(yy);
 189   return (z);
 190 }
 191
 192 static PyObject *fe_pyneg(PyObject *x)
 193 {
 194   return fe_pywrap(FE_FOBJ(x), FE_F(x)->ops->neg(FE_F(x), MP_NEW, FE_X(x)));
 195 }
 196
 197 static PyObject *fe_pyid(PyObject *x) { RETURN_OBJ(x); }
 198
 199 static int fe_pynonzerop(PyObject *x) { return !F_ZEROP(FE_F(x), FE_X(x)); }
 200
 201 static PyObject *fe_pyrichcompare(PyObject *x, PyObject *y, int op)
 202 {
 203   PyObject *fobj;
 204   field *ff;
 205   mp *xx, *yy;
 206   int b;
 207   PyObject *rc = 0;
 208
 209   if (febinop(x, y, &ff, &fobj, &xx, &yy)) RETURN_NOTIMPL;
 210   switch (op) {
 211     case Py_EQ: b = MP_EQ(xx, yy); break;
 212     case Py_NE: b = !MP_EQ(xx, yy); break;
 213     default: TYERR("field elements are unordered");
 214   }
 215   rc = getbool(b);
 216 end:
 217   MP_DROP(xx); MP_DROP(yy);
 218   return (rc);
 219 }
 220
 221 static Py_hash_t fe_pyhash(PyObject *me)
 222   { return (mphash(FE_X(me))); }
 223
 224 static int fe_pycoerce(PyObject **x, PyObject **y)
 225 {
 226   mp *z;
 227
 228   if (FE_PYCHECK(*y)) {
 229     if (FE_F(*x) != FE_F(*y) && !field_samep(FE_F(*x), FE_F(*y)))
 230       TYERR("field mismatch");
 231     Py_INCREF(*x); Py_INCREF(*y);
 232     return (0);
 233   }
 234   if ((z = tofe(FE_F(*x), *y)) != 0) {
 235     Py_INCREF(*x);
 236     *y = fe_pywrap(FE_FOBJ(*x), z);
 237     return (0);
 238   }
 239   return (1);
 240
 241 end:
 242   return (-1);
 243 }
 244
 245 static PyObject *fe_pyint(PyObject *x)
 246 {
 247   long l;
 248   PyObject *rc;
 249   mp *xx = F_OUT(FE_F(x), MP_NEW, FE_X(x));
 250   if (!mp_tolong_checked(xx, &l, 0)) rc = PyInt_FromLong(l);
 251   else rc = mp_topylong(xx);
 252   MP_DROP(xx);
 253   return (rc);
 254 }
 255
 256 static PyObject *fe_pylong(PyObject *x)
 257 {
 258   mp *xx = F_OUT(FE_F(x), MP_NEW, FE_X(x));
 259   PyObject *rc = mp_topylong(xx);
 260   MP_DROP(xx);
 261   return (rc);
 262 }
 263
 264 #define BASEOP(name, radix, pre)                                        \
 265   static PyObject *fe_py##name(PyObject *x) {                           \
 266     mp *xx = F_OUT(FE_F(x), MP_NEW, FE_X(x));                           \
 267     PyObject *rc = mp_topystring(xx, radix, 0, pre, 0);                 \
 268     MP_DROP(xx);                                                        \
 269     return (rc);                                                        \
 270   }
 271 BASEOP(oct, 8, "0");
 272 BASEOP(hex, 16, "0x");
 273 #undef BASEOP
 274
 275 static void fe_pydealloc(PyObject *me)
 276 {
 277   Py_DECREF(FE_FOBJ(me));
 278   MP_DROP(FE_X(me));
 279   FREEOBJ(me);
 280 }
 281
 282 #define UNOP(name, check)                                               \
 283   static PyObject *femeth_##name(PyObject *me) {                        \
 284     field *f = FE_F(me);                                                \
 285     mp *x = FE_X(me);                                                   \
 286     if (!f->ops->name) TYERR(#name " not supported for this field");    \
 287     check                                                               \
 288     x = f->ops->name(f, MP_NEW, x);                                     \
 289     if (!x) RETURN_NONE;                                                \
 290     return (fe_pywrap(FE_FOBJ(me), x));                                 \
 291   end:                                                                  \
 292     return (0);                                                         \
 293   }
 294 UNOP(inv, if (F_ZEROP(f, x)) ZDIVERR("division by zero"); )
 295 UNOP(sqr, ; )
 296 UNOP(sqrt, ; )
 297 UNOP(quadsolve, ; )
 298 UNOP(dbl, ; )
 299 UNOP(tpl, ; )
 300 UNOP(qdl, ; )
 301 UNOP(hlv, ; )
 302 #undef UNOP
 303
 304 static PyObject *feget_value(PyObject *me, void *hunoz)
 305 {
 306   mp *x = F_OUT(FE_F(me), MP_NEW, FE_X(me));
 307   if (F_TYPE(FE_F(me)) == FTY_BINARY)
 308     return (gf_pywrap(x));
 309   else
 310     return (mp_pywrap(x));
 311 }
 312
 313 static PyObject *feget__value(PyObject *me, void *hunoz)
 314 {
 315   mp *x = FE_X(me);
 316   MP_COPY(x);
 317   if (F_TYPE(FE_F(me)) == FTY_BINARY)
 318     return (gf_pywrap(x));
 319   else
 320     return (mp_pywrap(x));
 321 }
 322
 323 static const PyMemberDef fe_pymembers[] = {
 324 #define MEMBERSTRUCT fe_pyobj
 325   MEMRNM(field, T_OBJECT, ob_type, READONLY,
 326                         "X.field -> field containing X")
 327 #undef MEMBERSTRUCT
 328   { 0 }
 329 };
 330
 331 static const PyGetSetDef fe_pygetset[] = {
 332 #define GETSETNAME(op, name) fe##op##_##name
 333   GET   (value,         "X.value -> `natural' MP/GF representation of X")
 334   GET   (_value,        "X._value -> internal MP/GF representation of X")
 335 #undef GETSETNAME
 336   { 0 }
 337 };
 338
 339 static const PyMethodDef fe_pymethods[] = {
 340 #define METHNAME(func) femeth_##func
 341   NAMETH(inv,           "X.inv() -> X^{-1}")
 342   NAMETH(sqr,           "X.sqr() -> X^2")
 343   NAMETH(sqrt,          "X.sqrt() -> sqrt(X)")
 344   NAMETH(quadsolve,     "X.quadsolve() -> Y where Y^2 + Y = X (binary only)")
 345   NAMETH(dbl,           "X.dbl() -> 2 * X (prime only)")
 346   NAMETH(tpl,           "X.tpl() -> 3 * X (prime only)")
 347   NAMETH(qdl,           "X.qdl() -> 4 * X (prime only)")
 348   NAMETH(hlv,           "X.hlv() -> X/2 (prime only)")
 349 #undef METHNAME
 350   { 0 }
 351 };
 352
 353 static const PyNumberMethods fe_pynumber = {
 354   fe_pyadd,                             /* @nb_add@ */
 355   fe_pysub,                             /* @nb_subtract@ */
 356   fe_pymul,                             /* @nb_multiply@ */
 357   fe_pydiv,                             /* @nb_divide@ */
 358   0,                                    /* @nb_remainder@ */
 359   0,                                    /* @nb_divmod@ */
 360   fe_pyexp,                             /* @nb_power@ */
 361   fe_pyneg,                             /* @nb_negative@ */
 362   fe_pyid,                              /* @nb_positive@ */
 363   0,                                    /* @nb_absolute@ */
 364   fe_pynonzerop,                        /* @nb_nonzero@ */
 365   0,                                    /* @nb_invert@ */
 366   0,                                    /* @nb_lshift@ */
 367   0,                                    /* @nb_rshift@ */
 368   0,                                    /* @nb_and@ */
 369   0,                                    /* @nb_xor@ */
 370   0,                                    /* @nb_or@ */
 371   fe_pycoerce,                          /* @nb_coerce@ */
 372   fe_pyint,                             /* @nb_int@ */
 373   fe_pylong,                            /* @nb_long@ */
 374   0 /* meaningless */,                  /* @nb_float@ */
 375   fe_pyoct,                             /* @nb_oct@ */
 376   fe_pyhex,                             /* @nb_hex@ */
 377
 378   0,                                    /* @nb_inplace_add@ */
 379   0,                                    /* @nb_inplace_subtract@ */
 380   0,                                    /* @nb_inplace_multiply@ */
 381   0,                                    /* @nb_inplace_divide@ */
 382   0,                                    /* @nb_inplace_remainder@ */
 383   0,                                    /* @nb_inplace_power@ */
 384   0,                                    /* @nb_inplace_lshift@ */
 385   0,                                    /* @nb_inplace_rshift@ */
 386   0,                                    /* @nb_inplace_and@ */
 387   0,                                    /* @nb_inplace_xor@ */
 388   0,                                    /* @nb_inplace_or@ */
 389
 390   0,                                    /* @nb_floor_divide@ */
 391   fe_pydiv,                             /* @nb_true_divide@ */
 392   0,                                    /* @nb_inplace_floor_divide@ */
 393   0,                                    /* @nb_inplace_true_divide@ */
 394
 395   fe_pyint,                             /* @nb_index@ */
 396 };
 397
 398 static const PyTypeObject fe_pytype_skel = {
 399   PyVarObject_HEAD_INIT(0, 0)           /* Header */
 400   "FE",                                 /* @tp_name@ */
 401   sizeof(fe_pyobj),                     /* @tp_basicsize@ */
 402   0,                                    /* @tp_itemsize@ */
 403
 404   fe_pydealloc,                         /* @tp_dealloc@ */
 405   0,                                    /* @tp_print@ */
 406   0,                                    /* @tp_getattr@ */
 407   0,                                    /* @tp_setattr@ */
 408   0,                                    /* @tp_compare@ */
 409   0,                                    /* @tp_repr@ */
 410   PYNUMBER(fe),                         /* @tp_as_number@ */
 411   0,                                    /* @tp_as_sequence@ */
 412   0,                                    /* @tp_as_mapping@ */
 413   fe_pyhash,                            /* @tp_hash@ */
 414   0,                                    /* @tp_call@ */
 415   fe_pyhex,                             /* @tp_str@ */
 416   0,                                    /* @tp_getattro@ */
 417   0,                                    /* @tp_setattro@ */
 418   0,                                    /* @tp_as_buffer@ */
 419   Py_TPFLAGS_DEFAULT |                  /* @tp_flags@ */
 420     Py_TPFLAGS_CHECKTYPES |
 421     Py_TPFLAGS_BASETYPE,
 422
 423   /* @tp_doc@ */
 424   "Finite field elements, abstract base class.",
 425
 426   0,                                    /* @tp_traverse@ */
 427   0,                                    /* @tp_clear@ */
 428   fe_pyrichcompare,                     /* @tp_richcompare@ */
 429   0,                                    /* @tp_weaklistoffset@ */
 430   0,                                    /* @tp_iter@ */
 431   0,                                    /* @tp_iternext@ */
 432   PYMETHODS(fe),                        /* @tp_methods@ */
 433   PYMEMBERS(fe),                        /* @tp_members@ */
 434   PYGETSET(fe),                         /* @tp_getset@ */
 435   0,                                    /* @tp_base@ */
 436   0,                                    /* @tp_dict@ */
 437   0,                                    /* @tp_descr_get@ */
 438   0,                                    /* @tp_descr_set@ */
 439   0,                                    /* @tp_dictoffset@ */
 440   0,                                    /* @tp_init@ */
 441   PyType_GenericAlloc,                  /* @tp_alloc@ */
 442   abstract_pynew,                       /* @tp_new@ */
 443   0,                                    /* @tp_free@ */
 444   0                                     /* @tp_is_gc@ */
 445 };
 446
 447 /*----- Fields ------------------------------------------------------------*/
 448
 449 static PyObject *field_pyrichcompare(PyObject *x, PyObject *y, int op)
 450 {
 451   int b = field_samep(FIELD_F(x), FIELD_F(y));
 452   switch (op) {
 453     case Py_EQ: break;
 454     case Py_NE: b = !b;
 455     default: TYERR("can't order fields");
 456   }
 457   return (getbool(b));
 458 end:
 459   return (0);
 460 }
 461
 462 static PyObject *fmeth_rand(PyObject *me, PyObject *arg, PyObject *kw)
 463 {
 464   static const char *const kwlist[] = { "rng", 0 };
 465   grand *r = &rand_global;
 466
 467   if (!PyArg_ParseTupleAndKeywords(arg, kw, "|O&:rand", KWLIST,
 468                                    convgrand, &r))
 469     return (0);
 470   return (fe_pywrap(me, F_RAND(FIELD_F(me), MP_NEW, r)));
 471 }
 472
 473 static PyObject *fmeth__adopt(PyObject *me, PyObject *arg)
 474 {
 475   mp *xx;
 476   if (!PyArg_ParseTuple(arg, "O&:_adopt", convmp, &xx)) return (0);
 477   return (fe_pywrap(me, xx));
 478 }
 479
 480 static PyObject *fmeth_parse(PyObject *me, PyObject *arg)
 481 {
 482   field *f;
 483   char *p;
 484   PyObject *rc = 0;
 485   qd_parse qd;
 486
 487   if (!PyArg_ParseTuple(arg, "s:parse", &p)) goto end;
 488   qd.p = p; qd.e = 0;
 489   if ((f = field_parse(&qd)) == 0) VALERR(qd.e);
 490   rc = Py_BuildValue("(Ns)", field_pywrap(f), qd.p);
 491 end:
 492   return (rc);
 493 }
 494
 495 static void field_pydealloc(PyObject *me)
 496 {
 497   F_DESTROY(FIELD_F(me));
 498   PyType_Type.tp_dealloc(me);
 499 }
 500
 501 static PyObject *fget_zero(PyObject *me, void *hunoz)
 502   { return (fe_pywrap(me, MP_COPY(FIELD_F(me)->zero))); }
 503
 504 static PyObject *fget_one(PyObject *me, void *hunoz)
 505   { return (fe_pywrap(me, MP_COPY(FIELD_F(me)->one))); }
 506
 507 static PyObject *fget_q(PyObject *me, void *hunoz)
 508   { return (mp_pywrap(MP_COPY(FIELD_F(me)->q))); }
 509
 510 static PyObject *fget_nbits(PyObject *me, void *hunoz)
 511   { return (PyInt_FromLong(FIELD_F(me)->nbits)); }
 512
 513 static PyObject *fget_noctets(PyObject *me, void *hunoz)
 514   { return (PyInt_FromLong(FIELD_F(me)->noctets)); }
 515
 516 static PyObject *fget_name(PyObject *me, void *hunoz)
 517   { return (TEXT_FROMSTR(F_NAME(FIELD_F(me)))); }
 518
 519 static PyObject *fget_type(PyObject *me, void *hunoz)
 520   { return (PyInt_FromLong(F_TYPE(FIELD_F(me)))); }
 521
 522 static const PyGetSetDef field_pygetset[] = {
 523 #define GETSETNAME(op, name) f##op##_##name
 524   GET   (zero,          "F.zero -> field additive identity")
 525   GET   (one,           "F.one -> field multiplicative identity")
 526   GET   (q,             "F.q -> number of elements in field")
 527   GET   (nbits,         "F.nbits -> bits needed to represent element")
 528   GET   (noctets,       "F.noctets -> octetss needed to represent element")
 529   GET   (name,          "F.name -> name of this kind of field")
 530   GET   (type,          "F.type -> type code of this kind of field")
 531 #undef GETSETNAME
 532   { 0 }
 533 };
 534
 535 static const PyMethodDef field_pymethods[] = {
 536 #define METHNAME(name) fmeth_##name
 537   METH  (_adopt,        "F._adopt(X) -> FE")
 538   KWMETH(rand,          "F.rand([rng = rand]) -> FE, uniformly distributed")
 539   SMTH  (parse,         "parse(STR) -> F, REST")
 540 #undef METHNAME
 541   { 0 }
 542 };
 543
 544 static const PyTypeObject field_pytype_skel = {
 545   PyVarObject_HEAD_INIT(0, 0)           /* Header */
 546   "Field",                              /* @tp_name@ */
 547   sizeof(field_pyobj),                  /* @tp_basicsize@ */
 548   0,                                    /* @tp_itemsize@ */
 549
 550   field_pydealloc,                      /* @tp_dealloc@ */
 551   0,                                    /* @tp_print@ */
 552   0,                                    /* @tp_getattr@ */
 553   0,                                    /* @tp_setattr@ */
 554   0,                                    /* @tp_compare@ */
 555   0,                                    /* @tp_repr@ */
 556   0,                                    /* @tp_as_number@ */
 557   0,                                    /* @tp_as_sequence@ */
 558   0,                                    /* @tp_as_mapping@ */
 559   0,                                    /* @tp_hash@ */
 560   0,                                    /* @tp_call@ */
 561   0,                                    /* @tp_str@ */
 562   0,                                    /* @tp_getattro@ */
 563   0,                                    /* @tp_setattro@ */
 564   0,                                    /* @tp_as_buffer@ */
 565   Py_TPFLAGS_DEFAULT |                  /* @tp_flags@ */
 566     Py_TPFLAGS_BASETYPE,
 567
 568   /* @tp_doc@ */
 569   "An abstract field.  This is an abstract type.",
 570
 571   0,                                    /* @tp_traverse@ */
 572   0,                                    /* @tp_clear@ */
 573   field_pyrichcompare,                  /* @tp_richcompare@ */
 574   0,                                    /* @tp_weaklistoffset@ */
 575   0,                                    /* @tp_iter@ */
 576   0,                                    /* @tp_iternext@ */
 577   PYMETHODS(field),                     /* @tp_methods@ */
 578   0,                                    /* @tp_members@ */
 579   PYGETSET(field),                      /* @tp_getset@ */
 580   0,                                    /* @tp_base@ */
 581   0,                                    /* @tp_dict@ */
 582   0,                                    /* @tp_descr_get@ */
 583   0,                                    /* @tp_descr_set@ */
 584   0,                                    /* @tp_dictoffset@ */
 585   0,                                    /* @tp_init@ */
 586   PyType_GenericAlloc,                  /* @tp_alloc@ */
 587   abstract_pynew,                       /* @tp_new@ */
 588   0,                                    /* @tp_free@ */
 589   0                                     /* @tp_is_gc@ */
 590 };
 591
 592 /*----- Prime fields ------------------------------------------------------*/
 593
 594 static PyObject *primefield_pynew(PyTypeObject *ty,
 595                                   PyObject *arg, PyObject *kw)
 596 {
 597   mp *xx = 0;
 598   field *f;
 599   static const char *const kwlist[] = { "p", 0 };
 600
 601   if (!PyArg_ParseTupleAndKeywords(arg, kw, "O&:primefield", KWLIST,
 602                                    convmp, &xx))
 603     goto end;
 604   if ((f = field_prime(xx)) == 0)
 605     VALERR("bad prime for primefield");
 606   MP_DROP(xx);
 607   return (field_dopywrap(ty, f));
 608 end:
 609   mp_drop(xx);
 610   return (0);
 611 }
 612
 613 static PyObject *pfget_p(PyObject *me, void *hunoz)
 614   { return (mp_pywrap(MP_COPY(FIELD_F(me)->m))); }
 615
 616 static const PyGetSetDef primefield_pygetset[] = {
 617 #define GETSETNAME(op, name) pf##op##_##name
 618   GET   (p,             "F.p -> prime field characteristic")
 619 #undef GETSETNAME
 620 };
 621
 622 static const PyTypeObject primefield_pytype_skel = {
 623   PyVarObject_HEAD_INIT(0, 0)           /* Header */
 624   "PrimeField",                         /* @tp_name@ */
 625   sizeof(field_pyobj),                  /* @tp_basicsize@ */
 626   0,                                    /* @tp_itemsize@ */
 627
 628   field_pydealloc,                      /* @tp_dealloc@ */
 629   0,                                    /* @tp_print@ */
 630   0,                                    /* @tp_getattr@ */
 631   0,                                    /* @tp_setattr@ */
 632   0,                                    /* @tp_compare@ */
 633   0,                                    /* @tp_repr@ */
 634   0,                                    /* @tp_as_number@ */
 635   0,                                    /* @tp_as_sequence@ */
 636   0,                                    /* @tp_as_mapping@ */
 637   0,                                    /* @tp_hash@ */
 638   0,                                    /* @tp_call@ */
 639   0,                                    /* @tp_str@ */
 640   0,                                    /* @tp_getattro@ */
 641   0,                                    /* @tp_setattro@ */
 642   0,                                    /* @tp_as_buffer@ */
 643   Py_TPFLAGS_DEFAULT |                  /* @tp_flags@ */
 644     Py_TPFLAGS_BASETYPE,
 645
 646   /* @tp_doc@ */
 647   "PrimeField(P): prime fields.",
 648
 649   0,                                    /* @tp_traverse@ */
 650   0,                                    /* @tp_clear@ */
 651   0,                                    /* @tp_richcompare@ */
 652   0,                                    /* @tp_weaklistoffset@ */
 653   0,                                    /* @tp_iter@ */
 654   0,                                    /* @tp_iternext@ */
 655   0,                                    /* @tp_methods@ */
 656   0,                                    /* @tp_members@ */
 657   PYGETSET(primefield),                 /* @tp_getset@ */
 658   0,                                    /* @tp_base@ */
 659   0,                                    /* @tp_dict@ */
 660   0,                                    /* @tp_descr_get@ */
 661   0,                                    /* @tp_descr_set@ */
 662   0,                                    /* @tp_dictoffset@ */
 663   0,                                    /* @tp_init@ */
 664   PyType_GenericAlloc,                  /* @tp_alloc@ */
 665   primefield_pynew,                     /* @tp_new@ */
 666   0,                                    /* @tp_free@ */
 667   0                                     /* @tp_is_gc@ */
 668 };
 669
 670 static PyObject *niceprimefield_pynew(PyTypeObject *ty,
 671                                       PyObject *arg, PyObject *kw)
 672 {
 673   mp *xx = 0;
 674   field *f;
 675   static const char *const kwlist[] = { "p", 0 };
 676
 677   if (!PyArg_ParseTupleAndKeywords(arg, kw, "O&:niceprimefield",
 678                                    KWLIST, convmp, &xx))
 679     goto end;
 680   if ((f = field_niceprime(xx)) == 0)
 681     VALERR("bad prime for niceprimefield");
 682   MP_DROP(xx);
 683   return (field_dopywrap(ty, f));
 684 end:
 685   mp_drop(xx);
 686   return (0);
 687 }
 688
 689 static const PyTypeObject niceprimefield_pytype_skel = {
 690   PyVarObject_HEAD_INIT(0, 0)           /* Header */
 691   "NicePrimeField",                     /* @tp_name@ */
 692   sizeof(field_pyobj),                  /* @tp_basicsize@ */
 693   0,                                    /* @tp_itemsize@ */
 694
 695   field_pydealloc,                      /* @tp_dealloc@ */
 696   0,                                    /* @tp_print@ */
 697   0,                                    /* @tp_getattr@ */
 698   0,                                    /* @tp_setattr@ */
 699   0,                                    /* @tp_compare@ */
 700   0,                                    /* @tp_repr@ */
 701   0,                                    /* @tp_as_number@ */
 702   0,                                    /* @tp_as_sequence@ */
 703   0,                                    /* @tp_as_mapping@ */
 704   0,                                    /* @tp_hash@ */
 705   0,                                    /* @tp_call@ */
 706   0,                                    /* @tp_str@ */
 707   0,                                    /* @tp_getattro@ */
 708   0,                                    /* @tp_setattro@ */
 709   0,                                    /* @tp_as_buffer@ */
 710   Py_TPFLAGS_DEFAULT |                  /* @tp_flags@ */
 711     Py_TPFLAGS_BASETYPE,
 712
 713   /* @tp_doc@ */
 714   "NicePrimeField(P): prime field using Solinas reduction.",
 715
 716   0,                                    /* @tp_traverse@ */
 717   0,                                    /* @tp_clear@ */
 718   0,                                    /* @tp_richcompare@ */
 719   0,                                    /* @tp_weaklistoffset@ */
 720   0,                                    /* @tp_iter@ */
 721   0,                                    /* @tp_iternext@ */
 722   0,                                    /* @tp_methods@ */
 723   0,                                    /* @tp_members@ */
 724   0,                                    /* @tp_getset@ */
 725   0,                                    /* @tp_base@ */
 726   0,                                    /* @tp_dict@ */
 727   0,                                    /* @tp_descr_get@ */
 728   0,                                    /* @tp_descr_set@ */
 729   0,                                    /* @tp_dictoffset@ */
 730   0,                                    /* @tp_init@ */
 731   PyType_GenericAlloc,                  /* @tp_alloc@ */
 732   niceprimefield_pynew,                 /* @tp_new@ */
 733   0,                                    /* @tp_free@ */
 734   0                                     /* @tp_is_gc@ */
 735 };
 736
 737 /*----- Binary fields -----------------------------------------------------*/
 738
 739 static PyObject *bfget_m(PyObject *me, void *hunoz)
 740   { return (PyInt_FromLong(FIELD_F(me)->nbits)); }
 741
 742 static PyObject *bfget_p(PyObject *me, void *hunoz)
 743   { return (gf_pywrap(MP_COPY(FIELD_F(me)->m))); }
 744
 745 static const PyGetSetDef binfield_pygetset[] = {
 746 #define GETSETNAME(op, name) bf##op##_##name
 747   GET   (m,             "F.m -> field polynomial degree")
 748   GET   (p,             "F.p -> field polynomial")
 749 #undef GETSETNAME
 750   { 0 }
 751 };
 752
 753 static const PyTypeObject binfield_pytype_skel = {
 754   PyVarObject_HEAD_INIT(0, 0)           /* Header */
 755   "BinField",                           /* @tp_name@ */
 756   sizeof(field_pyobj),                  /* @tp_basicsize@ */
 757   0,                                    /* @tp_itemsize@ */
 758
 759   field_pydealloc,                      /* @tp_dealloc@ */
 760   0,                                    /* @tp_print@ */
 761   0,                                    /* @tp_getattr@ */
 762   0,                                    /* @tp_setattr@ */
 763   0,                                    /* @tp_compare@ */
 764   0,                                    /* @tp_repr@ */
 765   0,                                    /* @tp_as_number@ */
 766   0,                                    /* @tp_as_sequence@ */
 767   0,                                    /* @tp_as_mapping@ */
 768   0,                                    /* @tp_hash@ */
 769   0,                                    /* @tp_call@ */
 770   0,                                    /* @tp_str@ */
 771   0,                                    /* @tp_getattro@ */
 772   0,                                    /* @tp_setattro@ */
 773   0,                                    /* @tp_as_buffer@ */
 774   Py_TPFLAGS_DEFAULT |                  /* @tp_flags@ */
 775     Py_TPFLAGS_BASETYPE,
 776
 777   /* @tp_doc@ */
 778   "Binary fields.  Abstract class.",
 779
 780   0,                                    /* @tp_traverse@ */
 781   0,                                    /* @tp_clear@ */
 782   0,                                    /* @tp_richcompare@ */
 783   0,                                    /* @tp_weaklistoffset@ */
 784   0,                                    /* @tp_iter@ */
 785   0,                                    /* @tp_iternext@ */
 786   0,                                    /* @tp_methods@ */
 787   0,                                    /* @tp_members@ */
 788   PYGETSET(binfield),                   /* @tp_getset@ */
 789   0,                                    /* @tp_base@ */
 790   0,                                    /* @tp_dict@ */
 791   0,                                    /* @tp_descr_get@ */
 792   0,                                    /* @tp_descr_set@ */
 793   0,                                    /* @tp_dictoffset@ */
 794   0,                                    /* @tp_init@ */
 795   PyType_GenericAlloc,                  /* @tp_alloc@ */
 796   abstract_pynew,                       /* @tp_new@ */
 797   0,                                    /* @tp_free@ */
 798   0                                     /* @tp_is_gc@ */
 799 };
 800
 801 static PyObject *binpolyfield_pynew(PyTypeObject *ty,
 802                                     PyObject *arg, PyObject *kw)
 803 {
 804   mp *xx = 0;
 805   field *f;
 806   static const char *const kwlist[] = { "p", 0 };
 807
 808   if (!PyArg_ParseTupleAndKeywords(arg, kw, "O&:binpolyfield", KWLIST,
 809                                    convgf, &xx))
 810     goto end;
 811   if ((f = field_binpoly(xx)) == 0) VALERR("bad poly for binpolyfield");
 812   MP_DROP(xx);
 813   return (field_dopywrap(ty, f));
 814 end:
 815   mp_drop(xx);
 816   return (0);
 817 }
 818
 819 static const PyTypeObject binpolyfield_pytype_skel = {
 820   PyVarObject_HEAD_INIT(0, 0)           /* Header */
 821   "BinPolyField",                       /* @tp_name@ */
 822   sizeof(field_pyobj),                  /* @tp_basicsize@ */
 823   0,                                    /* @tp_itemsize@ */
 824
 825   field_pydealloc,                      /* @tp_dealloc@ */
 826   0,                                    /* @tp_print@ */
 827   0,                                    /* @tp_getattr@ */
 828   0,                                    /* @tp_setattr@ */
 829   0,                                    /* @tp_compare@ */
 830   0,                                    /* @tp_repr@ */
 831   0,                                    /* @tp_as_number@ */
 832   0,                                    /* @tp_as_sequence@ */
 833   0,                                    /* @tp_as_mapping@ */
 834   0,                                    /* @tp_hash@ */
 835   0,                                    /* @tp_call@ */
 836   0,                                    /* @tp_str@ */
 837   0,                                    /* @tp_getattro@ */
 838   0,                                    /* @tp_setattro@ */
 839   0,                                    /* @tp_as_buffer@ */
 840   Py_TPFLAGS_DEFAULT |                  /* @tp_flags@ */
 841     Py_TPFLAGS_BASETYPE,
 842
 843   /* @tp_doc@ */
 844   "BinPolyField(P): binary fields with polynomial basis representation.",
 845
 846   0,                                    /* @tp_traverse@ */
 847   0,                                    /* @tp_clear@ */
 848   0,                                    /* @tp_richcompare@ */
 849   0,                                    /* @tp_weaklistoffset@ */
 850   0,                                    /* @tp_iter@ */
 851   0,                                    /* @tp_iternext@ */
 852   0,                                    /* @tp_methods@ */
 853   0,                                    /* @tp_members@ */
 854   0,                                    /* @tp_getset@ */
 855   0,                                    /* @tp_base@ */
 856   0,                                    /* @tp_dict@ */
 857   0,                                    /* @tp_descr_get@ */
 858   0,                                    /* @tp_descr_set@ */
 859   0,                                    /* @tp_dictoffset@ */
 860   0,                                    /* @tp_init@ */
 861   PyType_GenericAlloc,                  /* @tp_alloc@ */
 862   binpolyfield_pynew,                   /* @tp_new@ */
 863   0,                                    /* @tp_free@ */
 864   0                                     /* @tp_is_gc@ */
 865 };
 866
 867 static PyObject *binnormfield_pynew(PyTypeObject *ty,
 868                                     PyObject *arg, PyObject *kw)
 869 {
 870   mp *xx = 0, *yy = 0;
 871   field *f;
 872   static const char *const kwlist[] = { "p", "beta", 0 };
 873
 874   if (!PyArg_ParseTupleAndKeywords(arg, kw, "O&O&:binnormfield",
 875                                    KWLIST, convgf, &xx, convgf, &yy))
 876     goto end;
 877   if ((f = field_binnorm(xx, yy)) == 0) VALERR("bad args for binnormfield");
 878   MP_DROP(xx); MP_DROP(yy);
 879   return (field_dopywrap(ty, f));
 880 end:
 881   mp_drop(xx); mp_drop(yy);
 882   return (0);
 883 }
 884
 885 static PyObject *bnfget_beta(PyObject *me, void *hunoz)
 886 {
 887   fctx_binnorm *fc = (fctx_binnorm *)FIELD_F(me);
 888   return (gf_pywrap(MP_COPY(fc->ntop.r[fc->ntop.n - 1])));
 889 }
 890
 891 static const PyGetSetDef binnormfield_pygetset[] = {
 892 #define GETSETNAME(op, name) bnf##op##_##name
 893   GET   (beta,          "F.beta -> conversion factor")
 894 #undef GETSETNAME
 895   { 0 }
 896 };
 897
 898 static const PyTypeObject binnormfield_pytype_skel = {
 899   PyVarObject_HEAD_INIT(0, 0)           /* Header */
 900   "BinNormField",                       /* @tp_name@ */
 901   sizeof(field_pyobj),                  /* @tp_basicsize@ */
 902   0,                                    /* @tp_itemsize@ */
 903
 904   field_pydealloc,                      /* @tp_dealloc@ */
 905   0,                                    /* @tp_print@ */
 906   0,                                    /* @tp_getattr@ */
 907   0,                                    /* @tp_setattr@ */
 908   0,                                    /* @tp_compare@ */
 909   0,                                    /* @tp_repr@ */
 910   0,                                    /* @tp_as_number@ */
 911   0,                                    /* @tp_as_sequence@ */
 912   0,                                    /* @tp_as_mapping@ */
 913   0,                                    /* @tp_hash@ */
 914   0,                                    /* @tp_call@ */
 915   0,                                    /* @tp_str@ */
 916   0,                                    /* @tp_getattro@ */
 917   0,                                    /* @tp_setattro@ */
 918   0,                                    /* @tp_as_buffer@ */
 919   Py_TPFLAGS_DEFAULT |                  /* @tp_flags@ */
 920     Py_TPFLAGS_BASETYPE,
 921
 922   /* @tp_doc@ */
 923   "BinNormField(P, BETA): binary fields with normal basis representation.",
 924
 925   0,                                    /* @tp_traverse@ */
 926   0,                                    /* @tp_clear@ */
 927   0,                                    /* @tp_richcompare@ */
 928   0,                                    /* @tp_weaklistoffset@ */
 929   0,                                    /* @tp_iter@ */
 930   0,                                    /* @tp_iternext@ */
 931   0,                                    /* @tp_methods@ */
 932   0,                                    /* @tp_members@ */
 933   PYGETSET(binnormfield),               /* @tp_getset@ */
 934   0,                                    /* @tp_base@ */
 935   0,                                    /* @tp_dict@ */
 936   0,                                    /* @tp_descr_get@ */
 937   0,                                    /* @tp_descr_set@ */
 938   0,                                    /* @tp_dictoffset@ */
 939   0,                                    /* @tp_init@ */
 940   PyType_GenericAlloc,                  /* @tp_alloc@ */
 941   binnormfield_pynew,                   /* @tp_new@ */
 942   0,                                    /* @tp_free@ */
 943   0                                     /* @tp_is_gc@ */
 944 };
 945
 946 /*----- Setup -------------------------------------------------------------*/
 947
 948 static const struct nameval consts[] = {
 949   CONST(FTY_PRIME), CONST(FTY_BINARY),
 950   { 0 }
 951 };
 952
 953 void field_pyinit(void)
 954 {
 955   INITTYPE(fe, root);
 956   INITTYPE(field, type);
 957   INITTYPE(primefield, field);
 958   INITTYPE(niceprimefield, primefield);
 959   INITTYPE(binfield, field);
 960   INITTYPE(binpolyfield, binfield);
 961   INITTYPE(binnormfield, binfield);
 962 }
 963
 964 void field_pyinsert(PyObject *mod)
 965 {
 966   INSERT("FE", fe_pytype);
 967   INSERT("Field", field_pytype);
 968   INSERT("PrimeField", primefield_pytype);
 969   INSERT("NicePrimeField", niceprimefield_pytype);
 970   INSERT("BinField", binfield_pytype);
 971   INSERT("BinPolyField", binpolyfield_pytype);
 972   INSERT("BinNormField", binnormfield_pytype);
 973   setconstants(mod, consts);
 974 }
 975
 976 /*----- That's all, folks -------------------------------------------------*/