Pollard's rho algorithm for computing discrete logs.

[u/mdw/catacomb] / rabin.h

diff --git a/rabin.h b/rabin.h
index ed08aeb..d57efcd 100644 (file)
--- a/rabin.h
+++ b/rabin.h
@@ -1,6 +1,6 @@
 /* -*-c-*-
  *
- * $Id: rabin.h,v 1.1 1999/11/19 13:17:57 mdw Exp $
+ * $Id: rabin.h,v 1.5 2000/07/09 21:32:16 mdw Exp $
  *
  * Miller-Rabin primality test
  *
@@ -30,13 +30,26 @@
 /*----- Revision history --------------------------------------------------* 
  *
  * $Log: rabin.h,v $
+ * Revision 1.5  2000/07/09 21:32:16  mdw
+ * rabin_test: Correct error in comment.
+ *
+ * Revision 1.4  2000/06/17 11:52:48  mdw
+ * Typesetting fix.
+ *
+ * Revision 1.3  1999/12/22 15:50:29  mdw
+ * Reworking for new prime-search system.  Add function for working out how
+ * many iterations to use for a particular number.
+ *
+ * Revision 1.2  1999/12/10 23:29:48  mdw
+ * Change header file guard names.
+ *
  * Revision 1.1  1999/11/19 13:17:57  mdw
  * Prime number generator and tester.
  *
  */
 
-#ifndef RABIN_H
-#define RABIN_H
+#ifndef CATACOMB_RABIN_H
+#define CATACOMB_RABIN_H
 
 #ifdef __cplusplus
   extern "C" {
@@ -44,16 +57,16 @@
 
 /*----- Header files ------------------------------------------------------*/
 
-#ifndef MP_H
+#ifndef CATACOMB_MP_H
 #  include "mp.h"
 #endif
 
-#ifndef MPMONT_H
+#ifndef CATACOMB_MPMONT_H
 #  include "mpmont.h"
 #endif
 
-#ifndef PGEN_H
-#  include "pgen.h"
+#ifndef CATACOMB_PFILT_H
+#  include "pfilt.h"
 #endif
 
 /*----- Data structures ---------------------------------------------------*/
@@ -62,7 +75,7 @@ typedef struct rabin {
   mpmont mm;                           /* Montgomery arithmetic context */
   size_t s;                            /* %$m = 2^s r + 1$% */
   mp *r;                               /* %$m = 2^s r + 1$% */
-  mp *m1;                              /* %$(m - 1)R \bmod m */
+  mp *m1;                              /* %$(m - 1)R \bmod m$% */
 } rabin;
 
 /*----- Functions provided ------------------------------------------------*/
@@ -97,7 +110,7 @@ extern void rabin_destroy(rabin */*r*/);
  * Arguments:  @rabin *r@ = pointer to Rabin-Miller context
  *             @mp *g@ = base to test the number against
  *
- * Returns:    Either @PGEN_COMPOSITE@ if the test failed, or @PGEN_MAYBE@
+ * Returns:    Either @PGEN_FAIL@ if the test failed, or @PGEN_PASS@
  *             if it succeeded.
  *
  * Use:                Performs a single iteration of the Rabin-Miller primality
@@ -106,6 +119,18 @@ extern void rabin_destroy(rabin */*r*/);
 
 extern int rabin_test(rabin */*r*/, mp */*g*/);
 
+/* --- @rabin_iters@ --- *
+ *
+ * Arguments:  @unsigned len@ = number of bits in value
+ *
+ * Returns:    Number of iterations recommended.
+ *
+ * Use:                Returns the recommended number of iterations to ensure that a
+ *             number with @len@ bits is really prime.
+ */
+
+extern int rabin_iters(unsigned /*len*/);
+
 /*----- That's all, folks -------------------------------------------------*/
 
 #ifdef __cplusplus