From 37a1e1cb2aaadfe5bb111f631935d40788edd8c9 Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Tue, 13 Jan 2026 02:48:16 +0000 Subject: [PATCH] feat: update `random` TypeScript declarations Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> --- .../@stdlib/random/docs/types/index.d.ts | 108 ++++++++++++++++++ 1 file changed, 108 insertions(+) diff --git a/lib/node_modules/@stdlib/random/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/docs/types/index.d.ts index 32a618de910e..a029d5421c4d 100644 --- a/lib/node_modules/@stdlib/random/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/random/docs/types/index.d.ts @@ -35,9 +35,11 @@ import discreteUniform = require( '@stdlib/random/discrete-uniform' ); import erlang = require( '@stdlib/random/erlang' ); import exponential = require( '@stdlib/random/exponential' ); import f = require( '@stdlib/random/f' ); +import frechet = require( '@stdlib/random/frechet' ); import gamma = require( '@stdlib/random/gamma' ); import geometric = require( '@stdlib/random/geometric' ); import gumbel = require( '@stdlib/random/gumbel' ); +import hypergeometric = require( '@stdlib/random/hypergeometric' ); import invgamma = require( '@stdlib/random/invgamma' ); import iterators = require( '@stdlib/random/iter' ); import kumaraswamy = require( '@stdlib/random/kumaraswamy' ); @@ -56,6 +58,7 @@ import streams = require( '@stdlib/random/streams' ); import strided = require( '@stdlib/random/strided' ); import t = require( '@stdlib/random/t' ); import tools = require( '@stdlib/random/tools' ); +import triangular = require( '@stdlib/random/triangular' ); import uniform = require( '@stdlib/random/uniform' ); import weibull = require( '@stdlib/random/weibull' ); @@ -511,6 +514,41 @@ interface Namespace { */ f: typeof f; + /** + * Generates pseudorandom numbers drawn from a Fréchet distribution. + * + * @param shape - output shape + * @param alpha - shape parameter + * @param s - scale parameter + * @param m - location parameter + * @param options - function options + * @throws distribution parameters and the output shape must be broadcast compatible + * @returns output ndarray + * + * @example + * var out = ns.frechet( [ 3, 3 ], 2.0, 5.0, 3.0 ); + * // returns + * + * @example + * var zeros = require( '@stdlib/ndarray/zeros' ); + * + * var out = zeros( [ 3, 3 ] ); + * // returns + * + * var v = ns.frechet.assign( 2.0, 5.0, 3.0, out ); + * // returns + * + * var bool = ( v === out ); + * // returns true + * + * @example + * var random = ns.frechet.factory(); + * + * var out = random( [ 3, 3 ], 2.0, 5.0, 3.0 ); + * // returns + */ + frechet: typeof frechet; + /** * Generates pseudorandom numbers drawn from a gamma distribution. * @@ -612,6 +650,41 @@ interface Namespace { */ gumbel: typeof gumbel; + /** + * Generates pseudorandom numbers drawn from a hypergeometric distribution. + * + * @param shape - output shape + * @param N - population size + * @param K - subpopulation size + * @param n - number of draws + * @param options - function options + * @throws distribution parameters and the output shape must be broadcast compatible + * @returns output ndarray + * + * @example + * var out = ns.hypergeometric( [ 3, 3 ], 20, 10, 7 ); + * // returns + * + * @example + * var zeros = require( '@stdlib/ndarray/zeros' ); + * + * var out = zeros( [ 3, 3 ] ); + * // returns + * + * var v = ns.hypergeometric.assign( 20, 10, 7, out ); + * // returns + * + * var bool = ( v === out ); + * // returns true + * + * @example + * var random = ns.hypergeometric.factory(); + * + * var out = random( [ 3, 3 ], 20, 10, 7 ); + * // returns + */ + hypergeometric: typeof hypergeometric; + /** * Generates pseudorandom numbers drawn from an inverse gamma distribution. * @@ -1079,6 +1152,41 @@ interface Namespace { */ tools: typeof tools; + /** + * Generates pseudorandom numbers drawn from a triangular distribution. + * + * @param shape - output shape + * @param a - minimum support + * @param b - maximum support + * @param c - mode + * @param options - function options + * @throws distribution parameters and the output shape must be broadcast compatible + * @returns output ndarray + * + * @example + * var out = ns.triangular( [ 3, 3 ], 2.0, 5.0, 3.0 ); + * // returns + * + * @example + * var zeros = require( '@stdlib/ndarray/zeros' ); + * + * var out = zeros( [ 3, 3 ] ); + * // returns + * + * var v = ns.triangular.assign( 2.0, 5.0, 3.0, out ); + * // returns + * + * var bool = ( v === out ); + * // returns true + * + * @example + * var random = ns.triangular.factory(); + * + * var out = random( [ 3, 3 ], 2.0, 5.0, 3.0 ); + * // returns + */ + triangular: typeof triangular; + /** * Generates pseudorandom numbers drawn from a continuous uniform distribution. *