forked from johannesgerer/jburkardt-cpp
-
Notifications
You must be signed in to change notification settings - Fork 0
/
uniform.html
600 lines (556 loc) · 17 KB
/
uniform.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
<html>
<head>
<title>
UNIFORM - A Uniform Random Number Generator (RNG)
</title>
</head>
<body bgcolor="#EEEEEE" link="#CC0000" alink="#FF3300" vlink="#000055">
<h1 align = "center">
UNIFORM <br> A Uniform Random Number Generator (RNG)
</h1>
<hr>
<p>
<b>UNIFORM</b>
is a C++ library which
returns a sequence of uniformly distributed pseudorandom numbers.
</p>
<p>
The fundamental underlying random number generator
is based on a simple, old, and limited linear congruential random
number generator originally used in the IBM System 360. If you want
state of the art random number generation, look elsewhere!
</p>
<p>
The C++ math library already has random number functions, and
it is not the purpose of <b>UNIFORM</b> to replace or improve them.
</p>
<p>
Rather, this library makes it possible to compare certain computations
that use uniform random numbers, written in C, C++, FORTRAN77,
FORTRAN90, Mathematica, MATLAB, or Python.
</p>
<p>
Various types of random data can be computed. The routine names
are chosen to indicate the corresponding type:
<ul>
<li>
<b>B</b>, an integer binary value of 0 or 1.
</li>
<li>
<b>C4</b>, complex <float>
</li>
<li>
<b>C8</b>, complex <double>
</li>
<li>
<b>CH</b>, char
</li>
<li>
<b>I4</b>, int
</li>
<li>
<b>L4</b>, bool
</li>
<li>
<b>R4</b>, float
</li>
<li>
<b>R8</b>, double
</li>
</ul>
</p>
<p>
In some cases, a one dimension vector or two dimensional
array of values is to be generated, and part of the name
will therefore include:
<ul>
<li>
<b>VEC</b>, vector;
</li>
<li>
<b>MAT</b>, a matrix of data;
</li>
</ul>
</p>
<p>
The underlying random numbers are generally defined over some
unit interval or region. Routines are available which return
these "unit" values, while other routines allow the user to
specify limits between which the unit values are rescaled.
The name of a routine will usually include a tag
suggestig which is the case:
<ul>
<li>
<b>01</b>, the data lies in a nit interval or region;
</li>
<li>
<b>AB</b>, the data lies in a scaled interval or region;
</li>
</ul>
</p>
<p>
The random number generator embodied here is not very sophisticated.
It will not have the best properties of distribution, noncorrelation
and long period. It is not the purpose of this library to achieve
such worthy goals. This is simply a reasonably portable library
that can be implemented in various languages, on various machines,
and for which it is possible, for instance, to regard the output
as a function of the seed, and moreover, to work directly with
the sequence of seeds, if necessary.
</p>
<h3 align = "center">
Licensing:
</h3>
<p>
The computer code and data files described and made available on this web page
are distributed under
<a href = "../../txt/gnu_lgpl.txt">the GNU LGPL license.</a>
</p>
<h3 align = "center">
Languages:
</h3>
<p>
<b>UNIFORM</b> is available in
<a href = "../../c_src/uniform/uniform.html">a C version</a> and
<a href = "../../cpp_src/uniform/uniform.html">a C++ version</a> and
<a href = "../../f77_src/uniform/uniform.html">a FORTRAN77 version</a> and
<a href = "../../f_src/uniform/uniform.html">a FORTRAN90 version</a> and
<a href = "../../math_src/uniform/uniform.html">a Mathematica version</a> and
<a href = "../../m_src/uniform/uniform.html">a MATLAB version</a> and
<a href = "../../py_src/uniform/uniform.html">a Python version</a>.
</p>
<h3 align = "center">
Related Data and Programs:
</h3>
<p>
<a href = "../../cpp_src/asa183/asa183.html">
ASA183</a>,
a C++ library which
implements the Wichman-Hill random number generator (RNG).
</p>
<p>
<a href = "../../cpp_src/box_behnken/box_behnken.html">
BOX_BEHNKEN</a>,
a C++ library which
computes a Box-Behnken design,
that is, a set of arguments to sample the behavior
of a function of multiple parameters;
</p>
<p>
<a href = "../../cpp_src/cpp_random/cpp_random.html">
CPP_RANDOM</a>,
C++ programs which
illustrate the use of the C++ random number generator routines.
</p>
<p>
<a href = "../../cpp_src/faure/faure.html">
FAURE</a>,
a C++ library which
computes elements of a Faure quasirandom sequence.
</p>
<p>
<a href = "../../cpp_src/halton/halton.html">
HALTON</a>,
a C++ library which
computes elements of a Halton quasirandom sequence.
</p>
<p>
<a href = "../../cpp_src/hammersley/hammersley.html">
HAMMERSLEY</a>,
a C++ library which
computes elements of a Hammersley quasirandom sequence.
</p>
<p>
<a href = "../../cpp_src/niederreiter2/niederreiter2.html">
NIEDERREITER2</a>,
a C++ library which
computes elements of a Niederreiter sequence using base 2.
</p>
<p>
<a href = "../../cpp_src/normal/normal.html">
NORMAL</a>,
a C++ library which
computes elements of a sequence of pseudorandom normally distributed values.
</p>
<p>
<a href = "../../cpp_src/randlc/randlc.html">
RANDLC</a>,
a C++ library which
generates a sequence of pseudorandom numbers,
used by the NAS Benchmark programs.
</p>
<p>
<a href = "../../cpp_src/ranlib/ranlib.html">
RANLIB</a>,
a C++ library which
produces random samples from Probability Density Functions (PDF's),
including Beta, Chi-square Exponential, F, Gamma, Multivariate normal,
Noncentral chi-square, Noncentral F, Univariate normal, random permutations,
Real uniform, Binomial, Negative Binomial, Multinomial, Poisson
and Integer uniform,
by Barry Brown and James Lovato.
</p>
<p>
<a href = "../../cpp_src/rnglib/rnglib.html">
RNGLIB</a>,
a C++ library which
implements a random number generator (RNG) with splitting facilities,
allowing multiple independent streams to be computed,
by L'Ecuyer and Cote.
</p>
<p>
<a href = "../../cpp_src/sobol/sobol.html">
SOBOL</a>,
a C++ library which
computes elements of a Sobol quasirandom sequence.
</p>
<p>
<a href = "../../cpp_src/van_der_corput/van_der_corput.html">
VAN_DER_CORPUT</a>,
a C++ library which
computes elements of a 1D van der Corput sequence.
</p>
<h3 align = "center">
Reference:
</h3>
<p>
<ol>
<li>
Paul Bratley, Bennett Fox, Linus Schrage,<br>
A Guide to Simulation,<br>
Second Edition,<br>
Springer, 1987,<br>
ISBN: 0387964673,<br>
LC: QA76.9.C65.B73.
</li>
<li>
Bennett Fox,<br>
Algorithm 647:
Implementation and Relative Efficiency of Quasirandom
Sequence Generators,<br>
ACM Transactions on Mathematical Software,<br>
Volume 12, Number 4, December 1986, pages 362-376.
</li>
<li>
Donald Knuth,<br>
The Art of Computer Programming,<br>
Volume 2, Seminumerical Algorithms,<br>
Third Edition,<br>
Addison Wesley, 1997,<br>
ISBN: 0201896842,<br>
LC: QA76.6.K64.
</li>
<li>
Pierre LEcuyer,<br>
Random Number Generation,<br>
in Handbook of Simulation,<br>
edited by Jerry Banks,<br>
Wiley, 1998,<br>
ISBN: 0471134031,<br>
LC: T57.62.H37.
</li>
<li>
Peter Lewis, Allen Goodman, James Miller,<br>
A Pseudo-Random Number Generator for the System/360,<br>
IBM Systems Journal,<br>
Volume 8, Number 2, 1969, pages 136-143.
</li>
<li>
Stephen Park, Keith Miller,<br>
Random Number Generators: Good Ones are Hard to Find,<br>
Communications of the ACM,<br>
Volume 31, Number 10, October 1988, pages 1192-1201.
</li>
<li>
Eric Weisstein,<br>
CRC Concise Encyclopedia of Mathematics,<br>
CRC Press, 2002,<br>
Second edition,<br>
ISBN: 1584883472,<br>
LC: QA5.W45.
</li>
<li>
Barry Wilkinson, Michael Allen,<br>
Parallel Programming:
Techniques and Applications Using Networked Workstations and Parallel Computers,<br>
Prentice Hall,<br>
ISBN: 0-13-140563-2,<br>
LC: QA76.642.W54.
</li>
</ol>
</p>
<h3 align = "center">
Source Code:
</h3>
<p>
<ul>
<li>
<a href = "uniform.cpp">uniform.cpp</a>,
the source code.
</li>
<li>
<a href = "uniform.hpp">uniform.hpp</a>,
the include file.
</li>
<li>
<a href = "uniform.sh">uniform.sh</a>,
commands to compile the source code.
</li>
</ul>
</p>
<h3 align = "center">
Examples and Tests:
</h3>
<p>
<ul>
<li>
<a href = "uniform_prb.cpp">uniform_prb.cpp</a>,
a sample calling program.
</li>
<li>
<a href = "uniform_prb.sh">uniform_prb.sh</a>,
commands to compile, link and run the sample calling program.
</li>
<li>
<a href = "uniform_prb_output.txt">uniform_prb_output.txt</a>,
the output file.
</li>
</ul>
</p>
<h3 align = "center">
List of Routines:
</h3>
<p>
<ul>
<li>
<b>C4_UNIFORM_01</b> returns a unit pseudorandom C4.
</li>
<li>
<b>C4MAT_UNIFORM_01</b> returns a unit pseudorandom C4MAT.
</li>
<li>
<b>C4MAT_UNIFORM_01_NEW</b> returns a new unit pseudorandom C4MAT.
</li>
<li>
<b>C4VEC_UNIFORM_01</b> returns a unit pseudorandom C4VEC.
</li>
<li>
<b>C4VEC_UNIFORM_01_NEW</b> returns a unit pseudorandom C4VEC.
</li>
<li>
<b>C8_UNIFORM_01</b> returns a unit pseudorandom C8.
</li>
<li>
<b>C8MAT_UNIFORM_01</b> returns a unit pseudorandom C8MAT.
</li>
<li>
<b>C8MAT_UNIFORM_01_NEW</b> returns a new unit pseudorandom C8MAT.
</li>
<li>
<b>C8VEC_UNIFORM_01</b> returns a unit pseudorandom C8VEC.
</li>
<li>
<b>C8VEC_UNIFORM_01_NEW</b> returns a unit pseudorandom C8VEC.
</li>
<li>
<b>CH_UNIFORM</b> returns a scaled pseudorandom CH.
</li>
<li>
<b>CONGRUENCE</b> solves a congruence of the form ( A * X = C ) mod B.
</li>
<li>
<b>DIGIT_TO_CH</b> returns the base 10 digit character corresponding to a digit.
</li>
<li>
<b>GET_SEED</b> returns a random seed for the random number generator.
</li>
<li>
<b>I4_GCD</b> finds the greatest common divisor of I and J.
</li>
<li>
<b>I4_HUGE</b> returns a "huge" I4.
</li>
<li>
<b>I4_LOG_10</b> returns the whole part of the logarithm base 10 of an I4.
</li>
<li>
<b>I4_MAX</b> returns the maximum of two I4's.
</li>
<li>
<b>I4_MIN</b> returns the smaller of two I4's.
</li>
<li>
<b>I4_SEED_ADVANCE</b> "advances" the seed.
</li>
<li>
<b>I4_SIGN</b> returns the sign of an I4.
</li>
<li>
<b>I4_SWAP</b> switches two I4's.
</li>
<li>
<b>I4_TO_S</b> converts an I4 to a string.
</li>
<li>
<b>I4_UNIFORM</b> returns a scaled pseudorandom I4.
</li>
<li>
<b>I4_UNIFORM_0I</b> is a portable random integer generator.
</li>
<li>
<b>I4MAT_UNIFORM</b> returns a scaled pseudorandom I4MAT.
</li>
<li>
<b>I4MAT_UNIFORM_NEW</b> returns a new scaled pseudorandom I4MAT.
</li>
<li>
<b>I4VEC_MAX</b> returns the maximum element in an I4VEC.
</li>
<li>
<b>I4VEC_MEAN</b> returns the mean of an I4VEC.
</li>
<li>
<b>I4VEC_MIN</b> returns the minimum element in an I4VEC.
</li>
<li>
<b>I4VEC_UNIFORM</b> returns a scaled pseudorandom I4VEC.
</li>
<li>
<b>I4VEC_UNIFORM_NEW</b> returns a scaled pseudorandom I4VEC.
</li>
<li>
<b>I4VEC_VARIANCE</b> returns the variance of an I4VEC.
</li>
<li>
<b>I8_HUGE</b> returns a "huge" I8.
</li>
<li>
<b>I8_MAX</b> returns the maximum of two I8's.
</li>
<li>
<b>I8_MIN</b> returns the smaller of two I8's.
</li>
<li>
<b>I8_UNIFORM</b> returns a scaled pseudorandom I8.
</li>
<li>
<b>L_UNIFORM</b> returns a pseudorandom L.
</li>
<li>
<b>LCRG_ANBN</b> computes the "N-th power" of a linear congruential generator.
</li>
<li>
<b>LCRG_EVALUATE</b> evaluates an LCRG, y = ( A * x + B ) mod C.
</li>
<li>
<b>LCRG_SEED</b> computes the N-th seed of a linear congruential generator.
</li>
<li>
<b>LMAT_UNIFORM</b> returns a pseudorandom LMAT.
</li>
<li>
<b>LMAT_UNIFORM_NEW</b> returns a new pseudorandom LMAT.
</li>
<li>
<b>LVEC_UNIFORM_NEW</b> returns a pseudorandom LVEC.
</li>
<li>
<b>POWER_MOD</b> computes ( A^N ) mod M.
</li>
<li>
<b>R4_ABS</b> returns the absolute value of an R4.
</li>
<li>
<b>R4_NINT</b> returns the nearest integer to an R4.
</li>
<li>
<b>R4_UNIFORM</b> returns a scaled pseudorandom R4.
</li>
<li>
<b>R4_UNIFORM_01</b> returns a unit pseudorandom R4.
</li>
<li>
<b>R4MAT_UNIFORM</b> returns a scaled pseudorandom R4MAT.
</li>
<li>
<b>R4MAT_UNIFORM_NEW</b> returns a new scaled pseudorandom R4MAT.
</li>
<li>
<b>R4MAT_UNIFORM_01</b> returns a unit pseudorandom R4MAT.
</li>
<li>
<b>R4MAT_UNIFORM_01_NEW</b> returns a new unit pseudorandom R4MAT.
</li>
<li>
<b>R4VEC_UNIFORM</b> returns a scaled pseudorandom R4VEC.
</li>
<li>
<b>R4VEC_UNIFORM_NEW</b> returns a scaled pseudorandom R4VEC.
</li>
<li>
<b>R4VEC_UNIFORM_01</b> returns a unit unit pseudorandom R4VEC.
</li>
<li>
<b>R4VEC_UNIFORM_01_NEW</b> returns a unit unit pseudorandom R4VEC.
</li>
<li>
<b>R8_ABS</b> returns the absolute value of an R8.
</li>
<li>
<b>R8_NINT</b> returns the nearest integer to an R8.
</li>
<li>
<b>R8_UNIFORM</b> returns a scaled pseudorandom R8.
</li>
<li>
<b>R8_UNIFORM_01</b> returns a unit pseudorandom R8.
</li>
<li>
<b>R8I8_UNIFORM</b> returns a scaled pseudorandom R8 using an I8 seed.
</li>
<li>
<b>R8I8_UNIFORM_01</b> returns a unit pseudorandom R8 using an I8 seed.
</li>
<li>
<b>R8MAT_UNIFORM</b> returns a scaled pseudorandom R8MAT.
</li>
<li>
<b>R8MAT_UNIFORM_NEW</b> returns a new scaled pseudorandom R8MAT.
</li>
<li>
<b>R8MAT_UNIFORM_01</b> returns a unit pseudorandom R8MAT.
</li>
<li>
<b>R8MAT_UNIFORM_01_NEW</b> returns a new unit pseudorandom R8MAT.
</li>
<li>
<b>R8VEC_COPY</b> copies an R8VEC.
</li>
<li>
<b>R8VEC_UNIFORM</b> returns a scaled pseudorandom R8VEC.
</li>
<li>
<b>R8VEC_UNIFORM_NEW</b> returns a scaled pseudorandom R8VEC.
</li>
<li>
<b>R8VEC_UNIFORM_01</b> returns a unit pseudorandom R8VEC.
</li>
<li>
<b>R8VEC_UNIFORM_01_NEW</b> returns a new unit pseudorandom R8VEC.
</li>
<li>
<b>TIMESTAMP</b> prints the current YMDHMS date as a time stamp.
</li>
</ul>
</p>
<p>
You can go up one level to <a href = "../cpp_src.html">
the C++ source codes</a>.
</p>
<hr>
<i>
Last revised on 01 March 2010.
</i>
<!-- John Burkardt -->
</body>
</html>