Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -4,7 +4,7 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2026-06-04)
+## Unreleased (2026-06-05)
 
 <section class="features">
 
@@ -68,6 +68,7 @@ A total of 9 issues were closed in this release:
 
 <details>
 
+-   [`ec39d31`](https://github.com/stdlib-js/stdlib/commit/ec39d31a0239ca04c70a89fc91a9c625f61b0cb7) - **docs:** update REPL namespace documentation [(#12551)](https://github.com/stdlib-js/stdlib/pull/12551) _(by stdlib-bot)_
 -   [`7c170bd`](https://github.com/stdlib-js/stdlib/commit/7c170bda512238e72c07d5e8b0552b50887d8a7f) - **docs:** update REPL namespace documentation [(#12520)](https://github.com/stdlib-js/stdlib/pull/12520) _(by stdlib-bot)_
 -   [`dfee746`](https://github.com/stdlib-js/stdlib/commit/dfee7462421d4117f86f91f175ff2391fb35012f) - **feat:** add `Uint64` to namespace _(by Athan Reines)_
 -   [`25447e0`](https://github.com/stdlib-js/stdlib/commit/25447e07b6674c21caa6d661064be6e692e7cff9) - **docs:** update REPL namespace documentation [(#12479)](https://github.com/stdlib-js/stdlib/pull/12479) _(by stdlib-bot)_

help/data/data.csv

@@ -5176,7 +5176,7 @@ random.gumbel.seedLength,"\nrandom.gumbel.seedLength\n    Length of generator se
 random.gumbel.state,"\nrandom.gumbel.state\n    Generator state.\n\n    Examples\n    --------\n    > var out = random.gumbel( [ 3, 3 ], 2.0, 5.0 )\n    <ndarray>\n\n    // Get a copy of the current state:\n    > var state = random.gumbel.state\n    <Uint32Array>\n\n    > out = random.gumbel( [ 3, 3 ], 2.0, 5.0 )\n    <ndarray>\n    > out = random.gumbel( [ 3, 3 ], 2.0, 5.0 )\n    <ndarray>\n\n    // Set the state:\n    > random.gumbel.state = state;\n\n    // Regenerate a previous array:\n    > out = random.gumbel( [ 3, 3 ], 2.0, 5.0 )\n    <ndarray>"
 random.gumbel.stateLength,"\nrandom.gumbel.stateLength\n    Length of generator state.\n\n    Examples\n    --------\n    > var len = random.gumbel.stateLength;"
 random.gumbel.byteLength,"\nrandom.gumbel.byteLength\n    Size (in bytes) of generator state.\n\n    Examples\n    --------\n    > var sz = random.gumbel.byteLength;\n\n    See Also\n    --------\n    base.random.gumbel, random.array.gumbel"
-random.hypergeometric,"\nrandom.hypergeometric( shape, N, K, n[, options] )\n    Returns an ndarray containing pseudorandom numbers drawn from a\n    hypergeometric distribution.\n\n    Parameters\n    ----------\n    shape: Array<integer>\n        Array shape.\n\n    N: number|ndarray\n        Population size. If an ndarray, must be broadcast compatible with the\n        specified array shape.\n\n    K: number|ndarray\n        Subpopulation size. If an ndarray, must be broadcast compatible with the\n        specified array shape.\n\n    n: number|ndarray\n        Number of draws. If an ndarray, must be broadcast compatible with the\n        specified array shape.\n\n    options: Object (optional)\n        Options.\n\n    options.dtype: string|DataType (optional)\n        Array data type. Must be a real-valued or \"generic\" data type.\n\n    options.order: string (optional)\n        Specifies whether an array is row-major (C-style) or column-major\n        (Fortran-style). Default: 'row-major'.\n\n    options.mode: string (optional)\n        Specifies how to handle indices which exceed array dimensions. If equal\n        to 'throw', an ndarray instance throws an error when an index exceeds\n        array dimensions. If equal to 'wrap', an ndarray instance wraps around\n        indices exceeding array dimensions using modulo arithmetic. If equal to\n        'clamp', an ndarray instance sets an index exceeding array dimensions to\n        either `0` (minimum index) or the maximum index. Default: 'throw'.\n\n    options.submode: Array<string> (optional)\n        Specifies how to handle subscripts which exceed array dimensions. If a\n        mode for a corresponding dimension is equal to 'throw', an ndarray\n        instance throws an error when a subscript exceeds array dimensions. If\n        equal to 'wrap', an ndarray instance wraps around subscripts exceeding\n        array dimensions using modulo arithmetic. If equal to 'clamp', an\n        ndarray instance sets a subscript exceeding array dimensions to either\n        `0` (minimum index) or the maximum index. If the number of modes is\n        less than the number of dimensions, an ndarray instance recycles modes\n        using modulo arithmetic. Default: [ options.mode ].\n\n    options.readonly: boolean (optional)\n        Boolean indicating whether an array should be read-only. Default: false.\n\n    Returns\n    -------\n    out: ndarray\n        Output array.\n\n    Examples\n    --------\n    > var out = random.hypergeometric( [ 3, 3 ], 20, 10, 7 )\n    <ndarray>\n\n\nrandom.hypergeometric.assign( N, K, n, out )\n    Fills an ndarray with pseudorandom numbers drawn from a hypergeometric\n    distribution.\n\n    Parameters\n    ----------\n    N: number|ndarray\n        Population size. If an ndarray, must be broadcast compatible with the\n        provided output array.\n\n    K: number|ndarray\n        Subpopulation size. If an ndarray, must be broadcast compatible with the\n        provided output array.\n\n    n: number|ndarray\n        Number of draws. If an ndarray, must be broadcast compatible with the\n        provided output array.\n\n    out: ndarray\n        Output array.\n\n    Returns\n    -------\n    out: ndarray\n        Output array.\n\n    Examples\n    --------\n    > var out = ndzeros( [ 3, 3 ] );\n    > var v = random.hypergeometric.assign( 20, 10, 7, out )\n    <ndarray>\n    > var bool = ( v === out )\n    true\n\n\nrandom.hypergeometric.factory( [options] )\n    Returns a function for generating pseudorandom numbers drawn from a\n    hypergeometric distribution.\n\n    The returned function has the same signature and accepts the same options as\n    `random.hypergeometric` above.\n\n    Parameters\n    ----------\n    options: Object (optional)\n        Options.\n\n    options.prng: Function (optional)\n        Pseudorandom number generator (PRNG) for generating uniformly\n        distributed pseudorandom numbers on the interval `[0,1)`. If provided,\n        the `state` and `seed` options are ignored. In order to seed the\n        returned pseudorandom number generator, one must seed the provided\n        `prng` (assuming the provided `prng` is seedable).\n\n    options.seed: integer|ArrayLikeObject<integer> (optional)\n        Pseudorandom number generator seed. The seed may be either a positive\n        unsigned 32-bit integer or, for arbitrary length seeds, an array-like\n        object containing unsigned 32-bit integers.\n\n    options.state: Uint32Array (optional)\n        Pseudorandom number generator state. If provided, the `seed` option is\n        ignored.\n\n    options.copy: boolean (optional)\n        Boolean indicating whether to copy a provided pseudorandom number\n        generator state. Setting this option to `false` allows sharing state\n        between two or more pseudorandom number generators. Setting this option\n        to `true` ensures that a returned generator has exclusive control over\n        its internal state. Default: true.\n\n    Returns\n    -------\n    fcn: Function\n        Function for creating arrays.\n\n    Examples\n    --------\n    > var fcn = random.hypergeometric.factory();\n    > var out = fcn( [ 3, 3 ], 20, 10, 7 )\n    <ndarray>\n\n\nrandom.hypergeometric.PRNG\n    Underlying pseudorandom number generator.\n\n    Examples\n    --------\n    > var prng = random.hypergeometric.PRNG;\n\n\nrandom.hypergeometric.seed\n    Pseudorandom number generator seed.\n\n    Examples\n    --------\n    > var seed = random.hypergeometric.seed;\n\n\nrandom.hypergeometric.seedLength\n    Length of generator seed.\n\n    Examples\n    --------\n    > var len = random.hypergeometric.seedLength;\n\n\nrandom.hypergeometric.state\n    Generator state.\n\n    Examples\n    --------\n    > var out = random.hypergeometric( [ 3, 3 ], 20, 10, 7 )\n    <ndarray>\n\n    // Get a copy of the current state:\n    > var state = random.hypergeometric.state\n    <Uint32Array>\n\n    > out = random.hypergeometric( [ 3, 3 ], 20, 10, 7 )\n    <ndarray>\n    > out = random.hypergeometric( [ 3, 3 ], 20, 10, 7 )\n    <ndarray>\n\n    // Set the state:\n    > random.hypergeometric.state = state;\n\n    // Regenerate a previous array:\n    > out = random.hypergeometric( [ 3, 3 ], 20, 10, 7 )\n    <ndarray>\n\n\nrandom.hypergeometric.stateLength\n    Length of generator state.\n\n    Examples\n    --------\n    > var len = random.hypergeometric.stateLength;\n\n\nrandom.hypergeometric.byteLength\n    Size (in bytes) of generator state.\n\n    Examples\n    --------\n    > var sz = random.hypergeometric.byteLength;\n\n    See Also\n    --------\n    base.random.hypergeometric, random.array.hypergeometric\n"
+random.hypergeometric,"\nrandom.hypergeometric( shape, N, K, n[, options] )\n    Returns an ndarray containing pseudorandom numbers drawn from a\n    hypergeometric distribution.\n\n    Parameters\n    ----------\n    shape: Array<integer>\n        Array shape.\n\n    N: number|ndarray\n        Population size. If an ndarray, must be broadcast compatible with the\n        specified array shape.\n\n    K: number|ndarray\n        Subpopulation size. If an ndarray, must be broadcast compatible with the\n        specified array shape.\n\n    n: number|ndarray\n        Number of draws. If an ndarray, must be broadcast compatible with the\n        specified array shape.\n\n    options: Object (optional)\n        Options.\n\n    options.dtype: string|DataType (optional)\n        Array data type. Must be a real or \"generic\" data type.\n\n    options.order: string (optional)\n        Specifies whether an array is row-major (C-style) or column-major\n        (Fortran-style). Default: 'row-major'.\n\n    options.mode: string (optional)\n        Specifies how to handle indices which exceed array dimensions. If equal\n        to 'throw', an ndarray instance throws an error when an index exceeds\n        array dimensions. If equal to 'wrap', an ndarray instance wraps around\n        indices exceeding array dimensions using modulo arithmetic. If equal to\n        'clamp', an ndarray instance sets an index exceeding array dimensions to\n        either `0` (minimum index) or the maximum index. Default: 'throw'.\n\n    options.submode: Array<string> (optional)\n        Specifies how to handle subscripts which exceed array dimensions. If a\n        mode for a corresponding dimension is equal to 'throw', an ndarray\n        instance throws an error when a subscript exceeds array dimensions. If\n        equal to 'wrap', an ndarray instance wraps around subscripts exceeding\n        array dimensions using modulo arithmetic. If equal to 'clamp', an\n        ndarray instance sets a subscript exceeding array dimensions to either\n        `0` (minimum index) or the maximum index. If the number of modes is\n        less than the number of dimensions, an ndarray instance recycles modes\n        using modulo arithmetic. Default: [ options.mode ].\n\n    options.readonly: boolean (optional)\n        Boolean indicating whether an array should be read-only. Default: false.\n\n    Returns\n    -------\n    out: ndarray\n        Output array.\n\n    Examples\n    --------\n    > var out = random.hypergeometric( [ 3, 3 ], 20, 10, 7 )\n    <ndarray>\n\n\nrandom.hypergeometric.assign( N, K, n, out )\n    Fills an ndarray with pseudorandom numbers drawn from a hypergeometric\n    distribution.\n\n    Parameters\n    ----------\n    N: number|ndarray\n        Population size. If an ndarray, must be broadcast compatible with the\n        provided output array.\n\n    K: number|ndarray\n        Subpopulation size. If an ndarray, must be broadcast compatible with the\n        provided output array.\n\n    n: number|ndarray\n        Number of draws. If an ndarray, must be broadcast compatible with the\n        provided output array.\n\n    out: ndarray\n        Output array.\n\n    Returns\n    -------\n    out: ndarray\n        Output array.\n\n    Examples\n    --------\n    > var out = ndzeros( [ 3, 3 ] );\n    > var v = random.hypergeometric.assign( 20, 10, 7, out )\n    <ndarray>\n    > var bool = ( v === out )\n    true\n\n\nrandom.hypergeometric.factory( [options] )\n    Returns a function for generating pseudorandom numbers drawn from a\n    hypergeometric distribution.\n\n    The returned function has the same signature and accepts the same options as\n    `random.hypergeometric` above.\n\n    Parameters\n    ----------\n    options: Object (optional)\n        Options.\n\n    options.prng: Function (optional)\n        Pseudorandom number generator (PRNG) for generating uniformly\n        distributed pseudorandom numbers on the interval `[0,1)`. If provided,\n        the `state` and `seed` options are ignored. In order to seed the\n        returned pseudorandom number generator, one must seed the provided\n        `prng` (assuming the provided `prng` is seedable).\n\n    options.seed: integer|ArrayLikeObject<integer> (optional)\n        Pseudorandom number generator seed. The seed may be either a positive\n        unsigned 32-bit integer or, for arbitrary length seeds, an array-like\n        object containing unsigned 32-bit integers.\n\n    options.state: Uint32Array (optional)\n        Pseudorandom number generator state. If provided, the `seed` option is\n        ignored.\n\n    options.copy: boolean (optional)\n        Boolean indicating whether to copy a provided pseudorandom number\n        generator state. Setting this option to `false` allows sharing state\n        between two or more pseudorandom number generators. Setting this option\n        to `true` ensures that a returned generator has exclusive control over\n        its internal state. Default: true.\n\n    Returns\n    -------\n    fcn: Function\n        Function for creating arrays.\n\n    Examples\n    --------\n    > var fcn = random.hypergeometric.factory();\n    > var out = fcn( [ 3, 3 ], 20, 10, 7 )\n    <ndarray>\n\n\nrandom.hypergeometric.PRNG\n    Underlying pseudorandom number generator.\n\n    Examples\n    --------\n    > var prng = random.hypergeometric.PRNG;\n\n\nrandom.hypergeometric.seed\n    Pseudorandom number generator seed.\n\n    Examples\n    --------\n    > var seed = random.hypergeometric.seed;\n\n\nrandom.hypergeometric.seedLength\n    Length of generator seed.\n\n    Examples\n    --------\n    > var len = random.hypergeometric.seedLength;\n\n\nrandom.hypergeometric.state\n    Generator state.\n\n    Examples\n    --------\n    > var out = random.hypergeometric( [ 3, 3 ], 20, 10, 7 )\n    <ndarray>\n\n    // Get a copy of the current state:\n    > var state = random.hypergeometric.state\n    <Uint32Array>\n\n    > out = random.hypergeometric( [ 3, 3 ], 20, 10, 7 )\n    <ndarray>\n    > out = random.hypergeometric( [ 3, 3 ], 20, 10, 7 )\n    <ndarray>\n\n    // Set the state:\n    > random.hypergeometric.state = state;\n\n    // Regenerate a previous array:\n    > out = random.hypergeometric( [ 3, 3 ], 20, 10, 7 )\n    <ndarray>\n\n\nrandom.hypergeometric.stateLength\n    Length of generator state.\n\n    Examples\n    --------\n    > var len = random.hypergeometric.stateLength;\n\n\nrandom.hypergeometric.byteLength\n    Size (in bytes) of generator state.\n\n    Examples\n    --------\n    > var sz = random.hypergeometric.byteLength;\n\n    See Also\n    --------\n    base.random.hypergeometric, random.array.hypergeometric\n"
 random.hypergeometric.assign,"\nrandom.hypergeometric.assign( N, K, n, out )\n    Fills an ndarray with pseudorandom numbers drawn from a hypergeometric\n    distribution.\n\n    Parameters\n    ----------\n    N: number|ndarray\n        Population size. If an ndarray, must be broadcast compatible with the\n        provided output array.\n\n    K: number|ndarray\n        Subpopulation size. If an ndarray, must be broadcast compatible with the\n        provided output array.\n\n    n: number|ndarray\n        Number of draws. If an ndarray, must be broadcast compatible with the\n        provided output array.\n\n    out: ndarray\n        Output array.\n\n    Returns\n    -------\n    out: ndarray\n        Output array.\n\n    Examples\n    --------\n    > var out = ndzeros( [ 3, 3 ] );\n    > var v = random.hypergeometric.assign( 20, 10, 7, out )\n    <ndarray>\n    > var bool = ( v === out )\n    true"
 random.hypergeometric.factory,"\nrandom.hypergeometric.factory( [options] )\n    Returns a function for generating pseudorandom numbers drawn from a\n    hypergeometric distribution.\n\n    The returned function has the same signature and accepts the same options as\n    `random.hypergeometric` above.\n\n    Parameters\n    ----------\n    options: Object (optional)\n        Options.\n\n    options.prng: Function (optional)\n        Pseudorandom number generator (PRNG) for generating uniformly\n        distributed pseudorandom numbers on the interval `[0,1)`. If provided,\n        the `state` and `seed` options are ignored. In order to seed the\n        returned pseudorandom number generator, one must seed the provided\n        `prng` (assuming the provided `prng` is seedable).\n\n    options.seed: integer|ArrayLikeObject<integer> (optional)\n        Pseudorandom number generator seed. The seed may be either a positive\n        unsigned 32-bit integer or, for arbitrary length seeds, an array-like\n        object containing unsigned 32-bit integers.\n\n    options.state: Uint32Array (optional)\n        Pseudorandom number generator state. If provided, the `seed` option is\n        ignored.\n\n    options.copy: boolean (optional)\n        Boolean indicating whether to copy a provided pseudorandom number\n        generator state. Setting this option to `false` allows sharing state\n        between two or more pseudorandom number generators. Setting this option\n        to `true` ensures that a returned generator has exclusive control over\n        its internal state. Default: true.\n\n    Returns\n    -------\n    fcn: Function\n        Function for creating arrays.\n\n    Examples\n    --------\n    > var fcn = random.hypergeometric.factory();\n    > var out = fcn( [ 3, 3 ], 20, 10, 7 )\n    <ndarray>"
 random.hypergeometric.PRNG,"\nrandom.hypergeometric.PRNG\n    Underlying pseudorandom number generator.\n\n    Examples\n    --------\n    > var prng = random.hypergeometric.PRNG;"