/* -*-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
*
* (c) 1999 Straylight/Edgeware
*/
-/*----- Licensing notice --------------------------------------------------*
+/*----- Licensing notice --------------------------------------------------*
*
* This file is part of Catacomb.
*
* 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,
* 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