All files main.js

100% Statements 63/63
100% Branches 1/1
100% Functions 0/0
100% Lines 63/63

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 643x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x  
/**
* @license Apache-2.0
*
* Copyright (c) 2025 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';
 
// MODULES //
 
var factory = require( './factory.js' );
 
 
// MAIN //
 
/**
* Returns pseudorandom numbers drawn from a geometric distribution.
*
* @name geometric
* @type {Function}
* @param {NonNegativeIntegerArray} shape - output ndarray shape
* @param {(Probability|ndarrayLike)} p - success probability
* @param {Options} [options] - options
* @param {*} [options.dtype] - output ndarray data type
* @param {string} [options.order="row-major"] - memory layout (either row-major or column-major)
* @param {string} [options.mode="throw"] - specifies how to handle indices which exceed ndarray dimensions
* @param {StringArray} [options.submode=["throw"]] - specifies how to handle subscripts which exceed ndarray dimensions on a per dimension basis
* @param {boolean} [options.readonly=false] - boolean indicating whether an ndarray should be read-only
* @throws {TypeError} first argument must be a valid shape
* @throws {TypeError} must provide valid distribution parameters
* @throws {TypeError} distribution parameters and the desired shape must be broadcast compatible
* @throws {TypeError} options argument must be an object
* @throws {TypeError} must provide valid options
* @returns {ndarray} output ndarray
*
* @example
* var arr = geometric( [ 10 ], 0.01 );
* // returns <ndarray>
*
* @example
* var arr = geometric( [ 10 ], 0.01, {
*     'dtype': 'generic'
* });
* // returns <ndarray>
*/
var geometric = factory();
 
 
// EXPORTS //
 
module.exports = geometric;