A variety of small tweaks and fixes. Make mpmont etc. return errors

[u/mdw/catacomb] / mpbarrett.h

diff --git a/mpbarrett.h b/mpbarrett.h
index eaec41d..bb8b36a 100644 (file)
--- a/mpbarrett.h
+++ b/mpbarrett.h
@@ -1,6 +1,6 @@
 /* -*-c-*-
  *
- * $Id: mpbarrett.h,v 1.3 2001/06/16 12:58:47 mdw Exp $
+ * $Id$
  *
  * Barrett modular reduction
  *
@@ -27,20 +27,6 @@
  * MA 02111-1307, USA.
  */
 
-/*----- Revision history --------------------------------------------------* 
- *
- * $Log: mpbarrett.h,v $
- * Revision 1.3  2001/06/16 12:58:47  mdw
- * Added simultaneous exponentiation with Barrett reduction.
- *
- * Revision 1.2  2000/10/08 12:03:44  mdw
- * (mpbarrett_reduce): Cope with negative numbers.
- *
- * Revision 1.1  1999/12/10 23:22:00  mdw
- * Barrett reduction support: works with even moduli.
- *
- */
-
 /*----- Notes on Barrett reduction ----------------------------------------*
  *
  * Barrett reduction is a technique for computing modular residues.  Unlike
@@ -86,13 +72,12 @@ typedef struct mpbarrett {
  * Arguments:  @mpbarrett *mb@ = pointer to Barrett reduction context
  *             @mp *m@ = modulus to work to
  *
- *
- * Returns:    ---
+ * Returns:    Zero on success, nonzero on error.
  *
  * Use:                Initializes a Barrett reduction context ready for use.
  */
 
-extern void mpbarrett_create(mpbarrett */*mb*/, mp */*m*/);
+extern int mpbarrett_create(mpbarrett */*mb*/, mp */*m*/);
 
 /* --- @mpbarrett_destroy@ --- *
  *
@@ -136,7 +121,7 @@ extern mp *mpbarrett_exp(mpbarrett */*mb*/, mp */*d*/, mp */*a*/, mp */*e*/);
  *
  * Arguments:  @mpbarrett *mb@ = pointer to Barrett reduction context
  *             @mp *d@ = fake destination
- *             @mp_expfactor *f@ = pointer to array of factors
+ *             @const mp_expfactor *f@ = pointer to array of factors
  *             @size_t n@ = number of factors supplied
  *
  * Returns:    If the bases are %$g_0, g_1, \ldots, g_{n-1}$% and the
@@ -147,7 +132,7 @@ extern mp *mpbarrett_exp(mpbarrett */*mb*/, mp */*d*/, mp */*a*/, mp */*e*/);
  */
 
 extern mp *mpbarrett_mexp(mpbarrett */*mb*/, mp */*d*/,
-                         mp_expfactor */*f*/, size_t /*n*/);
+                         const mp_expfactor */*f*/, size_t /*n*/);
 
 /*----- That's all, folks -------------------------------------------------*/