lib/libc/gen/rand48.3

   1 .\" Copyright (c) 1993 Martin Birgmeier
   2 .\" All rights reserved.
   3 .\"
   4 .\" You may redistribute unmodified or modified versions of this source
   5 .\" code provided that the above copyright notice and this and the
   6 .\" following conditions are retained.
   7 .\"
   8 .\" This software is provided ``as is'', and comes with no warranties
   9 .\" of any kind. I shall in no event be liable for anything that happens
  10 .\" to anyone/anything when using this software.
  11 .\"
  12 .\"     @(#)rand48.3 V1.0 MB 8 Oct 1993
  13 .\" $FreeBSD: src/lib/libc/gen/rand48.3,v 1.8.2.6 2003/03/15 15:11:05 trhodes Exp $
  14 .\" $DragonFly: src/lib/libc/gen/rand48.3,v 1.2 2003/06/17 04:26:42 dillon Exp $
  15 .\"
  16 .Dd October 8, 1993
  17 .Dt RAND48 3
  18 .Os
  19 .Sh NAME
  20 .Nm drand48 ,
  21 .Nm erand48 ,
  22 .Nm lrand48 ,
  23 .Nm nrand48 ,
  24 .Nm mrand48 ,
  25 .Nm jrand48 ,
  26 .Nm srand48 ,
  27 .Nm seed48 ,
  28 .Nm lcong48
  29 .Nd pseudo random number generators and initialization routines
  30 .Sh LIBRARY
  31 .Lb libc
  32 .Sh SYNOPSIS
  33 .In stdlib.h
  34 .Ft double
  35 .Fn drand48 void
  36 .Ft double
  37 .Fn erand48 "unsigned short xseed[3]"
  38 .Ft long
  39 .Fn lrand48 void
  40 .Ft long
  41 .Fn nrand48 "unsigned short xseed[3]"
  42 .Ft long
  43 .Fn mrand48 void
  44 .Ft long
  45 .Fn jrand48 "unsigned short xseed[3]"
  46 .Ft void
  47 .Fn srand48 "long seed"
  48 .Ft "unsigned short *"
  49 .Fn seed48 "unsigned short xseed[3]"
  50 .Ft void
  51 .Fn lcong48 "unsigned short p[7]"
  52 .Sh DESCRIPTION
  53 The
  54 .Fn rand48
  55 family of functions generates pseudo-random numbers using a linear
  56 congruential algorithm working on integers 48 bits in size.
  57 The
  58 particular formula employed is
  59 r(n+1) = (a * r(n) + c) mod m
  60 where the default values are
  61 for the multiplicand a = 0xfdeece66d = 25214903917 and
  62 the addend c = 0xb = 11.
  63 The modulo is always fixed at m = 2 ** 48.
  64 r(n) is called the seed of the random number generator.
  65 .Pp
  66 For all the six generator routines described next, the first
  67 computational step is to perform a single iteration of the algorithm.
  68 .Pp
  69 The
  70 .Fn drand48
  71 and
  72 .Fn erand48
  73 functions
  74 return values of type double.
  75 The full 48 bits of r(n+1) are
  76 loaded into the mantissa of the returned value, with the exponent set
  77 such that the values produced lie in the interval [0.0, 1.0).
  78 .Pp
  79 The
  80 .Fn lrand48
  81 and
  82 .Fn nrand48
  83 functions
  84 return values of type long in the range
  85 [0, 2**31-1]. The high-order (31) bits of
  86 r(n+1) are loaded into the lower bits of the returned value, with
  87 the topmost (sign) bit set to zero.
  88 .Pp
  89 The
  90 .Fn mrand48
  91 and
  92 .Fn jrand48
  93 functions
  94 return values of type long in the range
  95 [-2**31, 2**31-1]. The high-order (32) bits of
  96 r(n+1) are loaded into the returned value.
  97 .Pp
  98 The
  99 .Fn drand48 ,
 100 .Fn lrand48 ,
 101 and
 102 .Fn mrand48
 103 functions
 104 use an internal buffer to store r(n). For these functions
 105 the initial value of r(0) = 0x1234abcd330e = 20017429951246.
 106 .Pp
 107 On the other hand,
 108 .Fn erand48 ,
 109 .Fn nrand48 ,
 110 and
 111 .Fn jrand48
 112 use a user-supplied buffer to store the seed r(n),
 113 which consists of an array of 3 shorts, where the zeroth member
 114 holds the least significant bits.
 115 .Pp
 116 All functions share the same multiplicand and addend.
 117 .Pp
 118 The
 119 .Fn srand48
 120 function
 121 is used to initialize the internal buffer r(n) of
 122 .Fn drand48 ,
 123 .Fn lrand48 ,
 124 and
 125 .Fn mrand48
 126 such that the 32 bits of the seed value are copied into the upper 32 bits
 127 of r(n), with the lower 16 bits of r(n) arbitrarily being set to 0x330e.
 128 Additionally, the constant multiplicand and addend of the algorithm are
 129 reset to the default values given above.
 130 .Pp
 131 The
 132 .Fn seed48
 133 function
 134 also initializes the internal buffer r(n) of
 135 .Fn drand48 ,
 136 .Fn lrand48 ,
 137 and
 138 .Fn mrand48 ,
 139 but here all 48 bits of the seed can be specified in an array of 3 shorts,
 140 where the zeroth member specifies the lowest bits.
 141 Again,
 142 the constant multiplicand and addend of the algorithm are
 143 reset to the default values given above.
 144 The
 145 .Fn seed48
 146 function
 147 returns a pointer to an array of 3 shorts which contains the old seed.
 148 This array is statically allocated, thus its contents are lost after
 149 each new call to
 150 .Fn seed48 .
 151 .Pp
 152 Finally,
 153 .Fn lcong48
 154 allows full control over the multiplicand and addend used in
 155 .Fn drand48 ,
 156 .Fn erand48 ,
 157 .Fn lrand48 ,
 158 .Fn nrand48 ,
 159 .Fn mrand48 ,
 160 and
 161 .Fn jrand48 ,
 162 and the seed used in
 163 .Fn drand48 ,
 164 .Fn lrand48 ,
 165 and
 166 .Fn mrand48 .
 167 An array of 7 shorts is passed as argument; the first three shorts are
 168 used to initialize the seed; the second three are used to initialize the
 169 multiplicand; and the last short is used to initialize the addend.
 170 It is thus not possible to use values greater than 0xffff as the addend.
 171 .Pp
 172 Note that all three methods of seeding the random number generator
 173 always also set the multiplicand and addend for any of the six
 174 generator calls.
 175 .Pp
 176 For a more powerful random number generator, see
 177 .Xr random 3 .
 178 .Sh AUTHORS
 179 .An Martin Birgmeier
 180 .Sh SEE ALSO
 181 .Xr rand 3 ,
 182 .Xr random 3