Skip to content

Commit

Permalink
Auto-generated commit
Browse files Browse the repository at this point in the history
  • Loading branch information
stdlib-bot committed Jan 28, 2024
1 parent 9dc47bb commit 059dc50
Show file tree
Hide file tree
Showing 2 changed files with 70 additions and 5 deletions.
69 changes: 69 additions & 0 deletions array/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,11 @@ import discreteUniform = require( './../../../array/discrete-uniform' );
import erlang = require( './../../../array/erlang' );
import exponential = require( './../../../array/exponential' );
import f = require( './../../../array/f' );
import frechet = require( './../../../array/frechet' );
import gamma = require( './../../../array/gamma' );
import geometric = require( './../../../array/geometric' );
import gumbel = require( './../../../array/gumbel' );
import hypergeometric = require( './../../../array/hypergeometric' );
import invgamma = require( './../../../array/invgamma' );
import kumaraswamy = require( './../../../array/kumaraswamy' );
import laplace = require( './../../../array/laplace' );
Expand All @@ -52,6 +54,7 @@ import poisson = require( './../../../array/poisson' );
import randu = require( './../../../array/randu' );
import rayleigh = require( './../../../array/rayleigh' );
import t = require( './../../../array/t' );
import triangular = require( './../../../array/triangular' );
import uniform = require( './../../../array/uniform' );
import weibull = require( './../../../array/weibull' );

Expand Down Expand Up @@ -328,6 +331,28 @@ interface Namespace {
*/
f: typeof f;

/**
* Returns an array containing pseudorandom numbers drawn from a Fréchet distribution.
*
* @param len - array length
* @param alpha - shape parameter
* @param s - scale parameter
* @param m - location parameter
* @param options - function options
* @returns output array
*
* @example
* var out = ns.frechet( 10, 2.0, 5.0, 3.0 );
* // returns <Float64Array>
*
* @example
* var random = ns.frechet.factory( 2.0, 5.0, 3.0 );
*
* var out = random( 10 );
* // returns <Float64Array>
*/
frechet: typeof frechet;

/**
* Returns an array containing pseudorandom numbers drawn from a gamma distribution.
*
Expand Down Expand Up @@ -390,6 +415,28 @@ interface Namespace {
*/
gumbel: typeof gumbel;

/**
* Returns an array containing pseudorandom numbers drawn from a hypergeometric distribution.
*
* @param len - array length
* @param N - population size
* @param K - subpopulation size
* @param n - number of draws
* @param options - function options
* @returns output array
*
* @example
* var out = ns.hypergeometric( 10, 20, 10, 7 );
* // returns <Float64Array>
*
* @example
* var random = ns.hypergeometric.factory( 20, 10, 7 );
*
* var out = random( 10 );
* // returns <Float64Array>
*/
hypergeometric: typeof hypergeometric;

/**
* Returns an array containing pseudorandom numbers drawn from an inverse gamma distribution.
*
Expand Down Expand Up @@ -727,6 +774,28 @@ interface Namespace {
*/
t: typeof t;

/**
* Returns an array containing pseudorandom numbers drawn from a triangular distribution.
*
* @param len - array length
* @param a - minimum support
* @param b - maximum support
* @param c - mode
* @param options - function options
* @returns output array
*
* @example
* var out = ns.triangular( 10, 2.0, 5.0, 3.0 );
* // returns <Float64Array>
*
* @example
* var random = ns.triangular.factory( 2.0, 5.0, 3.0 );
*
* var out = random( 10 );
* // returns <Float64Array>
*/
triangular: typeof triangular;

/**
* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution.
*
Expand Down
6 changes: 1 addition & 5 deletions strided/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -226,13 +226,9 @@ interface Namespace {
*
* @param N - number of indexed elements
* @param lambda - rate parameter
* @param sl - `lambda` strided length
* @param sl - `lambda` stride length
* @param out - output array
* @param so - `out` stride length
* @param options - function options
* @throws must provide valid distribution parameters
* @throws must provide valid options
* @throws must provide a valid state
* @returns output array
*
* @example
Expand Down

0 comments on commit 059dc50

Please sign in to comment.