About stdlib...
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, wellwritten, studied, documented, tested, measured, and highquality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
Discrete Uniform Random Numbers
Create an iterator for generating pseudorandom numbers drawn from a discrete uniform distribution.
Installation
npm install @stdlib/randomiterdiscreteuniform
Usage
var iterator = require( '@stdlib/randomiterdiscreteuniform' );
iterator( a, b[, options] )
Returns an iterator for generating pseudorandom numbers drawn from a discrete uniform distribution with parameters a
(minimum support) and b
(maximum support).
var it = iterator( 2, 2 );
// returns <Object>
var r = it.next().value;
// returns <number>
r = it.next().value;
// returns <number>
r = it.next().value;
// returns <number>
// ...
If either a
or b
is not an integer value or a > b
, the function returns throws an error.
var it = iterator( 0, 3.5 );
// throws <TypeError>
The function accepts the following options
:

prng: pseudorandom number generator for generating uniformly distributed pseudorandom integers. If provided, the function ignores both the
state
andseed
options. In order to seed the returned iterator, one must seed the providedprng
(assuming the providedprng
is seedable). 
seed: pseudorandom number generator seed. The provided PRNG must have
MIN
andMAX
properties specifying the minimum and maximum possible pseudorandom integers. 
state: a
Uint32Array
containing pseudorandom number generator state. If provided, the function ignores theseed
option. 
copy:
boolean
indicating whether to copy a provided pseudorandom number generator state. Setting this option tofalse
allows sharing state between two or more pseudorandom number generators. Setting this option totrue
ensures that a returned iterator has exclusive control over its internal pseudorandom number generator state. Default:true
.  iter: number of iterations.
To use a custom PRNG as the underlying source of uniformly distributed pseudorandom integers, set the prng
option.
var minstd = require( '@stdlib/randombaseminstd' );
var it = iterator( 2, 4, {
'prng': minstd
});
var r = it.next().value;
// returns <number>
To return an iterator having a specific initial state, set the iterator state
option.
var bool;
var it1;
var it2;
var r;
var i;
it1 = iterator( 2, 4 );
// Generate pseudorandom numbers, thus progressing the generator state:
for ( i = 0; i < 1000; i++ ) {
r = it1.next().value;
}
// Create a new iterator initialized to the current state of `it1`:
it2 = iterator( 2, 4, {
'state': it1.state
});
// Test that the generated pseudorandom numbers are the same:
bool = ( it1.next().value === it2.next().value );
// returns true
To seed the iterator, set the seed
option.
var it1 = iterator( 2, 4, {
'seed': 12345
});
var r1 = it1.next().value;
// returns <number>
var it2 = iterator( 2, 4, {
'seed': 12345
});
var r2 = it2.next().value;
// returns <number>
var bool = ( r1 === r2 );
// returns true
To limit the number of iterations, set the iter
option.
var it = iterator( 2, 4, {
'iter': 2
});
var r = it.next().value;
// returns <number>
r = it.next().value;
// returns <number>
r = it.next().done;
// returns true
The returned iterator protocolcompliant object has the following properties:

next: function which returns an iterator protocolcompliant object containing the next iterated value (if one exists) assigned to a
value
property and adone
property having aboolean
value indicating whether the iterator is finished.  return: function which closes an iterator and returns a single (optional) argument in an iterator protocolcompliant object.

seed: pseudorandom number generator seed. If provided a
prng
option, the property value isnull
. 
seedLength: length of generator seed. If provided a
prng
option, the property value isnull
. 
state: writable property for getting and setting the generator state. If provided a
prng
option, the property value isnull
. 
stateLength: length of generator state. If provided a
prng
option, the property value isnull
. 
byteLength: size (in bytes) of generator state. If provided a
prng
option, the property value isnull
.  PRNG: underlying pseudorandom number generator.
Notes
 If an environment supports
Symbol.iterator
, the returned iterator is iterable.  If PRNG state is "shared" (meaning a state array was provided during iterator creation and not copied) and one sets the underlying generator state to a state array having a different length, the iterator does not update the existing shared state and, instead, points to the newly provided state array. In order to synchronize the output of the underlying generator according to the new shared state array, the state array for each relevant iterator and/or PRNG must be explicitly set.
 If PRNG state is "shared" and one sets the underlying generator state to a state array of the same length, the PRNG state is updated (along with the state of all other iterator and/or PRNGs sharing the PRNG's state array).
Examples
var iterator = require( '@stdlib/randomiterdiscreteuniform' );
var it;
var r;
// Create a seeded iterator for generating pseudorandom numbers:
it = iterator( 2, 2, {
'seed': 1234,
'iter': 10
});
// Perform manual iteration...
while ( true ) {
r = it.next();
if ( r.done ) {
break;
}
console.log( r.value );
}
See Also

@stdlib/randombase/discreteuniform
: discrete uniform distributed pseudorandom numbers.
Notice
This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.
Community
License
See LICENSE.
Copyright
Copyright © 20162023. The Stdlib Authors.