General utilities cleanup. Add signature support to catcrypt. Throw in
[u/mdw/catacomb] / mprand.h
index 2ecfa15..ea5d521 100644 (file)
--- a/mprand.h
+++ b/mprand.h
@@ -1,6 +1,6 @@
 /* -*-c-*-
  *
- * $Id: mprand.h,v 1.1 1999/12/10 23:23:05 mdw Exp $
+ * $Id: mprand.h,v 1.3 2004/04/08 01:36:15 mdw Exp $
  *
  * Generate a random multiprecision integer
  *
  * MA 02111-1307, USA.
  */
 
-/*----- Revision history --------------------------------------------------* 
- *
- * $Log: mprand.h,v $
- * Revision 1.1  1999/12/10 23:23:05  mdw
- * Support for generating random large integers.
- *
- */
-
 #ifndef CATACOMB_MPRAND_H
 #define CATACOMB_MPRAND_H
 
 
 extern mp *mprand(mp */*d*/, unsigned /*b*/, grand */*r*/, mpw /*or*/);
 
+/* --- @mprand_range@ --- *
+ *
+ * Arguments:  @mp *d@ = destination integer
+ *             @mp *l@ = limit for random number
+ *             @grand *r@ = random number source
+ *             @mpw or@ = mask for low-order bits
+ *
+ * Returns:    A pseudorandom integer, unformly distributed over the
+ *             interval %$[0, l)$%.
+ *
+ * Use:                Generates a uniformly-distributed pseudorandom number in the
+ *             appropriate range.
+ */
+
+extern mp *mprand_range(mp */*d*/, mp */*l*/, grand */*r*/, mpw /*or*/);
+
 /*----- That's all, folks -------------------------------------------------*/
 
 #ifdef __cplusplus