From 059dc50f1bcda48cc7455439e5ee98c5f46aa041 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 28 Jan 2024 08:14:14 +0000 Subject: [PATCH] Auto-generated commit --- array/docs/types/index.d.ts | 69 +++++++++++++++++++++++++++++++++++ strided/docs/types/index.d.ts | 6 +-- 2 files changed, 70 insertions(+), 5 deletions(-) diff --git a/array/docs/types/index.d.ts b/array/docs/types/index.d.ts index e6711dbc..421facab 100644 --- a/array/docs/types/index.d.ts +++ b/array/docs/types/index.d.ts @@ -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' ); @@ -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' ); @@ -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 + * + * @example + * var random = ns.frechet.factory( 2.0, 5.0, 3.0 ); + * + * var out = random( 10 ); + * // returns + */ + frechet: typeof frechet; + /** * Returns an array containing pseudorandom numbers drawn from a gamma distribution. * @@ -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 + * + * @example + * var random = ns.hypergeometric.factory( 20, 10, 7 ); + * + * var out = random( 10 ); + * // returns + */ + hypergeometric: typeof hypergeometric; + /** * Returns an array containing pseudorandom numbers drawn from an inverse gamma distribution. * @@ -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 + * + * @example + * var random = ns.triangular.factory( 2.0, 5.0, 3.0 ); + * + * var out = random( 10 ); + * // returns + */ + triangular: typeof triangular; + /** * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution. * diff --git a/strided/docs/types/index.d.ts b/strided/docs/types/index.d.ts index 0cabe180..48cf8ab4 100644 --- a/strided/docs/types/index.d.ts +++ b/strided/docs/types/index.d.ts @@ -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