time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

repl.txt (3410B)

      1 
      2 {{alias}}()
      3     Returns a pseudorandom number drawn from a standard normal distribution.
      4 
      5     Returns
      6     -------
      7     r: number
      8         Pseudorandom number.
      9 
     10     Examples
     11     --------
     12     > var r = {{alias}}();
     13 
     14 
     15 {{alias}}.factory( [options] )
     16     Returns a pseudorandom number generator (PRNG) for generating pseudorandom
     17     numbers drawn from a standard normal distribution.
     18 
     19     Parameters
     20     ----------
     21     options: Object (optional)
     22         Options.
     23 
     24     options.prng: Function (optional)
     25         Pseudorandom number generator (PRNG) for generating uniformly
     26         distributed pseudorandom numbers on the interval `[0,1)`. If provided,
     27         the `state` and `seed` options are ignored. In order to seed the
     28         returned pseudorandom number generator, one must seed the provided
     29         `prng` (assuming the provided `prng` is seedable).
     30 
     31     options.seed: integer|ArrayLikeObject<integer> (optional)
     32         Pseudorandom number generator seed. The seed may be either a positive
     33         unsigned 32-bit integer or, for arbitrary length seeds, an array-like
     34         object containing unsigned 32-bit integers.
     35 
     36     options.state: Uint32Array (optional)
     37         Pseudorandom number generator state. If provided, the `seed` option is
     38         ignored.
     39 
     40     options.copy: boolean (optional)
     41         Boolean indicating whether to copy a provided pseudorandom number
     42         generator state. Setting this option to `false` allows sharing state
     43         between two or more pseudorandom number generators. Setting this option
     44         to `true` ensures that a returned generator has exclusive control over
     45         its internal state. Default: true.
     46 
     47     Returns
     48     -------
     49     rand: Function
     50         Pseudorandom number generator (PRNG).
     51 
     52     Examples
     53     --------
     54     // Basic usage:
     55     > var rand = {{alias}}.factory();
     56     > r = rand();
     57     > r = rand();
     58 
     59 
     60 {{alias}}.NAME
     61     Generator name.
     62 
     63     Examples
     64     --------
     65     > var str = {{alias}}.NAME
     66     'box-muller'
     67 
     68 
     69 {{alias}}.PRNG
     70     Underlying pseudorandom number generator.
     71 
     72     Examples
     73     --------
     74     > var prng = {{alias}}.PRNG;
     75 
     76 
     77 {{alias}}.seed
     78     Pseudorandom number generator seed.
     79 
     80     Examples
     81     --------
     82     > var seed = {{alias}}.seed;
     83 
     84 
     85 {{alias}}.seedLength
     86     Length of generator seed.
     87 
     88     Examples
     89     --------
     90     > var len = {{alias}}.seedLength;
     91 
     92 
     93 {{alias}}.state
     94     Generator state.
     95 
     96     Examples
     97     --------
     98     > var r = {{alias}}()
     99     <number>
    100     > r = {{alias}}()
    101     <number>
    102     > r = {{alias}}()
    103     <number>
    104 
    105     // Get a copy of the current state:
    106     > var state = {{alias}}.state
    107     <Uint32Array>
    108 
    109     > r = {{alias}}()
    110     <number>
    111     > r = {{alias}}()
    112     <number>
    113 
    114     // Set the state:
    115     > {{alias}}.state = state;
    116 
    117     // Replay the last two pseudorandom numbers:
    118     > r = {{alias}}()
    119     <number>
    120     > r = {{alias}}()
    121     <number>
    122 
    123 
    124 {{alias}}.stateLength
    125     Length of generator state.
    126 
    127     Examples
    128     --------
    129     > var len = {{alias}}.stateLength;
    130 
    131 
    132 {{alias}}.byteLength
    133     Size (in bytes) of generator state.
    134 
    135     Examples
    136     --------
    137     > var sz = {{alias}}.byteLength;
    138 
    139 
    140 {{alias}}.toJSON()
    141     Serializes the pseudorandom number generator as a JSON object.
    142 
    143     Returns
    144     -------
    145     out: Object
    146         JSON representation.
    147 
    148     Examples
    149     --------
    150     > var o = {{alias}}.toJSON()
    151     { 'type': 'PRNG', 'name': '...', 'state': {...}, 'params': [] }
    152 
    153     See Also
    154     --------
    155