time-to-botec

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

repl.txt (4123B)

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