index.js (1143B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2018 The Stdlib Authors. 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 'use strict'; 20 21 /** 22 * Create an iterator for generating pseudorandom numbers drawn from a geometric distribution. 23 * 24 * @module @stdlib/random/iter/geometric 25 * 26 * @example 27 * var iterator = require( '@stdlib/random/iter/geometric' ); 28 * 29 * var iter = iterator( 0.3 ); 30 * 31 * var r = iter.next().value; 32 * // returns <number> 33 * 34 * r = iter.next().value; 35 * // returns <number> 36 * 37 * r = iter.next().value; 38 * // returns <number> 39 * 40 * // ... 41 */ 42 43 // MODULES // 44 45 var iterator = require( './main.js' ); 46 47 48 // EXPORTS // 49 50 module.exports = iterator;