X-Git-Url: https://git.distorted.org.uk/u/mdw/catacomb/blobdiff_plain/b817bfc642225b8c3c0b6a7e42d1fb949b61a606..18b3351a3791f19a63c0af05640719db8eb5d184:/mpreduce.h

diff --git a/mpreduce.h b/mpreduce.h
index c885ccb..80037d1 100644
--- a/mpreduce.h
+++ b/mpreduce.h
@@ -1,13 +1,13 @@
 /* -*-c-*-
  *
- * $Id: mpreduce.h,v 1.2 2004/04/08 01:36:15 mdw Exp $
+ * $Id$
  *
  * Efficient reduction modulo nice primes
  *
  * (c) 2004 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,
@@ -66,12 +66,12 @@ typedef struct mpreduce {
  * Arguments:	@gfreduce *r@ = structure to fill in
  *		@mp *x@ = an integer
  *
- * Returns:	---
+ * Returns:	Zero for success, nonzero on error.
  *
  * Use:		Initializes a context structure for reduction.
  */
 
-extern void mpreduce_create(mpreduce */*r*/, mp */*p*/);
+extern int mpreduce_create(mpreduce */*r*/, mp */*p*/);
 
 /* --- @mpreduce_destroy@ --- *
  *
@@ -110,11 +110,11 @@ extern mp *mpreduce_do(mpreduce */*r*/, mp */*d*/, mp */*x*/);
 /* --- @mpreduce_exp@ --- *
  *
  * Arguments:	@mpreduce *mr@ = pointer to 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 *mpreduce_exp(mpreduce */*mr*/, mp */*d*/, mp */*a*/, mp */*e*/);