Expunge revision histories in files.
[u/mdw/catacomb] / field.h
diff --git a/field.h b/field.h
index 8096700..5790284 100644 (file)
--- a/field.h
+++ b/field.h
@@ -1,6 +1,6 @@
 /* -*-c-*-
  *
- * $Id: field.h,v 1.3.4.1 2004/03/20 00:13:31 mdw Exp $
+ * $Id: field.h,v 1.11 2004/04/08 01:36:15 mdw Exp $
  *
  * Definitions for field arithmetic
  *
  * MA 02111-1307, USA.
  */
 
-/*----- Revision history --------------------------------------------------* 
- *
- * $Log: field.h,v $
- * Revision 1.3.4.1  2004/03/20 00:13:31  mdw
- * Projective coordinates for prime curves
- *
- * Revision 1.3  2002/01/13 13:48:44  mdw
- * Further progress.
- *
- * Revision 1.2  2001/05/07 17:30:13  mdw
- * Add an internal-representation no-op function.
- *
- * Revision 1.1  2001/04/29 18:12:33  mdw
- * Prototype version.
- *
- */
-
 #ifndef CATACOMB_FIELD_H
 #define CATACOMB_FIELD_H
 
 
 /*----- Header files ------------------------------------------------------*/
 
+#ifndef CATACOMB_GRAND_H
+#  include "grand.h"
+#endif
+
 #ifndef CATACOMB_MP_H
 #  include "mp.h"
 #endif
 
+#ifndef CATACOMB_QDPARSE_H
+#  include "qdparse.h"
+#endif
+
 /*----- Data structures ---------------------------------------------------*/
 
 typedef struct field {
   const struct field_ops *ops;         /* Field operations */
   mp *zero, *one;                      /* Identities in the field */
+  mp *m;                               /* Modulus (prime and binary) */
+  unsigned long nbits;                 /* Length of field element in bits */
+  size_t noctets;                      /* Length of element in octets */
 } field;
 
