time-to-botec/squiggle/node_modules/@stdlib/random/iter/binomial/lib/index.js

51 lines
1.1 KiB
JavaScript
Raw Normal View History

/**
* @license Apache-2.0
*
* Copyright (c) 2018 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
'use strict';
/**
* Create an iterator for generating pseudorandom numbers drawn from a binomial distribution.
*
* @module @stdlib/random/iter/binomial
*
* @example
* var iterator = require( '@stdlib/random/iter/binomial' );
*
* var iter = iterator( 10, 0.3 );
*
* var r = iter.next().value;
* // returns <number>
*
* r = iter.next().value;
* // returns <number>
*
* r = iter.next().value;
* // returns <number>
*
* // ...
*/
// MODULES //
var iterator = require( './main.js' );
// EXPORTS //
module.exports = iterator;