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