home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 22 gnu / 22-gnu.zip / gnuawk.zip / random.c < prev    next >
C/C++ Source or Header  |  1997-05-13  |  13KB  |  380 lines
  1. /*
  2.  * Copyright (c) 1983 Regents of the University of California.
  3.  * All rights reserved.
  4.  *
  5.  * Redistribution and use in source and binary forms are permitted
  6.  * provided that the above copyright notice and this paragraph are
  7.  * duplicated in all such forms and that any documentation,
  8.  * advertising materials, and other materials related to such
  9.  * distribution and use acknowledge that the software was developed
  10.  * by the University of California, Berkeley.  The name of the
  11.  * University may not be used to endorse or promote products derived
  12.  * from this software without specific prior written permission.
  13.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
  14.  * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
  15.  * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  16.  */
  17.  
  18. #if defined(LIBC_SCCS) && !defined(lint)
  19. static char sccsid[] = "@(#)random.c    5.5 (Berkeley) 7/6/88";
  20. #endif /* LIBC_SCCS and not lint */
  21.  
  22. #include <stdio.h>
  23. #include "random.h"    /* GAWK ADDITION */
  24.  
  25. /*
  26.  * random.c:
  27.  * An improved random number generation package.  In addition to the standard
  28.  * rand()/srand() like interface, this package also has a special state info
  29.  * interface.  The initstate() routine is called with a seed, an array of
  30.  * bytes, and a count of how many bytes are being passed in; this array is then
  31.  * initialized to contain information for random number generation with that
  32.  * much state information.  Good sizes for the amount of state information are
  33.  * 32, 64, 128, and 256 bytes.  The state can be switched by calling the
  34.  * setstate() routine with the same array as was initiallized with initstate().
  35.  * By default, the package runs with 128 bytes of state information and
  36.  * generates far better random numbers than a linear congruential generator.
  37.  * If the amount of state information is less than 32 bytes, a simple linear
  38.  * congruential R.N.G. is used.
  39.  * Internally, the state information is treated as an array of longs; the
  40.  * zeroeth element of the array is the type of R.N.G. being used (small
  41.  * integer); the remainder of the array is the state information for the
  42.  * R.N.G.  Thus, 32 bytes of state information will give 7 longs worth of
  43.  * state information, which will allow a degree seven polynomial.  (Note: the
  44.  * zeroeth word of state information also has some other information stored
  45.  * in it -- see setstate() for details).
  46.  * The random number generation technique is a linear feedback shift register
  47.  * approach, employing trinomials (since there are fewer terms to sum up that
  48.  * way).  In this approach, the least significant bit of all the numbers in
  49.  * the state table will act as a linear feedback shift register, and will have
  50.  * period 2^deg - 1 (where deg is the degree of the polynomial being used,
  51.  * assuming that the polynomial is irreducible and primitive).  The higher
  52.  * order bits will have longer periods, since their values are also influenced
  53.  * by pseudo-random carries out of the lower bits.  The total period of the
  54.  * generator is approximately deg*(2**deg - 1); thus doubling the amount of
  55.  * state information has a vast influence on the period of the generator.
  56.  * Note: the deg*(2**deg - 1) is an approximation only good for large deg,
  57.  * when the period of the shift register is the dominant factor.  With deg
  58.  * equal to seven, the period is actually much longer than the 7*(2**7 - 1)
  59.  * predicted by this formula.
  60.  */
  61.  
  62.  
  63.  
  64. /*
  65.  * For each of the currently supported random number generators, we have a
  66.  * break value on the amount of state information (you need at least this
  67.  * many bytes of state info to support this random number generator), a degree
  68.  * for the polynomial (actually a trinomial) that the R.N.G. is based on, and
  69.  * the separation between the two lower order coefficients of the trinomial.
  70.  */
  71.  
  72. #define        TYPE_0        0        /* linear congruential */
  73. #define        BREAK_0        8
  74. #define        DEG_0        0
  75. #define        SEP_0        0
  76.  
  77. #define        TYPE_1        1        /* x**7 + x**3 + 1 */
  78. #define        BREAK_1        32
  79. #define        DEG_1        7
  80. #define        SEP_1        3
  81.  
  82. #define        TYPE_2        2        /* x**15 + x + 1 */
  83. #define        BREAK_2        64
  84. #define        DEG_2        15
  85. #define        SEP_2        1
  86.  
  87. #define        TYPE_3        3        /* x**31 + x**3 + 1 */
  88. #define        BREAK_3        128
  89. #define        DEG_3        31
  90. #define        SEP_3        3
  91. #ifdef _CRAY
  92. #define        DEG_3_P1    32        /* bug - do addition here */
  93. #define        SEP_3_P1    4        /* *_3 + 1 = _3_P1 */
  94. #endif
  95.  
  96. #define        TYPE_4        4        /* x**63 + x + 1 */
  97. #define        BREAK_4        256
  98. #define        DEG_4        63
  99. #define        SEP_4        1
  100.  
  101.  
  102. /*
  103.  * Array versions of the above information to make code run faster -- relies
  104.  * on fact that TYPE_i == i.
  105.  */
  106.  
  107. #define        MAX_TYPES    5        /* max number of types above */
  108.  
  109. static  int        degrees[ MAX_TYPES ]    = { DEG_0, DEG_1, DEG_2,
  110.                                 DEG_3, DEG_4 };
  111.  
  112. static  int        seps[ MAX_TYPES ]    = { SEP_0, SEP_1, SEP_2,
  113.                                 SEP_3, SEP_4 };
  114.  
  115.  
  116.  
  117. /*
  118.  * Initially, everything is set up as if from :
  119.  *        initstate( 1, &randtbl, 128 );
  120.  * Note that this initialization takes advantage of the fact that srandom()
  121.  * advances the front and rear pointers 10*rand_deg times, and hence the
  122.  * rear pointer which starts at 0 will also end up at zero; thus the zeroeth
  123.  * element of the state information, which contains info about the current
  124.  * position of the rear pointer is just
  125.  *    MAX_TYPES*(rptr - state) + TYPE_3 == TYPE_3.
  126.  */
  127.  
  128. static  long        randtbl[ DEG_3 + 1 ]    = { TYPE_3,
  129.                 0x9a319039, 0x32d9c024, 0x9b663182, 0x5da1f342,
  130.                 0xde3b81e0, 0xdf0a6fb5, 0xf103bc02, 0x48f340fb,
  131.                 0x7449e56b, 0xbeb1dbb0, 0xab5c5918, 0x946554fd,
  132.                 0x8c2e680f, 0xeb3d799f, 0xb11ee0b7, 0x2d436b86,
  133.                 0xda672e2a, 0x1588ca88, 0xe369735d, 0x904f35f7,
  134.                 0xd7158fd6, 0x6fa6f051, 0x616e6b96, 0xac94efdc,
  135.                 0x36413f93, 0xc622c298, 0xf5a42ab8, 0x8a88d77b,
  136.                     0xf5ad9d0e, 0x8999220b, 0x27fb47b9 };
  137.  
  138. /*
  139.  * fptr and rptr are two pointers into the state info, a front and a rear
  140.  * pointer.  These two pointers are always rand_sep places aparts, as they cycle
  141.  * cyclically through the state information.  (Yes, this does mean we could get
  142.  * away with just one pointer, but the code for random() is more efficient this
  143.  * way).  The pointers are left positioned as they would be from the call
  144.  *            initstate( 1, randtbl, 128 )
  145.  * (The position of the rear pointer, rptr, is really 0 (as explained above
  146.  * in the initialization of randtbl) because the state table pointer is set
  147.  * to point to randtbl[1] (as explained below).
  148.  */
  149.  
  150. #ifdef _CRAY
  151. static  long        *fptr            = &randtbl[ SEP_3_P1 ];
  152. #else
  153. static  long        *fptr            = &randtbl[ SEP_3 + 1 ];
  154. #endif
  155. static  long        *rptr            = &randtbl[ 1 ];
  156.  
  157.  
  158.  
  159. /*
  160.  * The following things are the pointer to the state information table,
  161.  * the type of the current generator, the degree of the current polynomial
  162.  * being used, and the separation between the two pointers.
  163.  * Note that for efficiency of random(), we remember the first location of
  164.  * the state information, not the zeroeth.  Hence it is valid to access
  165.  * state[-1], which is used to store the type of the R.N.G.
  166.  * Also, we remember the last location, since this is more efficient than
  167.  * indexing every time to find the address of the last element to see if
  168.  * the front and rear pointers have wrapped.
  169.  */
  170.  
  171. static  long        *state            = &randtbl[ 1 ];
  172.  
  173. static  int        rand_type        = TYPE_3;
  174. static  int        rand_deg        = DEG_3;
  175. static  int        rand_sep        = SEP_3;
  176.  
  177. #ifdef _CRAY
  178. static  long        *end_ptr        = &randtbl[ DEG_3_P1 ];
  179. #else
  180. static  long        *end_ptr        = &randtbl[ DEG_3 + 1 ];
  181. #endif
  182.  
  183.  
  184.  
  185. /*
  186.  * srandom:
  187.  * Initialize the random number generator based on the given seed.  If the
  188.  * type is the trivial no-state-information type, just remember the seed.
  189.  * Otherwise, initializes state[] based on the given "seed" via a linear
  190.  * congruential generator.  Then, the pointers are set to known locations
  191.  * that are exactly rand_sep places apart.  Lastly, it cycles the state
  192.  * information a given number of times to get rid of any initial dependencies
  193.  * introduced by the L.C.R.N.G.
  194.  * Note that the initialization of randtbl[] for default usage relies on
  195.  * values produced by this routine.
  196.  */
  197.  
  198. void
  199. srandom( x )
  200.  
  201.     unsigned        x;
  202. {
  203.         register  int        i, j;
  204.     long random();
  205.  
  206.     if(  rand_type  ==  TYPE_0  )  {
  207.         state[ 0 ] = x;
  208.     }
  209.     else  {
  210.         j = 1;
  211.         state[ 0 ] = x;
  212.         for( i = 1; i < rand_deg; i++ )  {
  213.         state[i] = 1103515245*state[i - 1] + 12345;
  214.         }
  215.         fptr = &state[ rand_sep ];
  216.         rptr = &state[ 0 ];
  217.         for( i = 0; i < 10*rand_deg; i++ )  random();
  218.     }
  219. }
  220.  
  221.  
  222.  
  223. /*
  224.  * initstate:
  225.  * Initialize the state information in the given array of n bytes for
  226.  * future random number generation.  Based on the number of bytes we
  227.  * are given, and the break values for the different R.N.G.'s, we choose
  228.  * the best (largest) one we can and set things up for it.  srandom() is
  229.  * then called to initialize the state information.
  230.  * Note that on return from srandom(), we set state[-1] to be the type
  231.  * multiplexed with the current value of the rear pointer; this is so
  232.  * successive calls to initstate() won't lose this information and will
  233.  * be able to restart with setstate().
  234.  * Note: the first thing we do is save the current state, if any, just like
  235.  * setstate() so that it doesn't matter when initstate is called.
  236.  * Returns a pointer to the old state.
  237.  */
  238.  
  239. char  *
  240. initstate( seed, arg_state, n )
  241.  
  242.     unsigned        seed;            /* seed for R. N. G. */
  243.     char        *arg_state;        /* pointer to state array */
  244.     int            n;            /* # bytes of state info */
  245. {
  246.     register  char        *ostate        = (char *)( &state[ -1 ] );
  247.  
  248.     if(  rand_type  ==  TYPE_0  )  state[ -1 ] = rand_type;
  249.     else  state[ -1 ] = MAX_TYPES*(rptr - state) + rand_type;
  250.     if(  n  <  BREAK_1  )  {
  251.         if(  n  <  BREAK_0  )  {
  252.         fprintf( stderr, "initstate: not enough state (%d bytes) with which to do jack; ignored.\n", n );
  253.         return 0;
  254.         }
  255.         rand_type = TYPE_0;
  256.         rand_deg = DEG_0;
  257.         rand_sep = SEP_0;
  258.     }
  259.     else  {
  260.         if(  n  <  BREAK_2  )  {
  261.         rand_type = TYPE_1;
  262.         rand_deg = DEG_1;
  263.         rand_sep = SEP_1;
  264.         }
  265.         else  {
  266.         if(  n  <  BREAK_3  )  {
  267.             rand_type = TYPE_2;
  268.             rand_deg = DEG_2;
  269.             rand_sep = SEP_2;
  270.         }
  271.         else  {
  272.             if(  n  <  BREAK_4  )  {
  273.             rand_type = TYPE_3;
  274.             rand_deg = DEG_3;
  275.             rand_sep = SEP_3;
  276.             }
  277.             else  {
  278.             rand_type = TYPE_4;
  279.             rand_deg = DEG_4;
  280.             rand_sep = SEP_4;
  281.             }
  282.         }
  283.         }
  284.     }
  285.     state = &(  ( (long *)arg_state )[1]  );    /* first location */
  286.     end_ptr = &state[ rand_deg ];    /* must set end_ptr before srandom */
  287.     srandom( seed );
  288.     if(  rand_type  ==  TYPE_0  )  state[ -1 ] = rand_type;
  289.     else  state[ -1 ] = MAX_TYPES*(rptr - state) + rand_type;
  290.     return( ostate );
  291. }
  292.  
  293.  
  294.  
  295. /*
  296.  * setstate:
  297.  * Restore the state from the given state array.
  298.  * Note: it is important that we also remember the locations of the pointers
  299.  * in the current state information, and restore the locations of the pointers
  300.  * from the old state information.  This is done by multiplexing the pointer
  301.  * location into the zeroeth word of the state information.
  302.  * Note that due to the order in which things are done, it is OK to call
  303.  * setstate() with the same state as the current state.
  304.  * Returns a pointer to the old state information.
  305.  */
  306.  
  307. char  *
  308. setstate( arg_state )
  309.  
  310.     char        *arg_state;
  311. {
  312.     register  long        *new_state    = (long *)arg_state;
  313.     register  int        type        = new_state[0]%MAX_TYPES;
  314.     register  int        rear        = new_state[0]/MAX_TYPES;
  315.     char            *ostate        = (char *)( &state[ -1 ] );
  316.  
  317.     if(  rand_type  ==  TYPE_0  )  state[ -1 ] = rand_type;
  318.     else  state[ -1 ] = MAX_TYPES*(rptr - state) + rand_type;
  319.     switch(  type  )  {
  320.         case  TYPE_0:
  321.         case  TYPE_1:
  322.         case  TYPE_2:
  323.         case  TYPE_3:
  324.         case  TYPE_4:
  325.         rand_type = type;
  326.         rand_deg = degrees[ type ];
  327.         rand_sep = seps[ type ];
  328.         break;
  329.  
  330.         default:
  331.         fprintf( stderr, "setstate: state info has been munged; not changed.\n" );
  332.     }
  333.     state = &new_state[ 1 ];
  334.     if(  rand_type  !=  TYPE_0  )  {
  335.         rptr = &state[ rear ];
  336.         fptr = &state[ (rear + rand_sep)%rand_deg ];
  337.     }
  338.     end_ptr = &state[ rand_deg ];        /* set end_ptr too */
  339.     return( ostate );
  340. }
  341.  
  342.  
  343.  
  344. /*
  345.  * random:
  346.  * If we are using the trivial TYPE_0 R.N.G., just do the old linear
  347.  * congruential bit.  Otherwise, we do our fancy trinomial stuff, which is the
  348.  * same in all ther other cases due to all the global variables that have been
  349.  * set up.  The basic operation is to add the number at the rear pointer into
  350.  * the one at the front pointer.  Then both pointers are advanced to the next
  351.  * location cyclically in the table.  The value returned is the sum generated,
  352.  * reduced to 31 bits by throwing away the "least random" low bit.
  353.  * Note: the code takes advantage of the fact that both the front and
  354.  * rear pointers can't wrap on the same call by not testing the rear
  355.  * pointer if the front one has wrapped.
  356.  * Returns a 31-bit random number.
  357.  */
  358.  
  359. long
  360. random()
  361. {
  362.     long        i;
  363.  
  364.     if(  rand_type  ==  TYPE_0  )  {
  365.         i = state[0] = ( state[0]*1103515245 + 12345 )&0x7fffffff;
  366.     }
  367.     else  {
  368.         *fptr += *rptr;
  369.         i = (*fptr >> 1)&0x7fffffff;    /* chucking least random bit */
  370.         if(  ++fptr  >=  end_ptr  )  {
  371.         fptr = state;
  372.         ++rptr;
  373.         }
  374.         else  {
  375.         if(  ++rptr  >=  end_ptr  )  rptr = state;
  376.         }
  377.     }
  378.     return( i );
  379. }
  380.