ct.c, ct.h: New constant-time operations.

[u/mdw/catacomb] / mpbarrett.h

diff --git a/mpbarrett.h b/mpbarrett.h
index 85c4a14..71d9ba7 100644 (file)
--- a/mpbarrett.h
+++ b/mpbarrett.h
@@ -1,13 +1,13 @@
 /* -*-c-*-
  *
- * $Id: mpbarrett.h,v 1.5 2004/04/08 01:36:15 mdw Exp $
+ * $Id$
  *
  * Barrett modular reduction
  *
  * (c) 1999 Straylight/Edgeware
  */
 
-/*----- Licensing notice --------------------------------------------------* 
+/*----- Licensing notice --------------------------------------------------*
  *
  * This file is part of Catacomb.
  *
@@ -15,12 +15,12 @@
  * it under the terms of the GNU Library General Public License as
  * published by the Free Software Foundation; either version 2 of the
  * License, or (at your option) any later version.
- * 
+ *
  * Catacomb is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU Library General Public License for more details.
- * 
+ *
  * You should have received a copy of the GNU Library General Public
  * License along with Catacomb; if not, write to the Free
  * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
@@ -72,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@ --- *
  *
@@ -109,11 +108,11 @@ extern mp *mpbarrett_reduce(mpbarrett */*mb*/, mp */*d*/, mp */*m*/);
 /* --- @mpbarrett_exp@ --- *
  *
  * Arguments:  @mpbarrett *mb@ = pointer to Barrett reduction context
- *              @mp *d@ = fake destination
- *              @mp *a@ = base
- *              @mp *e@ = exponent
+ *             @mp *d@ = fake destination
+ *             @mp *a@ = base
+ *             @mp *e@ = exponent
  *
- * Returns:     Result, %$a^e \bmod m$%.
+ * Returns:    Result, %$a^e \bmod m$%.
  */
 
 extern mp *mpbarrett_exp(mpbarrett */*mb*/, mp */*d*/, mp */*a*/, mp */*e*/);