repl.txt

{{alias}}( len, a, b[, options] )
    Returns an array containing pseudorandom numbers drawn from a discrete
    uniform distribution.

    Parameters
    ----------
    len: integer
        Output array length.

    a: number
        Minimum support.

    b: number
        Maximum support.

    options: Object (optional)
        Options.

    options.dtype: string (optional)
        Output array data type. Default: 'float64'.

    Returns
    -------
    out: Array<number>|TypedArray
        Output array.

    Examples
    --------
    > var out = {{alias}}( 3, -10, 10 )
    <Float64Array>


{{alias}}.assign( a, b, out )
    Fills an array with pseudorandom numbers drawn from a discrete uniform
    distribution.

    Parameters
    ----------
    a: number
        Minimum support.

    b: number
        Maximum support.

    out: Array<number>|TypedArray
        Output array.

    Returns
    -------
    out: Array<number>|TypedArray
        Output array.

    Examples
    --------
    > var x = {{alias:@stdlib/array/zeros}}( 3, 'float64' );
    > var out = {{alias}}.assign( -10, 10, x )
    <Float64Array>
    > var bool = ( out === x )
    true


{{alias}}.factory( [a, b, ][options] )
    Returns a function for creating arrays containing pseudorandom numbers drawn
    from a discrete uniform distribution.

    If provided distribution parameters, the returned function returns random
    variates drawn from the specified distribution.

    If not provided distribution parameters, the returned function requires that
    distribution parameters be provided at each invocation.

    The returned function accepts the following options:

    - dtype: output array data type. This overrides the default output array
    data type.

    Parameters
    ----------
    a: number (optional)
        Minimum support.

    b: number (optional)
        Maximum support.

    options: Object (optional)
        Options.

    options.prng: Function (optional)
        Pseudorandom number generator (PRNG) for generating uniformly
        distributed pseudorandom integers. If provided, the `state` and `seed`
        options are ignored. In order to seed the returned pseudorandom number
        generator, one must seed the provided `prng` (assuming the provided
        `prng` is seedable). The provided PRNG must have `MIN` and `MAX`
        properties specifying the minimum and maximum possible pseudorandom
        integers.

    options.seed: integer|ArrayLikeObject<integer> (optional)
        Pseudorandom number generator seed. The seed may be either a positive
        unsigned 32-bit integer or, for arbitrary length seeds, an array-like
        object containing unsigned 32-bit integers.

    options.state: Uint32Array (optional)
        Pseudorandom number generator state. If provided, the `seed` option is
        ignored.

    options.copy: boolean (optional)
        Boolean indicating whether to copy a provided pseudorandom number
        generator state. Setting this option to `false` allows sharing state
        between two or more pseudorandom number generators. Setting this option
        to `true` ensures that a returned generator has exclusive control over
        its internal state. Default: true.

    options.dtype: string (optional)
        Default output array data type. Default: 'float64'.

    Returns
    -------
    fcn: Function
        Function for creating arrays.

    Examples
    --------
    > var fcn = {{alias}}.factory();
    > var out = fcn( 3, -10, 10 )
    <Float64Array>

    // Provide distribution parameters:
    > fcn = {{alias}}.factory( -10, 10 );
    > out = fcn( 3 )
    <Float64Array>


{{alias}}.PRNG
    Underlying pseudorandom number generator.

    Examples
    --------
    > var prng = {{alias}}.PRNG;


{{alias}}.seed
    Pseudorandom number generator seed.

    Examples
    --------
    > var seed = {{alias}}.seed;


{{alias}}.seedLength
    Length of generator seed.

    Examples
    --------
    > var len = {{alias}}.seedLength;


{{alias}}.state
    Generator state.

    Examples
    --------
    > var out = {{alias}}( 3, -10, 10 )
    <Float64Array>

    // Get a copy of the current state:
    > var state = {{alias}}.state
    <Uint32Array>

    > out = {{alias}}( 3, -10, 10 )
    <Float64Array>
    > out = {{alias}}( 3, -10, 10 )
    <Float64Array>

    // Set the state:
    > {{alias}}.state = state;

    // Regenerate a previous array:
    > out = {{alias}}( 3, -10, 10 )
    <Float64Array>


{{alias}}.stateLength
    Length of generator state.

    Examples
    --------
    > var len = {{alias}}.stateLength;


{{alias}}.byteLength
    Size (in bytes) of generator state.

    Examples
    --------
    > var sz = {{alias}}.byteLength;

    See Also
    --------