home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-dist / octave-1.1.1p1-src.tgz / tar.out / fsf / octave / libcruft / ranlib / README < prev    next >
Text File  |  1996-09-28  |  8KB  |  226 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.                                      RANLIB
  13.  
  14.             Library of Fortran Routines for Random Number Generation
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.                                      README
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.                             Compiled and Written by:
  33.  
  34.                                  Barry W. Brown
  35.                                   James Lovato
  36.                                    
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.                      Department of Biomathematics, Box 237
  47.                      The University of Texas, M.D. Anderson Cancer Center
  48.                      1515 Holcombe Boulevard
  49.                      Houston, TX      77030
  50.  
  51.  
  52.  This work was supported by grant CA-16672 from the National Cancer Institute.
  53.  
  54.  
  55.                           SUMMARY OF RANLIB
  56.  
  57. The bottom level routines provide 32 virtual random number generators.
  58. Each generator can provide 1,048,576 blocks of numbers, and each block
  59. is of length 1,073,741,824.  Any generator can be set to the beginning
  60. or end  of the current  block or to  its starting value.  Packaging is
  61. provided   so  that  if  these capabilities  are not  needed, a single
  62. generator with period 2.3 X 10^18 is seen.
  63.  
  64. Using this base, routines are provided that return:
  65.     (1)  Beta random deviates
  66.     (2)  Chi-square random deviates
  67.     (3)  Exponential random deviates
  68.     (4)  F random deviates
  69.     (5)  Gamma random deviates
  70.     (6)  Multivariate normal random deviates (mean and covariance
  71.          matrix specified)
  72.     (7)  Noncentral chi-square random deviates
  73.     (8)  Noncentral F random deviates
  74.     (9)  Univariate normal random deviates
  75.     (10) Random permutations of an integer array
  76.     (11) Real uniform random deviates between specified limits
  77.     (12) Binomial random deviates
  78.     (13) Poisson random deviates
  79.     (14) Integer uniform deviates between specified limits
  80.     (15) Seeds for the random number generator calculated from a
  81.          character string
  82.  
  83.                              INSTALLATION
  84.  
  85. Directory src contains the Fortran  source for most of  the  routines.
  86. Directory  linpack  contains  two  linpack  routines  needed   by  the
  87. multivariate  generator.  If  linpack is present  on your machine, you
  88. won't need  these routines.   The Fortran  code from these directories
  89. should be compiled and placed in a library.   Directory  test contains
  90. three test programs for this code.
  91.  
  92.                             DOCUMENTATION
  93.  
  94. Documentation  is  on directory doc on the  distribution.   All of the
  95. documentation is  in the  form   of  character  (ASCII)    files.   An
  96. explanation of the concepts involved in the base generator and details
  97. of its implementation are contained in Basegen.doc.  A summary  of all
  98. of the  available  routines is  contained  in ranlib.chs  (chs  is  an
  99. abbreviation of 'cheat sheet').  The 'chs'  file  will probably be the
  100. reference to ranlib  that is primarily used.   The  file, ranlib.fdoc,
  101. contains all comments heading  each routine.   There is somewhat  more
  102. information   in  'fdoc' than  'chs',  but  the additional information
  103. consists primarily of references to the literature.
  104.  
  105.  
  106.  
  107.  
  108.                                SOURCES
  109.  
  110. The following routines,  which  were  written by others   and  lightly
  111. modified for consistency in packaging, are included in RANLIB.
  112.  
  113.                         Bottom Level Routines
  114.  
  115. These routines are a transliteration of the Pascal in the reference to
  116. Fortran.
  117.  
  118. L'Ecuyer, P. and  Cote, S. "Implementing  a Random Number Package with
  119. Splitting  Facilities."  ACM  Transactions   on Mathematical Software,
  120. 17:98-111 (1991)
  121.  
  122.                              Exponential
  123.  
  124. This code was obtained from Netlib.
  125.  
  126. Ahrens,  J.H. and  Dieter, U.   Computer Methods for Sampling From the
  127. Exponential and Normal  Distributions.  Comm. ACM,  15,10 (Oct. 1972),
  128. 873 - 882.
  129.  
  130.                                 Gamma
  131.  
  132. (Case R >= 1.0)                                          
  133.  
  134. Ahrens, J.H. and Dieter, U.  Generating Gamma  Variates by  a Modified
  135. Rejection Technique.  Comm. ACM, 25,1 (Jan. 1982), 47 - 54.
  136. Algorithm GD                                                       
  137.  
  138. (Case 0.0 <= R <= 1.0)                                   
  139.  
  140. Ahrens, J.H. and Dieter, U.  Computer Methods for Sampling from Gamma,
  141. Beta,  Poisson  and Binomial   Distributions.    Computing, 12 (1974),
  142. 223-246.  Adaptation of algorithm GS.
  143.  
  144.                                 Normal
  145.  
  146. This code was obtained from netlib.
  147.  
  148. Ahrens, J.H.  and  Dieter, U.    Extensions of   Forsythe's Method for
  149. Random Sampling  from  the Normal Distribution.  Math. Comput., 27,124
  150. (Oct. 1973), 927 - 937.
  151.  
  152.                                Binomial
  153.  
  154. This code was kindly sent me by Dr. Kachitvichyanukul.
  155.  
  156. Kachitvichyanukul,  V. and Schmeiser, B.   W.  Binomial Random Variate
  157. Generation.  Communications of the ACM, 31, 2 (February, 1988) 216.
  158.  
  159.                                Poisson
  160.  
  161. This code was obtained from netlib.
  162.  
  163. Ahrens,  J.H. and Dieter, U.   Computer Generation of Poisson Deviates
  164. From Modified  Normal Distributions.  ACM Trans.  Math. Software, 8, 2
  165. (June 1982),163-179
  166.  
  167.  
  168.  
  169.  
  170.                                  Beta
  171.  
  172. This code was written by us following the recipe in the following.
  173.  
  174. R. C.  H.   Cheng Generating  Beta Variables  with  Nonintegral  Shape
  175. Parameters. Communications of  the ACM,  21:317-322 (1978) (Algorithms
  176. BB and BC)
  177.  
  178.                                Linpack
  179.  
  180. Routines SPOFA and SDOT are used to perform the Cholesky decomposition
  181. of  the covariance  matrix  in  SETGMN  (used  for  the  generation of
  182. multivariate normal deviates).
  183.  
  184. Dongarra, J.  J., Moler,   C.  B., Bunch, J.   R. and  Stewart, G.  W.
  185. Linpack User's Guide.  SIAM Press, Philadelphia.  (1979)
  186.  
  187.  
  188.                               LEGALITIES
  189.  
  190. Code that appeared  in an    ACM  publication  is subject  to    their
  191. algorithms policy:
  192.  
  193.      Submittal of  an  algorithm    for publication  in   one of   the  ACM
  194.      Transactions implies that unrestricted use  of the algorithm within  a
  195.      computer is permissible.   General permission  to copy and  distribute
  196.      the algorithm without fee is granted provided that the copies  are not
  197.      made  or   distributed for  direct   commercial  advantage.    The ACM
  198.      copyright notice and the title of the publication and its date appear,
  199.      and  notice is given that copying  is by permission of the Association
  200.      for Computing Machinery.  To copy otherwise, or to republish, requires
  201.      a fee and/or specific permission.
  202.  
  203.      Krogh, F.  Algorithms  Policy.  ACM  Tran.   Math.  Softw.   13(1987),
  204.      183-186.
  205.  
  206. We place the Ranlib code that we have written in the public domain.  
  207.  
  208.                                  NO WARRANTY
  209.      
  210.      WE PROVIDE ABSOLUTELY  NO WARRANTY  OF ANY  KIND  EITHER  EXPRESSED OR
  211.      IMPLIED,  INCLUDING BUT   NOT LIMITED TO,  THE  IMPLIED  WARRANTIES OF
  212.      MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK
  213.      AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS  WITH YOU.  SHOULD
  214.      THIS PROGRAM PROVE  DEFECTIVE, YOU ASSUME  THE COST  OF  ALL NECESSARY
  215.      SERVICING, REPAIR OR CORRECTION.
  216.      
  217.      IN NO  EVENT  SHALL THE UNIVERSITY  OF TEXAS OR  ANY  OF ITS COMPONENT
  218.      INSTITUTIONS INCLUDING M. D.   ANDERSON HOSPITAL BE LIABLE  TO YOU FOR
  219.      DAMAGES, INCLUDING ANY  LOST PROFITS, LOST MONIES,   OR OTHER SPECIAL,
  220.      INCIDENTAL   OR  CONSEQUENTIAL DAMAGES   ARISING   OUT  OF  THE USE OR
  221.      INABILITY TO USE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA OR
  222.      ITS ANALYSIS BEING  RENDERED INACCURATE OR  LOSSES SUSTAINED  BY THIRD
  223.      PARTIES) THE PROGRAM.
  224.      
  225.      (Above NO WARRANTY modified from the GNU NO WARRANTY statement.)
  226.