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