+enum {
+  FTY_PRIME,
+  FTY_BINARY
+};
+
 typedef struct field_ops {
 
+  /* --- General information --- */
+
+  unsigned ty;                         /* What kind of field this is */
+  const char *name;                    /* Human-readable name string */
+
   /* --- Universal operations --- */
 
   void (*destroy)(field */*f*/);
+  mp *(*rand)(field */*f*/, mp */*d*/, grand */*r*/);
+  int (*samep)(field */*f*/, field */*g*/);
 
   mp *(*in)(field */*f*/, mp */*d*/, mp */*x*/);
   mp *(*out)(field */*f*/, mp */*d*/, mp */*x*/);
@@ -81,6 +87,11 @@ typedef struct field_ops {
   mp *(*sqr)(field */*f*/, mp */*d*/, mp */*x*/);
   mp *(*inv)(field */*f*/, mp */*d*/, mp */*x*/);
   mp *(*reduce)(field */*f*/, mp */*d*/, mp */*x*/);
+  mp *(*sqrt)(field */*f*/, mp */*d*/, mp */*x*/);
+
+  /* --- Operations for binary fields only --- */
+
+  mp *(*quadsolve)(field */*f*/, mp */*d*/, mp */*x*/);
 
   /* --- Operations for prime fields only --- */
 
@@ -88,11 +99,15 @@ typedef struct field_ops {
   mp *(*tpl)(field */*f*/, mp */*d*/, mp */*x*/);
   mp *(*qdl)(field */*f*/, mp */*d*/, mp */*x*/);
   mp *(*hlv)(field */*f*/, mp */*d*/, mp */*x*/);
-  mp *(*sqrt)(field */*f*/, mp */*d*/, mp */*x*/);
 
 } field_ops;
 
+#define F_TYPE(f)              (f)->ops->ty
+#define F_NAME(f)              (f)->ops->name
+
 #define F_DESTROY(f)           (f)->ops->destroy((f))
+#define F_RAND(f, d, r)                (f)->ops->rand((f), (d), (r))
+#define F_SAMEP(f, g)          (f)->ops->samep((f), (g))
 
 #define F_IN(f, d, x)          (f)->ops->in((f), (d), (x))
 #define F_OUT(f, d, x)         (f)->ops->out((f), (d), (x))
@@ -105,12 +120,14 @@ typedef struct field_ops {
 #define F_SQR(f, d, x)         (f)->ops->sqr((f), (d), (x))
 #define F_INV(f, d, x)         (f)->ops->inv((f), (d), (x))
 #define F_REDUCE(f, d, x)      (f)->ops->reduce((f), (d), (x))
+#define F_SQRT(f, d, x)                (f)->ops->sqrt((f), (d), (x))
+
+#define F_QUADSOLVE(f, d, x)   (f)->ops->quadsolve((f), (d), (x))
 
 #define F_DBL(f, d, x)         (f)->ops->dbl((f), (d), (x))
 #define F_TPL(f, d, x)         (f)->ops->tpl((f), (d), (x))
 #define F_QDL(f, d, x)         (f)->ops->qdl((f), (d), (x))
 #define F_HLV(f, d, x)         (f)->ops->hlv((f), (d), (x))
-#define F_SQRT(f, d, x)                (f)->ops->sqrt((f), (d), (x))
 
 /*----- Helpful field operations ------------------------------------------*/
 
@@ -128,6 +145,31 @@ typedef struct field_ops {
 
 extern mp *field_id(field */*f*/, mp */*d*/, mp */*x*/);
 
+/* --- @field_samep@ --- *
+ *
+ * Arguments:  @field *f, *g@ = two fields
+ *
+ * Returns:    Nonzero if the fields are identical (not just isomorphic).
+ *
+ * Use:                Checks for sameness of fields.  This function does the full
+ *             check, not just the field-type-specific check done by the
+ *             @sampep@ field operation.
+ */
+
+extern int field_samep(field */*f*/, field */*g*/);
+
+/* --- @field_stdsamep@ --- *
+ *
+ * Arguments:  @field *f, *g@ = two fields
+ *
+ * Returns:    Nonzero if the fields are identical (not just isomorphic).
+ *
+ * Use:                Standard sameness check, based on equality of the @m@
+ *             member.
+ */
+
+extern int field_stdsamep(field */*f*/, field */*g*/);
+
 /*----- Creating fields ---------------------------------------------------*/
 
 /* --- @field_prime@ --- *
@@ -142,6 +184,18 @@ extern mp *field_id(field */*f*/, mp */*d*/, mp */*x*/);
 
 extern field *field_prime(mp */*p*/);
 
+/* --- @field_niceprime@ --- *
+ *
+ * Arguments:  @mp *p@ = the characteristic of the field
+ *
+ * Returns:    A pointer to the field.
+ *
+ * Use:                Creates a field structure for a prime field of size %$p$%,
+ *             using efficient reduction for nice primes.
+ */
+
+extern field *field_niceprime(mp */*p*/);
+
 /* --- @field_binpoly@ --- *
  *
  * Arguments:  @mp *p@ = an irreducible polynomial over %$\gf{2}$%
@@ -154,19 +208,35 @@ extern field *field_prime(mp */*p*/);
 
 extern field *field_binpoly(mp */*p*/);
 
-/* --- @field_binsparsepoly@ --- *
+/* --- @field_binnorm@ --- *
  *
- * Arguments:  @unsigned deg@ = the degree of the field polynomial
- *             @const unsigned *c@ = degrees of nonzero coefficients
+ * Arguments:  @mp *p@ = the reduction polynomial
+ *             @mp *beta@ = representation of normal point
  *
  * Returns:    A pointer to the field.
  *
- * Use:                Creates a field structure for a binary field taking advantage
- *             of the sparseness of the given polynomial to improve
- *             reduction performance.
+ * Use:                Creates a field structure for a binary field mod @p@ which
+ *             uses a normal basis representation externally.  Computations
+ *             are still done on a polynomial-basis representation.
+ */
+
+extern field *field_binnorm(mp */*p*/, mp */*beta*/);
+
+/* --- @field_parse@ --- *
+ *
+ * Arguments:  @qd_parse *qd@ = parser context
+ *
+ * Returns:    Field pointer if OK, or null.
+ *
+ * Use:                Parses a field description, which has the form
+ *
+ *               * `prime', `niceprime', `binpoly', or `binnorm'
+ *               * an optional `:'
+ *               * the field modulus
+ *               * for `binnorm', an optional `,' and the beta value
  */
 
-extern field *field_binsparsepoly(unsigned /*deg*/, const unsigned */*c*/);
+extern field *field_parse(qd_parse */*qd*/);
 
 /*----- That's all, folks -------------------------------------------------*/