893c6259 |
1 | /* -*-c-*- |
2 | * |
743cef23 |
3 | * $Id: mprand.h,v 1.2 1999/12/22 15:55:43 mdw Exp $ |
893c6259 |
4 | * |
5 | * Generate a random multiprecision integer |
6 | * |
7 | * (c) 1999 Straylight/Edgeware |
8 | */ |
9 | |
10 | /*----- Licensing notice --------------------------------------------------* |
11 | * |
12 | * This file is part of Catacomb. |
13 | * |
14 | * Catacomb is free software; you can redistribute it and/or modify |
15 | * it under the terms of the GNU Library General Public License as |
16 | * published by the Free Software Foundation; either version 2 of the |
17 | * License, or (at your option) any later version. |
18 | * |
19 | * Catacomb is distributed in the hope that it will be useful, |
20 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
21 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
22 | * GNU Library General Public License for more details. |
23 | * |
24 | * You should have received a copy of the GNU Library General Public |
25 | * License along with Catacomb; if not, write to the Free |
26 | * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, |
27 | * MA 02111-1307, USA. |
28 | */ |
29 | |
30 | /*----- Revision history --------------------------------------------------* |
31 | * |
32 | * $Log: mprand.h,v $ |
743cef23 |
33 | * Revision 1.2 1999/12/22 15:55:43 mdw |
34 | * Add `mprand_range'. |
35 | * |
893c6259 |
36 | * Revision 1.1 1999/12/10 23:23:05 mdw |
37 | * Support for generating random large integers. |
38 | * |
39 | */ |
40 | |
41 | #ifndef CATACOMB_MPRAND_H |
42 | #define CATACOMB_MPRAND_H |
43 | |
44 | #ifdef __cplusplus |
45 | extern "C" { |
46 | #endif |
47 | |
48 | /*----- Header files ------------------------------------------------------*/ |
49 | |
50 | #ifndef CATACOMB_GRAND_H |
51 | # include "grand.h" |
52 | #endif |
53 | |
54 | #ifndef CATACOMB_MP_H |
55 | # include "mp.h" |
56 | #endif |
57 | |
58 | /*----- Functions provided ------------------------------------------------*/ |
59 | |
60 | /* --- @mprand@ --- * |
61 | * |
62 | * Arguments: @mp *d@ = destination integer |
63 | * @unsigned b@ = number of bits |
64 | * @grand *r@ = pointer to random number source |
65 | * @mpw or@ = mask to OR with low-order bits |
66 | * |
67 | * Returns: A random integer with the requested number of bits |
68 | * |
69 | * Use: Constructs an arbitrarily large pseudorandom integer. |
70 | * Assuming that the generator @r@ is good, the result is |
71 | * uniformly distributed in the interval %$[2^{b - 1}, 2^b)$%. |
72 | * The result is then ORred with the given @or@ value. This |
73 | * will often be 1, to make the result odd. |
74 | */ |
75 | |
76 | extern mp *mprand(mp */*d*/, unsigned /*b*/, grand */*r*/, mpw /*or*/); |
77 | |
743cef23 |
78 | /* --- @mprand_range@ --- * |
79 | * |
80 | * Arguments: @mp *d@ = destination integer |
81 | * @mp *l@ = limit for random number |
82 | * @grand *r@ = random number source |
83 | * @mpw or@ = mask for low-order bits |
84 | * |
85 | * Returns: A pseudorandom integer, unformly distributed over the |
86 | * interval %$[0, l)$%. |
87 | * |
88 | * Use: Generates a uniformly-distributed pseudorandom number in the |
89 | * appropriate range. |
90 | */ |
91 | |
92 | extern mp *mprand_range(mp */*d*/, mp */*l*/, grand */*r*/, mpw /*or*/); |
93 | |
893c6259 |
94 | /*----- That's all, folks -------------------------------------------------*/ |
95 | |
96 | #ifdef __cplusplus |
97 | } |
98 | #endif |
99 | |
100 | #endif |