Skip to content
About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

Exponential Random Numbers

NPM versionBuild StatusCoverage Status

Generate pseudorandom numbers drawn from an exponential distribution.

Installation

npm install @stdlib/random-exponential

Alternatively,

  • To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
  • If you are using Deno, visit the deno branch (see README for usage intructions).
  • For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

Usage

varexponential=require('@stdlib/random-exponential');

exponential( shape, lambda[, options] )

Returns an ndarray containing pseudorandom numbers drawn from an exponential distribution.

vararr=exponential([3,3],2.0);// returns <ndarray>

The function has the following parameters:

  • shape: output shape.
  • lambda: rate parameter. May be either a scalar or an ndarray. When providing an ndarray, the ndarray must be broadcast compatible with the specified output shape.
  • options: function options.

When provided a scalar distribution parameter, every element in the output ndarray is drawn from the same distribution. To generate pseudorandom numbers drawn from different distributions, provide a distribution parameter argument as an ndarray. The following example demonstrates broadcasting an ndarray containing distribution parameters to generate sub-matrices drawn from different distributions.

vargetShape=require('@stdlib/ndarray-shape');vararray=require('@stdlib/ndarray-array');varlambda=array([[[2.0]],[[10.0]]]);// returns <ndarray>varshape=getShape(lambda);// returns [ 2, 1, 1 ]vararr=exponential([2,3,3],lambda);// returns <ndarray>

If provided an empty shape, the function returns a zero-dimensional ndarray.

vargetShape=require('@stdlib/ndarray-shape');vararr=exponential([],2.0);// returns <ndarray>varshape=getShape(arr);// returns []varv=arr.get();// returns <number>

The function accepts the following options:

  • dtype: output ndarray data type. Must be a real-valued floating-point or "generic" data type.
  • order: ndarray order (i.e., memory layout), which is either row-major (C-style) or column-major (Fortran-style). Default: 'row-major'.
  • mode: specifies how to handle indices which exceed ndarray dimensions. For a list of supported modes, see ndarray. Default: 'throw'.
  • submode: a mode array which specifies for each dimension how to handle subscripts which exceed ndarray dimensions. If provided fewer modes than dimensions, an ndarray instance recycles modes using modulo arithmetic. Default: [ options.mode ].
  • readonly: boolean indicating whether an ndarray should be read-only. Default: false.

By default, the function returns an ndarray having a data type determined by the function's output data type policy. To override the default behavior, set the dtype option.

vargetDType=require('@stdlib/ndarray-dtype');varopts={'dtype': 'generic'};vararr=exponential([3,3],2.0,opts);// returns <ndarray>vardt=String(getDType(arr));// returns 'generic'

exponential.assign( lambda, out )

Fills an ndarray with pseudorandom numbers drawn from an exponential distribution.

varzeros=require('@stdlib/ndarray-zeros');varout=zeros([3,3]);// returns <ndarray>varv=exponential.assign(2.0,out);// returns <ndarray>varbool=(v===out);// returns true

The method has the following parameters:

exponential.factory( [options] )

Returns a function for generating pseudorandom numbers drawn from an exponential distribution.

vargetShape=require('@stdlib/ndarray-shape');varrandom=exponential.factory();varout=random([3,3],2.0);// returns <ndarray>varsh=getShape(out);// returns [ 3, 3 ]

The method accepts the following options:

  • prng: pseudorandom number generator for generating uniformly distributed pseudorandom numbers on the interval [0,1). If provided, the function ignores both the state and seed options. In order to seed the underlying pseudorandom number generator, one must seed the provided prng (assuming the provided prng is seedable).
  • seed: pseudorandom number generator seed.
  • state: a Uint32Array containing pseudorandom number generator state. If provided, the function ignores the seed option.
  • copy: boolean indicating whether to copy a provided pseudorandom number generator state. Setting this option to false allows sharing state between two or more pseudorandom number generators. Setting this option to true ensures that an underlying generator has exclusive control over its internal state. Default: true.

To use a custom PRNG as the underlying source of uniformly distributed pseudorandom numbers, set the prng option.

varminstd=require('@stdlib/random-base-minstd');varopts={'prng': minstd.normalized};varrandom=exponential.factory(opts);varout=random([3,3],2.0);// returns <ndarray>

To seed the underlying pseudorandom number generator, set the seed option.

varopts={'seed': 12345};varrandom=exponential.factory(opts);varout=random([3,3],2.0);// returns <ndarray>

The function returned by the factory method has the same interface and accepts the same options as the exponential function above.

exponential.PRNG

The underlying pseudorandom number generator.

varprng=exponential.PRNG;// returns <Function>

exponential.seed

The value used to seed the underlying pseudorandom number generator.

varseed=exponential.seed;// returns <Uint32Array>

If the factory method is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

varminstd=require('@stdlib/random-base-minstd-shuffle').normalized;varrandom=exponential.factory({'prng': minstd});varseed=random.seed;// returns null

exponential.seedLength

Length of underlying pseudorandom number generator seed.

varlen=exponential.seedLength;// returns <number>

If the factory method is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

varminstd=require('@stdlib/random-base-minstd-shuffle').normalized;varrandom=exponential.factory({'prng': minstd});varlen=random.seedLength;// returns null

exponential.state

Writable property for getting and setting the underlying pseudorandom number generator state.

varstate=exponential.state;// returns <Uint32Array>

If the factory method is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

varminstd=require('@stdlib/random-base-minstd-shuffle').normalized;varrandom=exponential.factory({'prng': minstd});varstate=random.state;// returns null

exponential.stateLength

Length of underlying pseudorandom number generator state.

varlen=exponential.stateLength;// returns <number>

If the factory method is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

varminstd=require('@stdlib/random-base-minstd-shuffle').normalized;varrandom=exponential.factory({'prng': minstd});varlen=random.stateLength;// returns null

exponential.byteLength

Size (in bytes) of underlying pseudorandom number generator state.

varsz=exponential.byteLength;// returns <number>

If the factory method is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

varminstd=require('@stdlib/random-base-minstd-shuffle').normalized;varrandom=exponential.factory({'prng': minstd});varsz=random.byteLength;// returns null

Notes

  • If PRNG state is "shared" (meaning a state array was provided during function creation and not copied) and one sets the underlying generator state to a state array having a different length, the function returned by the factory method does not update the existing shared state and, instead, points to the newly provided state array. In order to synchronize the output of the underlying generator according to the new shared state array, the state array for each relevant creation function and/or PRNG must be explicitly set.
  • If PRNG state is "shared" and one sets the underlying generator state to a state array of the same length, the PRNG state is updated (along with the state of all other creation functions and/or PRNGs sharing the PRNG's state array).
  • The output data type policy only applies to the main function and specifies that, by default, the function must return an ndarray having a real-valued floating-point or "generic" data type. For the assign method, the output ndarray is allowed to have any supported output data type.

Examples

varlogEach=require('@stdlib/console-log-each');varndarray2array=require('@stdlib/ndarray-to-array');varexponential=require('@stdlib/random-exponential');// Create a function for generating random arrays originating from the same state:varrandom=exponential.factory({'state': exponential.state,'copy': true});// Generate 3 one-dimensional arrays:varx1=random([5],2.0);varx2=random([5],2.0);varx3=random([5],2.0);// Print the contents:logEach('%f, %f, %f',ndarray2array(x1),ndarray2array(x2),ndarray2array(x3));// Create another function for generating random arrays with the original state:random=exponential.factory({'state': exponential.state,'copy': true});// Generate a two-dimensional array which replicates the above pseudorandom number generation sequence:varx4=random([3,5],2.0);// Convert to a list of nested arrays:vararr=ndarray2array(x4);// Print the contents:console.log('');logEach('%f, %f, %f',arr[0],arr[1],arr[2]);

See Also


Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2026. The Stdlib Authors.

Releases

Sponsor this project

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
GitHub - stdlib-js/random-exponential: Generate pseudorandom numbers drawn from an exponential distribution. · GitHub
Skip to content
About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

Exponential Random Numbers

NPM versionBuild StatusCoverage Status

Generate pseudorandom numbers drawn from an exponential distribution.

Installation

npm install @stdlib/random-exponential

Alternatively,

  • To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
  • If you are using Deno, visit the deno branch (see README for usage intructions).
  • For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

Usage

varexponential=require('@stdlib/random-exponential');

exponential( shape, lambda[, options] )

Returns an ndarray containing pseudorandom numbers drawn from an exponential distribution.

vararr=exponential([3,3],2.0);// returns <ndarray>

The function has the following parameters:

  • shape: output shape.
  • lambda: rate parameter. May be either a scalar or an ndarray. When providing an ndarray, the ndarray must be broadcast compatible with the specified output shape.
  • options: function options.

When provided a scalar distribution parameter, every element in the output ndarray is drawn from the same distribution. To generate pseudorandom numbers drawn from different distributions, provide a distribution parameter argument as an ndarray. The following example demonstrates broadcasting an ndarray containing distribution parameters to generate sub-matrices drawn from different distributions.

vargetShape=require('@stdlib/ndarray-shape');vararray=require('@stdlib/ndarray-array');varlambda=array([[[2.0]],[[10.0]]]);// returns <ndarray>varshape=getShape(lambda);// returns [ 2, 1, 1 ]vararr=exponential([2,3,3],lambda);// returns <ndarray>

If provided an empty shape, the function returns a zero-dimensional ndarray.

vargetShape=require('@stdlib/ndarray-shape');vararr=exponential([],2.0);// returns <ndarray>varshape=getShape(arr);// returns []varv=arr.get();// returns <number>

The function accepts the following options:

  • dtype: output ndarray data type. Must be a real-valued floating-point or "generic" data type.
  • order: ndarray order (i.e., memory layout), which is either row-major (C-style) or column-major (Fortran-style). Default: 'row-major'.
  • mode: specifies how to handle indices which exceed ndarray dimensions. For a list of supported modes, see ndarray. Default: 'throw'.
  • submode: a mode array which specifies for each dimension how to handle subscripts which exceed ndarray dimensions. If provided fewer modes than dimensions, an ndarray instance recycles modes using modulo arithmetic. Default: [ options.mode ].
  • readonly: boolean indicating whether an ndarray should be read-only. Default: false.

By default, the function returns an ndarray having a data type determined by the function's output data type policy. To override the default behavior, set the dtype option.

vargetDType=require('@stdlib/ndarray-dtype');varopts={'dtype': 'generic'};vararr=exponential([3,3],2.0,opts);// returns <ndarray>vardt=String(getDType(arr));// returns 'generic'

exponential.assign( lambda, out )

Fills an ndarray with pseudorandom numbers drawn from an exponential distribution.

varzeros=require('@stdlib/ndarray-zeros');varout=zeros([3,3]);// returns <ndarray>varv=exponential.assign(2.0,out);// returns <ndarray>varbool=(v===out);// returns true

The method has the following parameters:

exponential.factory( [options] )

Returns a function for generating pseudorandom numbers drawn from an exponential distribution.

vargetShape=require('@stdlib/ndarray-shape');varrandom=exponential.factory();varout=random([3,3],2.0);// returns <ndarray>varsh=getShape(out);// returns [ 3, 3 ]

The method accepts the following options:

  • prng: pseudorandom number generator for generating uniformly distributed pseudorandom numbers on the interval [0,1). If provided, the function ignores both the state and seed options. In order to seed the underlying pseudorandom number generator, one must seed the provided prng (assuming the provided prng is seedable).
  • seed: pseudorandom number generator seed.
  • state: a Uint32Array containing pseudorandom number generator state. If provided, the function ignores the seed option.
  • copy: boolean indicating whether to copy a provided pseudorandom number generator state. Setting this option to false allows sharing state between two or more pseudorandom number generators. Setting this option to true ensures that an underlying generator has exclusive control over its internal state. Default: true.

To use a custom PRNG as the underlying source of uniformly distributed pseudorandom numbers, set the prng option.

varminstd=require('@stdlib/random-base-minstd');varopts={'prng': minstd.normalized};varrandom=exponential.factory(opts);varout=random([3,3],2.0);// returns <ndarray>

To seed the underlying pseudorandom number generator, set the seed option.

varopts={'seed': 12345};varrandom=exponential.factory(opts);varout=random([3,3],2.0);// returns <ndarray>

The function returned by the factory method has the same interface and accepts the same options as the exponential function above.

exponential.PRNG

The underlying pseudorandom number generator.

varprng=exponential.PRNG;// returns <Function>

exponential.seed

The value used to seed the underlying pseudorandom number generator.

varseed=exponential.seed;// returns <Uint32Array>

If the factory method is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

varminstd=require('@stdlib/random-base-minstd-shuffle').normalized;varrandom=exponential.factory({'prng': minstd});varseed=random.seed;// returns null

exponential.seedLength

Length of underlying pseudorandom number generator seed.

varlen=exponential.seedLength;// returns <number>

If the factory method is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

varminstd=require('@stdlib/random-base-minstd-shuffle').normalized;varrandom=exponential.factory({'prng': minstd});varlen=random.seedLength;// returns null

exponential.state

Writable property for getting and setting the underlying pseudorandom number generator state.

varstate=exponential.state;// returns <Uint32Array>

If the factory method is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

varminstd=require('@stdlib/random-base-minstd-shuffle').normalized;varrandom=exponential.factory({'prng': minstd});varstate=random.state;// returns null

exponential.stateLength

Length of underlying pseudorandom number generator state.

varlen=exponential.stateLength;// returns <number>

If the factory method is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

varminstd=require('@stdlib/random-base-minstd-shuffle').normalized;varrandom=exponential.factory({'prng': minstd});varlen=random.stateLength;// returns null

exponential.byteLength

Size (in bytes) of underlying pseudorandom number generator state.

varsz=exponential.byteLength;// returns <number>

If the factory method is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

varminstd=require('@stdlib/random-base-minstd-shuffle').normalized;varrandom=exponential.factory({'prng': minstd});varsz=random.byteLength;// returns null

Notes

  • If PRNG state is "shared" (meaning a state array was provided during function creation and not copied) and one sets the underlying generator state to a state array having a different length, the function returned by the factory method does not update the existing shared state and, instead, points to the newly provided state array. In order to synchronize the output of the underlying generator according to the new shared state array, the state array for each relevant creation function and/or PRNG must be explicitly set.
  • If PRNG state is "shared" and one sets the underlying generator state to a state array of the same length, the PRNG state is updated (along with the state of all other creation functions and/or PRNGs sharing the PRNG's state array).
  • The output data type policy only applies to the main function and specifies that, by default, the function must return an ndarray having a real-valued floating-point or "generic" data type. For the assign method, the output ndarray is allowed to have any supported output data type.

Examples

varlogEach=require('@stdlib/console-log-each');varndarray2array=require('@stdlib/ndarray-to-array');varexponential=require('@stdlib/random-exponential');// Create a function for generating random arrays originating from the same state:varrandom=exponential.factory({'state': exponential.state,'copy': true});// Generate 3 one-dimensional arrays:varx1=random([5],2.0);varx2=random([5],2.0);varx3=random([5],2.0);// Print the contents:logEach('%f, %f, %f',ndarray2array(x1),ndarray2array(x2),ndarray2array(x3));// Create another function for generating random arrays with the original state:random=exponential.factory({'state': exponential.state,'copy': true});// Generate a two-dimensional array which replicates the above pseudorandom number generation sequence:varx4=random([3,5],2.0);// Convert to a list of nested arrays:vararr=ndarray2array(x4);// Print the contents:console.log('');logEach('%f, %f, %f',arr[0],arr[1],arr[2]);

See Also


Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2026. The Stdlib Authors.

Releases

Sponsor this project

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' GitHub - stdlib-js/random-exponential: Generate pseudorandom numbers drawn from an exponential distribution. · GitHub
Skip to content
About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

Exponential Random Numbers

NPM versionBuild StatusCoverage Status

Generate pseudorandom numbers drawn from an exponential distribution.

Installation

npm install @stdlib/random-exponential

Alternatively,

  • To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
  • If you are using Deno, visit the deno branch (see README for usage intructions).
  • For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

Usage

varexponential=require('@stdlib/random-exponential');

exponential( shape, lambda[, options] )

Returns an ndarray containing pseudorandom numbers drawn from an exponential distribution.

vararr=exponential([3,3],2.0);// returns <ndarray>

The function has the following parameters:

  • shape: output shape.
  • lambda: rate parameter. May be either a scalar or an ndarray. When providing an ndarray, the ndarray must be broadcast compatible with the specified output shape.
  • options: function options.

When provided a scalar distribution parameter, every element in the output ndarray is drawn from the same distribution. To generate pseudorandom numbers drawn from different distributions, provide a distribution parameter argument as an ndarray. The following example demonstrates broadcasting an ndarray containing distribution parameters to generate sub-matrices drawn from different distributions.

vargetShape=require('@stdlib/ndarray-shape');vararray=require('@stdlib/ndarray-array');varlambda=array([[[2.0]],[[10.0]]]);// returns <ndarray>varshape=getShape(lambda);// returns [ 2, 1, 1 ]vararr=exponential([2,3,3],lambda);// returns <ndarray>

If provided an empty shape, the function returns a zero-dimensional ndarray.

vargetShape=require('@stdlib/ndarray-shape');vararr=exponential([],2.0);// returns <ndarray>varshape=getShape(arr);// returns []varv=arr.get();// returns <number>

The function accepts the following options:

  • dtype: output ndarray data type. Must be a real-valued floating-point or "generic" data type.
  • order: ndarray order (i.e., memory layout), which is either row-major (C-style) or column-major (Fortran-style). Default: 'row-major'.
  • mode: specifies how to handle indices which exceed ndarray dimensions. For a list of supported modes, see ndarray. Default: 'throw'.
  • submode: a mode array which specifies for each dimension how to handle subscripts which exceed ndarray dimensions. If provided fewer modes than dimensions, an ndarray instance recycles modes using modulo arithmetic. Default: [ options.mode ].
  • readonly: boolean indicating whether an ndarray should be read-only. Default: false.

By default, the function returns an ndarray having a data type determined by the function's output data type policy. To override the default behavior, set the dtype option.

vargetDType=require('@stdlib/ndarray-dtype');varopts={'dtype': 'generic'};vararr=exponential([3,3],2.0,opts);// returns <ndarray>vardt=String(getDType(arr));// returns 'generic'

exponential.assign( lambda, out )

Fills an ndarray with pseudorandom numbers drawn from an exponential distribution.

varzeros=require('@stdlib/ndarray-zeros');varout=zeros([3,3]);// returns <ndarray>varv=exponential.assign(2.0,out);// returns <ndarray>varbool=(v===out);// returns true

The method has the following parameters:

exponential.factory( [options] )

Returns a function for generating pseudorandom numbers drawn from an exponential distribution.

vargetShape=require('@stdlib/ndarray-shape');varrandom=exponential.factory();varout=random([3,3],2.0);// returns <ndarray>varsh=getShape(out);// returns [ 3, 3 ]

The method accepts the following options:

  • prng: pseudorandom number generator for generating uniformly distributed pseudorandom numbers on the interval [0,1). If provided, the function ignores both the state and seed options. In order to seed the underlying pseudorandom number generator, one must seed the provided prng (assuming the provided prng is seedable).
  • seed: pseudorandom number generator seed.
  • state: a Uint32Array containing pseudorandom number generator state. If provided, the function ignores the seed option.
  • copy: boolean indicating whether to copy a provided pseudorandom number generator state. Setting this option to false allows sharing state between two or more pseudorandom number generators. Setting this option to true ensures that an underlying generator has exclusive control over its internal state. Default: true.

To use a custom PRNG as the underlying source of uniformly distributed pseudorandom numbers, set the prng option.

varminstd=require('@stdlib/random-base-minstd');varopts={'prng': minstd.normalized};varrandom=exponential.factory(opts);varout=random([3,3],2.0);// returns <ndarray>

To seed the underlying pseudorandom number generator, set the seed option.

varopts={'seed': 12345};varrandom=exponential.factory(opts);varout=random([3,3],2.0);// returns <ndarray>

The function returned by the factory method has the same interface and accepts the same options as the exponential function above.

exponential.PRNG

The underlying pseudorandom number generator.

varprng=exponential.PRNG;// returns <Function>

exponential.seed

The value used to seed the underlying pseudorandom number generator.

varseed=exponential.seed;// returns <Uint32Array>

If the factory method is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

varminstd=require('@stdlib/random-base-minstd-shuffle').normalized;varrandom=exponential.factory({'prng': minstd});varseed=random.seed;// returns null

exponential.seedLength

Length of underlying pseudorandom number generator seed.

varlen=exponential.seedLength;// returns <number>

If the factory method is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

varminstd=require('@stdlib/random-base-minstd-shuffle').normalized;varrandom=exponential.factory({'prng': minstd});varlen=random.seedLength;// returns null

exponential.state

Writable property for getting and setting the underlying pseudorandom number generator state.

varstate=exponential.state;// returns <Uint32Array>

If the factory method is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

varminstd=require('@stdlib/random-base-minstd-shuffle').normalized;varrandom=exponential.factory({'prng': minstd});varstate=random.state;// returns null

exponential.stateLength

Length of underlying pseudorandom number generator state.

varlen=exponential.stateLength;// returns <number>

If the factory method is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

varminstd=require('@stdlib/random-base-minstd-shuffle').normalized;varrandom=exponential.factory({'prng': minstd});varlen=random.stateLength;// returns null

exponential.byteLength

Size (in bytes) of underlying pseudorandom number generator state.

varsz=exponential.byteLength;// returns <number>

If the factory method is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

varminstd=require('@stdlib/random-base-minstd-shuffle').normalized;varrandom=exponential.factory({'prng': minstd});varsz=random.byteLength;// returns null

Notes

  • If PRNG state is "shared" (meaning a state array was provided during function creation and not copied) and one sets the underlying generator state to a state array having a different length, the function returned by the factory method does not update the existing shared state and, instead, points to the newly provided state array. In order to synchronize the output of the underlying generator according to the new shared state array, the state array for each relevant creation function and/or PRNG must be explicitly set.
  • If PRNG state is "shared" and one sets the underlying generator state to a state array of the same length, the PRNG state is updated (along with the state of all other creation functions and/or PRNGs sharing the PRNG's state array).
  • The output data type policy only applies to the main function and specifies that, by default, the function must return an ndarray having a real-valued floating-point or "generic" data type. For the assign method, the output ndarray is allowed to have any supported output data type.

Examples

varlogEach=require('@stdlib/console-log-each');varndarray2array=require('@stdlib/ndarray-to-array');varexponential=require('@stdlib/random-exponential');// Create a function for generating random arrays originating from the same state:varrandom=exponential.factory({'state': exponential.state,'copy': true});// Generate 3 one-dimensional arrays:varx1=random([5],2.0);varx2=random([5],2.0);varx3=random([5],2.0);// Print the contents:logEach('%f, %f, %f',ndarray2array(x1),ndarray2array(x2),ndarray2array(x3));// Create another function for generating random arrays with the original state:random=exponential.factory({'state': exponential.state,'copy': true});// Generate a two-dimensional array which replicates the above pseudorandom number generation sequence:varx4=random([3,5],2.0);// Convert to a list of nested arrays:vararr=ndarray2array(x4);// Print the contents:console.log('');logEach('%f, %f, %f',arr[0],arr[1],arr[2]);

See Also


Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2026. The Stdlib Authors.

Releases

Sponsor this project

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' GitHub - stdlib-js/random-exponential: Generate pseudorandom numbers drawn from an exponential distribution. · GitHub
Skip to content
About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

Exponential Random Numbers

NPM versionBuild StatusCoverage Status

Generate pseudorandom numbers drawn from an exponential distribution.

Installation

npm install @stdlib/random-exponential

Alternatively,

  • To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
  • If you are using Deno, visit the deno branch (see README for usage intructions).
  • For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

Usage

varexponential=require('@stdlib/random-exponential');

exponential( shape, lambda[, options] )

Returns an ndarray containing pseudorandom numbers drawn from an exponential distribution.

vararr=exponential([3,3],2.0);// returns <ndarray>

The function has the following parameters:

  • shape: output shape.
  • lambda: rate parameter. May be either a scalar or an ndarray. When providing an ndarray, the ndarray must be broadcast compatible with the specified output shape.
  • options: function options.

When provided a scalar distribution parameter, every element in the output ndarray is drawn from the same distribution. To generate pseudorandom numbers drawn from different distributions, provide a distribution parameter argument as an ndarray. The following example demonstrates broadcasting an ndarray containing distribution parameters to generate sub-matrices drawn from different distributions.

vargetShape=require('@stdlib/ndarray-shape');vararray=require('@stdlib/ndarray-array');varlambda=array([[[2.0]],[[10.0]]]);// returns <ndarray>varshape=getShape(lambda);// returns [ 2, 1, 1 ]vararr=exponential([2,3,3],lambda);// returns <ndarray>

If provided an empty shape, the function returns a zero-dimensional ndarray.

vargetShape=require('@stdlib/ndarray-shape');vararr=exponential([],2.0);// returns <ndarray>varshape=getShape(arr);// returns []varv=arr.get();// returns <number>

The function accepts the following options:

  • dtype: output ndarray data type. Must be a real-valued floating-point or "generic" data type.
  • order: ndarray order (i.e., memory layout), which is either row-major (C-style) or column-major (Fortran-style). Default: 'row-major'.
  • mode: specifies how to handle indices which exceed ndarray dimensions. For a list of supported modes, see ndarray. Default: 'throw'.
  • submode: a mode array which specifies for each dimension how to handle subscripts which exceed ndarray dimensions. If provided fewer modes than dimensions, an ndarray instance recycles modes using modulo arithmetic. Default: [ options.mode ].
  • readonly: boolean indicating whether an ndarray should be read-only. Default: false.

By default, the function returns an ndarray having a data type determined by the function's output data type policy. To override the default behavior, set the dtype option.

vargetDType=require('@stdlib/ndarray-dtype');varopts={'dtype': 'generic'};vararr=exponential([3,3],2.0,opts);// returns <ndarray>vardt=String(getDType(arr));// returns 'generic'

exponential.assign( lambda, out )

Fills an ndarray with pseudorandom numbers drawn from an exponential distribution.

varzeros=require('@stdlib/ndarray-zeros');varout=zeros([3,3]);// returns <ndarray>varv=exponential.assign(2.0,out);// returns <ndarray>varbool=(v===out);// returns true

The method has the following parameters:

exponential.factory( [options] )

Returns a function for generating pseudorandom numbers drawn from an exponential distribution.

vargetShape=require('@stdlib/ndarray-shape');varrandom=exponential.factory();varout=random([3,3],2.0);// returns <ndarray>varsh=getShape(out);// returns [ 3, 3 ]

The method accepts the following options:

  • prng: pseudorandom number generator for generating uniformly distributed pseudorandom numbers on the interval [0,1). If provided, the function ignores both the state and seed options. In order to seed the underlying pseudorandom number generator, one must seed the provided prng (assuming the provided prng is seedable).
  • seed: pseudorandom number generator seed.
  • state: a Uint32Array containing pseudorandom number generator state. If provided, the function ignores the seed option.
  • copy: boolean indicating whether to copy a provided pseudorandom number generator state. Setting this option to false allows sharing state between two or more pseudorandom number generators. Setting this option to true ensures that an underlying generator has exclusive control over its internal state. Default: true.

To use a custom PRNG as the underlying source of uniformly distributed pseudorandom numbers, set the prng option.

varminstd=require('@stdlib/random-base-minstd');varopts={'prng': minstd.normalized};varrandom=exponential.factory(opts);varout=random([3,3],2.0);// returns <ndarray>

To seed the underlying pseudorandom number generator, set the seed option.

varopts={'seed': 12345};varrandom=exponential.factory(opts);varout=random([3,3],2.0);// returns <ndarray>

The function returned by the factory method has the same interface and accepts the same options as the exponential function above.

exponential.PRNG

The underlying pseudorandom number generator.

varprng=exponential.PRNG;// returns <Function>

exponential.seed

The value used to seed the underlying pseudorandom number generator.

varseed=exponential.seed;// returns <Uint32Array>

If the factory method is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

varminstd=require('@stdlib/random-base-minstd-shuffle').normalized;varrandom=exponential.factory({'prng': minstd});varseed=random.seed;// returns null

exponential.seedLength

Length of underlying pseudorandom number generator seed.

varlen=exponential.seedLength;// returns <number>

If the factory method is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

varminstd=require('@stdlib/random-base-minstd-shuffle').normalized;varrandom=exponential.factory({'prng': minstd});varlen=random.seedLength;// returns null

exponential.state

Writable property for getting and setting the underlying pseudorandom number generator state.

varstate=exponential.state;// returns <Uint32Array>

If the factory method is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

varminstd=require('@stdlib/random-base-minstd-shuffle').normalized;varrandom=exponential.factory({'prng': minstd});varstate=random.state;// returns null

exponential.stateLength

Length of underlying pseudorandom number generator state.

varlen=exponential.stateLength;// returns <number>

If the factory method is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

varminstd=require('@stdlib/random-base-minstd-shuffle').normalized;varrandom=exponential.factory({'prng': minstd});varlen=random.stateLength;// returns null

exponential.byteLength

Size (in bytes) of underlying pseudorandom number generator state.

varsz=exponential.byteLength;// returns <number>

If the factory method is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

varminstd=require('@stdlib/random-base-minstd-shuffle').normalized;varrandom=exponential.factory({'prng': minstd});varsz=random.byteLength;// returns null

Notes

  • If PRNG state is "shared" (meaning a state array was provided during function creation and not copied) and one sets the underlying generator state to a state array having a different length, the function returned by the factory method does not update the existing shared state and, instead, points to the newly provided state array. In order to synchronize the output of the underlying generator according to the new shared state array, the state array for each relevant creation function and/or PRNG must be explicitly set.
  • If PRNG state is "shared" and one sets the underlying generator state to a state array of the same length, the PRNG state is updated (along with the state of all other creation functions and/or PRNGs sharing the PRNG's state array).
  • The output data type policy only applies to the main function and specifies that, by default, the function must return an ndarray having a real-valued floating-point or "generic" data type. For the assign method, the output ndarray is allowed to have any supported output data type.

Examples

varlogEach=require('@stdlib/console-log-each');varndarray2array=require('@stdlib/ndarray-to-array');varexponential=require('@stdlib/random-exponential');// Create a function for generating random arrays originating from the same state:varrandom=exponential.factory({'state': exponential.state,'copy': true});// Generate 3 one-dimensional arrays:varx1=random([5],2.0);varx2=random([5],2.0);varx3=random([5],2.0);// Print the contents:logEach('%f, %f, %f',ndarray2array(x1),ndarray2array(x2),ndarray2array(x3));// Create another function for generating random arrays with the original state:random=exponential.factory({'state': exponential.state,'copy': true});// Generate a two-dimensional array which replicates the above pseudorandom number generation sequence:varx4=random([3,5],2.0);// Convert to a list of nested arrays:vararr=ndarray2array(x4);// Print the contents:console.log('');logEach('%f, %f, %f',arr[0],arr[1],arr[2]);

See Also


Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2026. The Stdlib Authors.

Releases

Sponsor this project

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' GitHub - stdlib-js/random-exponential: Generate pseudorandom numbers drawn from an exponential distribution. · GitHub
Skip to content
About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

Exponential Random Numbers

NPM versionBuild StatusCoverage Status

Generate pseudorandom numbers drawn from an exponential distribution.

Installation

npm install @stdlib/random-exponential

Alternatively,

  • To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
  • If you are using Deno, visit the deno branch (see README for usage intructions).
  • For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

Usage

varexponential=require('@stdlib/random-exponential');

exponential( shape, lambda[, options] )

Returns an ndarray containing pseudorandom numbers drawn from an exponential distribution.

vararr=exponential([3,3],2.0);// returns <ndarray>

The function has the following parameters:

  • shape: output shape.
  • lambda: rate parameter. May be either a scalar or an ndarray. When providing an ndarray, the ndarray must be broadcast compatible with the specified output shape.
  • options: function options.

When provided a scalar distribution parameter, every element in the output ndarray is drawn from the same distribution. To generate pseudorandom numbers drawn from different distributions, provide a distribution parameter argument as an ndarray. The following example demonstrates broadcasting an ndarray containing distribution parameters to generate sub-matrices drawn from different distributions.

vargetShape=require('@stdlib/ndarray-shape');vararray=require('@stdlib/ndarray-array');varlambda=array([[[2.0]],[[10.0]]]);// returns <ndarray>varshape=getShape(lambda);// returns [ 2, 1, 1 ]vararr=exponential([2,3,3],lambda);// returns <ndarray>

If provided an empty shape, the function returns a zero-dimensional ndarray.

vargetShape=require('@stdlib/ndarray-shape');vararr=exponential([],2.0);// returns <ndarray>varshape=getShape(arr);// returns []varv=arr.get();// returns <number>

The function accepts the following options:

  • dtype: output ndarray data type. Must be a real-valued floating-point or "generic" data type.
  • order: ndarray order (i.e., memory layout), which is either row-major (C-style) or column-major (Fortran-style). Default: 'row-major'.
  • mode: specifies how to handle indices which exceed ndarray dimensions. For a list of supported modes, see ndarray. Default: 'throw'.
  • submode: a mode array which specifies for each dimension how to handle subscripts which exceed ndarray dimensions. If provided fewer modes than dimensions, an ndarray instance recycles modes using modulo arithmetic. Default: [ options.mode ].
  • readonly: boolean indicating whether an ndarray should be read-only. Default: false.

By default, the function returns an ndarray having a data type determined by the function's output data type policy. To override the default behavior, set the dtype option.

vargetDType=require('@stdlib/ndarray-dtype');varopts={'dtype': 'generic'};vararr=exponential([3,3],2.0,opts);// returns <ndarray>vardt=String(getDType(arr));// returns 'generic'

exponential.assign( lambda, out )

Fills an ndarray with pseudorandom numbers drawn from an exponential distribution.

varzeros=require('@stdlib/ndarray-zeros');varout=zeros([3,3]);// returns <ndarray>varv=exponential.assign(2.0,out);// returns <ndarray>varbool=(v===out);// returns true

The method has the following parameters:

exponential.factory( [options] )

Returns a function for generating pseudorandom numbers drawn from an exponential distribution.

vargetShape=require('@stdlib/ndarray-shape');varrandom=exponential.factory();varout=random([3,3],2.0);// returns <ndarray>varsh=getShape(out);// returns [ 3, 3 ]

The method accepts the following options:

  • prng: pseudorandom number generator for generating uniformly distributed pseudorandom numbers on the interval [0,1). If provided, the function ignores both the state and seed options. In order to seed the underlying pseudorandom number generator, one must seed the provided prng (assuming the provided prng is seedable).
  • seed: pseudorandom number generator seed.
  • state: a Uint32Array containing pseudorandom number generator state. If provided, the function ignores the seed option.
  • copy: boolean indicating whether to copy a provided pseudorandom number generator state. Setting this option to false allows sharing state between two or more pseudorandom number generators. Setting this option to true ensures that an underlying generator has exclusive control over its internal state. Default: true.

To use a custom PRNG as the underlying source of uniformly distributed pseudorandom numbers, set the prng option.

varminstd=require('@stdlib/random-base-minstd');varopts={'prng': minstd.normalized};varrandom=exponential.factory(opts);varout=random([3,3],2.0);// returns <ndarray>

To seed the underlying pseudorandom number generator, set the seed option.

varopts={'seed': 12345};varrandom=exponential.factory(opts);varout=random([3,3],2.0);// returns <ndarray>

The function returned by the factory method has the same interface and accepts the same options as the exponential function above.

exponential.PRNG

The underlying pseudorandom number generator.

varprng=exponential.PRNG;// returns <Function>

exponential.seed

The value used to seed the underlying pseudorandom number generator.

varseed=exponential.seed;// returns <Uint32Array>

If the factory method is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

varminstd=require('@stdlib/random-base-minstd-shuffle').normalized;varrandom=exponential.factory({'prng': minstd});varseed=random.seed;// returns null

exponential.seedLength

Length of underlying pseudorandom number generator seed.

varlen=exponential.seedLength;// returns <number>

If the factory method is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

varminstd=require('@stdlib/random-base-minstd-shuffle').normalized;varrandom=exponential.factory({'prng': minstd});varlen=random.seedLength;// returns null

exponential.state

Writable property for getting and setting the underlying pseudorandom number generator state.

varstate=exponential.state;// returns <Uint32Array>

If the factory method is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

varminstd=require('@stdlib/random-base-minstd-shuffle').normalized;varrandom=exponential.factory({'prng': minstd});varstate=random.state;// returns null

exponential.stateLength

Length of underlying pseudorandom number generator state.

varlen=exponential.stateLength;// returns <number>

If the factory method is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

varminstd=require('@stdlib/random-base-minstd-shuffle').normalized;varrandom=exponential.factory({'prng': minstd});varlen=random.stateLength;// returns null

exponential.byteLength

Size (in bytes) of underlying pseudorandom number generator state.

varsz=exponential.byteLength;// returns <number>

If the factory method is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

varminstd=require('@stdlib/random-base-minstd-shuffle').normalized;varrandom=exponential.factory({'prng': minstd});varsz=random.byteLength;// returns null

Notes

  • If PRNG state is "shared" (meaning a state array was provided during function creation and not copied) and one sets the underlying generator state to a state array having a different length, the function returned by the factory method does not update the existing shared state and, instead, points to the newly provided state array. In order to synchronize the output of the underlying generator according to the new shared state array, the state array for each relevant creation function and/or PRNG must be explicitly set.
  • If PRNG state is "shared" and one sets the underlying generator state to a state array of the same length, the PRNG state is updated (along with the state of all other creation functions and/or PRNGs sharing the PRNG's state array).
  • The output data type policy only applies to the main function and specifies that, by default, the function must return an ndarray having a real-valued floating-point or "generic" data type. For the assign method, the output ndarray is allowed to have any supported output data type.

Examples

varlogEach=require('@stdlib/console-log-each');varndarray2array=require('@stdlib/ndarray-to-array');varexponential=require('@stdlib/random-exponential');// Create a function for generating random arrays originating from the same state:varrandom=exponential.factory({'state': exponential.state,'copy': true});// Generate 3 one-dimensional arrays:varx1=random([5],2.0);varx2=random([5],2.0);varx3=random([5],2.0);// Print the contents:logEach('%f, %f, %f',ndarray2array(x1),ndarray2array(x2),ndarray2array(x3));// Create another function for generating random arrays with the original state:random=exponential.factory({'state': exponential.state,'copy': true});// Generate a two-dimensional array which replicates the above pseudorandom number generation sequence:varx4=random([3,5],2.0);// Convert to a list of nested arrays:vararr=ndarray2array(x4);// Print the contents:console.log('');logEach('%f, %f, %f',arr[0],arr[1],arr[2]);

See Also


Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2026. The Stdlib Authors.

Releases

Sponsor this project

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' GitHub - stdlib-js/random-exponential: Generate pseudorandom numbers drawn from an exponential distribution. · GitHub
Skip to content
About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

Exponential Random Numbers

NPM versionBuild StatusCoverage Status

Generate pseudorandom numbers drawn from an exponential distribution.

Installation

npm install @stdlib/random-exponential

Alternatively,

  • To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
  • If you are using Deno, visit the deno branch (see README for usage intructions).
  • For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

Usage

varexponential=require('@stdlib/random-exponential');

exponential( shape, lambda[, options] )

Returns an ndarray containing pseudorandom numbers drawn from an exponential distribution.

vararr=exponential([3,3],2.0);// returns <ndarray>

The function has the following parameters:

  • shape: output shape.
  • lambda: rate parameter. May be either a scalar or an ndarray. When providing an ndarray, the ndarray must be broadcast compatible with the specified output shape.
  • options: function options.

When provided a scalar distribution parameter, every element in the output ndarray is drawn from the same distribution. To generate pseudorandom numbers drawn from different distributions, provide a distribution parameter argument as an ndarray. The following example demonstrates broadcasting an ndarray containing distribution parameters to generate sub-matrices drawn from different distributions.

vargetShape=require('@stdlib/ndarray-shape');vararray=require('@stdlib/ndarray-array');varlambda=array([[[2.0]],[[10.0]]]);// returns <ndarray>varshape=getShape(lambda);// returns [ 2, 1, 1 ]vararr=exponential([2,3,3],lambda);// returns <ndarray>

If provided an empty shape, the function returns a zero-dimensional ndarray.

vargetShape=require('@stdlib/ndarray-shape');vararr=exponential([],2.0);// returns <ndarray>varshape=getShape(arr);// returns []varv=arr.get();// returns <number>

The function accepts the following options:

  • dtype: output ndarray data type. Must be a real-valued floating-point or "generic" data type.
  • order: ndarray order (i.e., memory layout), which is either row-major (C-style) or column-major (Fortran-style). Default: 'row-major'.
  • mode: specifies how to handle indices which exceed ndarray dimensions. For a list of supported modes, see ndarray. Default: 'throw'.
  • submode: a mode array which specifies for each dimension how to handle subscripts which exceed ndarray dimensions. If provided fewer modes than dimensions, an ndarray instance recycles modes using modulo arithmetic. Default: [ options.mode ].
  • readonly: boolean indicating whether an ndarray should be read-only. Default: false.

By default, the function returns an ndarray having a data type determined by the function's output data type policy. To override the default behavior, set the dtype option.

vargetDType=require('@stdlib/ndarray-dtype');varopts={'dtype': 'generic'};vararr=exponential([3,3],2.0,opts);// returns <ndarray>vardt=String(getDType(arr));// returns 'generic'

exponential.assign( lambda, out )

Fills an ndarray with pseudorandom numbers drawn from an exponential distribution.

varzeros=require('@stdlib/ndarray-zeros');varout=zeros([3,3]);// returns <ndarray>varv=exponential.assign(2.0,out);// returns <ndarray>varbool=(v===out);// returns true

The method has the following parameters:

exponential.factory( [options] )

Returns a function for generating pseudorandom numbers drawn from an exponential distribution.

vargetShape=require('@stdlib/ndarray-shape');varrandom=exponential.factory();varout=random([3,3],2.0);// returns <ndarray>varsh=getShape(out);// returns [ 3, 3 ]

The method accepts the following options:

  • prng: pseudorandom number generator for generating uniformly distributed pseudorandom numbers on the interval [0,1). If provided, the function ignores both the state and seed options. In order to seed the underlying pseudorandom number generator, one must seed the provided prng (assuming the provided prng is seedable).
  • seed: pseudorandom number generator seed.
  • state: a Uint32Array containing pseudorandom number generator state. If provided, the function ignores the seed option.
  • copy: boolean indicating whether to copy a provided pseudorandom number generator state. Setting this option to false allows sharing state between two or more pseudorandom number generators. Setting this option to true ensures that an underlying generator has exclusive control over its internal state. Default: true.

To use a custom PRNG as the underlying source of uniformly distributed pseudorandom numbers, set the prng option.

varminstd=require('@stdlib/random-base-minstd');varopts={'prng': minstd.normalized};varrandom=exponential.factory(opts);varout=random([3,3],2.0);// returns <ndarray>

To seed the underlying pseudorandom number generator, set the seed option.

varopts={'seed': 12345};varrandom=exponential.factory(opts);varout=random([3,3],2.0);// returns <ndarray>

The function returned by the factory method has the same interface and accepts the same options as the exponential function above.

exponential.PRNG

The underlying pseudorandom number generator.

varprng=exponential.PRNG;// returns <Function>

exponential.seed

The value used to seed the underlying pseudorandom number generator.

varseed=exponential.seed;// returns <Uint32Array>

If the factory method is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

varminstd=require('@stdlib/random-base-minstd-shuffle').normalized;varrandom=exponential.factory({'prng': minstd});varseed=random.seed;// returns null

exponential.seedLength

Length of underlying pseudorandom number generator seed.

varlen=exponential.seedLength;// returns <number>

If the factory method is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

varminstd=require('@stdlib/random-base-minstd-shuffle').normalized;varrandom=exponential.factory({'prng': minstd});varlen=random.seedLength;// returns null

exponential.state

Writable property for getting and setting the underlying pseudorandom number generator state.

varstate=exponential.state;// returns <Uint32Array>

If the factory method is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

varminstd=require('@stdlib/random-base-minstd-shuffle').normalized;varrandom=exponential.factory({'prng': minstd});varstate=random.state;// returns null

exponential.stateLength

Length of underlying pseudorandom number generator state.

varlen=exponential.stateLength;// returns <number>

If the factory method is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

varminstd=require('@stdlib/random-base-minstd-shuffle').normalized;varrandom=exponential.factory({'prng': minstd});varlen=random.stateLength;// returns null

exponential.byteLength

Size (in bytes) of underlying pseudorandom number generator state.

varsz=exponential.byteLength;// returns <number>

If the factory method is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

varminstd=require('@stdlib/random-base-minstd-shuffle').normalized;varrandom=exponential.factory({'prng': minstd});varsz=random.byteLength;// returns null

Notes

  • If PRNG state is "shared" (meaning a state array was provided during function creation and not copied) and one sets the underlying generator state to a state array having a different length, the function returned by the factory method does not update the existing shared state and, instead, points to the newly provided state array. In order to synchronize the output of the underlying generator according to the new shared state array, the state array for each relevant creation function and/or PRNG must be explicitly set.
  • If PRNG state is "shared" and one sets the underlying generator state to a state array of the same length, the PRNG state is updated (along with the state of all other creation functions and/or PRNGs sharing the PRNG's state array).
  • The output data type policy only applies to the main function and specifies that, by default, the function must return an ndarray having a real-valued floating-point or "generic" data type. For the assign method, the output ndarray is allowed to have any supported output data type.

Examples

varlogEach=require('@stdlib/console-log-each');varndarray2array=require('@stdlib/ndarray-to-array');varexponential=require('@stdlib/random-exponential');// Create a function for generating random arrays originating from the same state:varrandom=exponential.factory({'state': exponential.state,'copy': true});// Generate 3 one-dimensional arrays:varx1=random([5],2.0);varx2=random([5],2.0);varx3=random([5],2.0);// Print the contents:logEach('%f, %f, %f',ndarray2array(x1),ndarray2array(x2),ndarray2array(x3));// Create another function for generating random arrays with the original state:random=exponential.factory({'state': exponential.state,'copy': true});// Generate a two-dimensional array which replicates the above pseudorandom number generation sequence:varx4=random([3,5],2.0);// Convert to a list of nested arrays:vararr=ndarray2array(x4);// Print the contents:console.log('');logEach('%f, %f, %f',arr[0],arr[1],arr[2]);

See Also


Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2026. The Stdlib Authors.

Releases

Sponsor this project

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' GitHub - stdlib-js/random-exponential: Generate pseudorandom numbers drawn from an exponential distribution. · GitHub
Skip to content
About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

Exponential Random Numbers

NPM versionBuild StatusCoverage Status

Generate pseudorandom numbers drawn from an exponential distribution.

Installation

npm install @stdlib/random-exponential

Alternatively,

  • To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
  • If you are using Deno, visit the deno branch (see README for usage intructions).
  • For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

Usage

varexponential=require('@stdlib/random-exponential');

exponential( shape, lambda[, options] )

Returns an ndarray containing pseudorandom numbers drawn from an exponential distribution.

vararr=exponential([3,3],2.0);// returns <ndarray>

The function has the following parameters:

  • shape: output shape.
  • lambda: rate parameter. May be either a scalar or an ndarray. When providing an ndarray, the ndarray must be broadcast compatible with the specified output shape.
  • options: function options.

When provided a scalar distribution parameter, every element in the output ndarray is drawn from the same distribution. To generate pseudorandom numbers drawn from different distributions, provide a distribution parameter argument as an ndarray. The following example demonstrates broadcasting an ndarray containing distribution parameters to generate sub-matrices drawn from different distributions.

vargetShape=require('@stdlib/ndarray-shape');vararray=require('@stdlib/ndarray-array');varlambda=array([[[2.0]],[[10.0]]]);// returns <ndarray>varshape=getShape(lambda);// returns [ 2, 1, 1 ]vararr=exponential([2,3,3],lambda);// returns <ndarray>

If provided an empty shape, the function returns a zero-dimensional ndarray.

vargetShape=require('@stdlib/ndarray-shape');vararr=exponential([],2.0);// returns <ndarray>varshape=getShape(arr);// returns []varv=arr.get();// returns <number>

The function accepts the following options:

  • dtype: output ndarray data type. Must be a real-valued floating-point or "generic" data type.
  • order: ndarray order (i.e., memory layout), which is either row-major (C-style) or column-major (Fortran-style). Default: 'row-major'.
  • mode: specifies how to handle indices which exceed ndarray dimensions. For a list of supported modes, see ndarray. Default: 'throw'.
  • submode: a mode array which specifies for each dimension how to handle subscripts which exceed ndarray dimensions. If provided fewer modes than dimensions, an ndarray instance recycles modes using modulo arithmetic. Default: [ options.mode ].
  • readonly: boolean indicating whether an ndarray should be read-only. Default: false.

By default, the function returns an ndarray having a data type determined by the function's output data type policy. To override the default behavior, set the dtype option.

vargetDType=require('@stdlib/ndarray-dtype');varopts={'dtype': 'generic'};vararr=exponential([3,3],2.0,opts);// returns <ndarray>vardt=String(getDType(arr));// returns 'generic'

exponential.assign( lambda, out )

Fills an ndarray with pseudorandom numbers drawn from an exponential distribution.

varzeros=require('@stdlib/ndarray-zeros');varout=zeros([3,3]);// returns <ndarray>varv=exponential.assign(2.0,out);// returns <ndarray>varbool=(v===out);// returns true

The method has the following parameters:

exponential.factory( [options] )

Returns a function for generating pseudorandom numbers drawn from an exponential distribution.

vargetShape=require('@stdlib/ndarray-shape');varrandom=exponential.factory();varout=random([3,3],2.0);// returns <ndarray>varsh=getShape(out);// returns [ 3, 3 ]

The method accepts the following options:

  • prng: pseudorandom number generator for generating uniformly distributed pseudorandom numbers on the interval [0,1). If provided, the function ignores both the state and seed options. In order to seed the underlying pseudorandom number generator, one must seed the provided prng (assuming the provided prng is seedable).
  • seed: pseudorandom number generator seed.
  • state: a Uint32Array containing pseudorandom number generator state. If provided, the function ignores the seed option.
  • copy: boolean indicating whether to copy a provided pseudorandom number generator state. Setting this option to false allows sharing state between two or more pseudorandom number generators. Setting this option to true ensures that an underlying generator has exclusive control over its internal state. Default: true.

To use a custom PRNG as the underlying source of uniformly distributed pseudorandom numbers, set the prng option.

varminstd=require('@stdlib/random-base-minstd');varopts={'prng': minstd.normalized};varrandom=exponential.factory(opts);varout=random([3,3],2.0);// returns <ndarray>

To seed the underlying pseudorandom number generator, set the seed option.

varopts={'seed': 12345};varrandom=exponential.factory(opts);varout=random([3,3],2.0);// returns <ndarray>

The function returned by the factory method has the same interface and accepts the same options as the exponential function above.

exponential.PRNG

The underlying pseudorandom number generator.

varprng=exponential.PRNG;// returns <Function>

exponential.seed

The value used to seed the underlying pseudorandom number generator.

varseed=exponential.seed;// returns <Uint32Array>

If the factory method is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

varminstd=require('@stdlib/random-base-minstd-shuffle').normalized;varrandom=exponential.factory({'prng': minstd});varseed=random.seed;// returns null

exponential.seedLength

Length of underlying pseudorandom number generator seed.

varlen=exponential.seedLength;// returns <number>

If the factory method is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

varminstd=require('@stdlib/random-base-minstd-shuffle').normalized;varrandom=exponential.factory({'prng': minstd});varlen=random.seedLength;// returns null

exponential.state

Writable property for getting and setting the underlying pseudorandom number generator state.

varstate=exponential.state;// returns <Uint32Array>

If the factory method is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

varminstd=require('@stdlib/random-base-minstd-shuffle').normalized;varrandom=exponential.factory({'prng': minstd});varstate=random.state;// returns null

exponential.stateLength

Length of underlying pseudorandom number generator state.

varlen=exponential.stateLength;// returns <number>

If the factory method is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

varminstd=require('@stdlib/random-base-minstd-shuffle').normalized;varrandom=exponential.factory({'prng': minstd});varlen=random.stateLength;// returns null

exponential.byteLength

Size (in bytes) of underlying pseudorandom number generator state.

varsz=exponential.byteLength;// returns <number>

If the factory method is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

varminstd=require('@stdlib/random-base-minstd-shuffle').normalized;varrandom=exponential.factory({'prng': minstd});varsz=random.byteLength;// returns null

Notes

  • If PRNG state is "shared" (meaning a state array was provided during function creation and not copied) and one sets the underlying generator state to a state array having a different length, the function returned by the factory method does not update the existing shared state and, instead, points to the newly provided state array. In order to synchronize the output of the underlying generator according to the new shared state array, the state array for each relevant creation function and/or PRNG must be explicitly set.
  • If PRNG state is "shared" and one sets the underlying generator state to a state array of the same length, the PRNG state is updated (along with the state of all other creation functions and/or PRNGs sharing the PRNG's state array).
  • The output data type policy only applies to the main function and specifies that, by default, the function must return an ndarray having a real-valued floating-point or "generic" data type. For the assign method, the output ndarray is allowed to have any supported output data type.

Examples

varlogEach=require('@stdlib/console-log-each');varndarray2array=require('@stdlib/ndarray-to-array');varexponential=require('@stdlib/random-exponential');// Create a function for generating random arrays originating from the same state:varrandom=exponential.factory({'state': exponential.state,'copy': true});// Generate 3 one-dimensional arrays:varx1=random([5],2.0);varx2=random([5],2.0);varx3=random([5],2.0);// Print the contents:logEach('%f, %f, %f',ndarray2array(x1),ndarray2array(x2),ndarray2array(x3));// Create another function for generating random arrays with the original state:random=exponential.factory({'state': exponential.state,'copy': true});// Generate a two-dimensional array which replicates the above pseudorandom number generation sequence:varx4=random([3,5],2.0);// Convert to a list of nested arrays:vararr=ndarray2array(x4);// Print the contents:console.log('');logEach('%f, %f, %f',arr[0],arr[1],arr[2]);

See Also


Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2026. The Stdlib Authors.

Releases

Sponsor this project

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); GitHub - stdlib-js/random-exponential: Generate pseudorandom numbers drawn from an exponential distribution. · GitHub
Skip to content
About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

Exponential Random Numbers

NPM versionBuild StatusCoverage Status

Generate pseudorandom numbers drawn from an exponential distribution.

Installation

npm install @stdlib/random-exponential

Alternatively,

  • To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
  • If you are using Deno, visit the deno branch (see README for usage intructions).
  • For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

Usage

varexponential=require('@stdlib/random-exponential');

exponential( shape, lambda[, options] )

Returns an ndarray containing pseudorandom numbers drawn from an exponential distribution.

vararr=exponential([3,3],2.0);// returns <ndarray>

The function has the following parameters:

  • shape: output shape.
  • lambda: rate parameter. May be either a scalar or an ndarray. When providing an ndarray, the ndarray must be broadcast compatible with the specified output shape.
  • options: function options.

When provided a scalar distribution parameter, every element in the output ndarray is drawn from the same distribution. To generate pseudorandom numbers drawn from different distributions, provide a distribution parameter argument as an ndarray. The following example demonstrates broadcasting an ndarray containing distribution parameters to generate sub-matrices drawn from different distributions.

vargetShape=require('@stdlib/ndarray-shape');vararray=require('@stdlib/ndarray-array');varlambda=array([[[2.0]],[[10.0]]]);// returns <ndarray>varshape=getShape(lambda);// returns [ 2, 1, 1 ]vararr=exponential([2,3,3],lambda);// returns <ndarray>

If provided an empty shape, the function returns a zero-dimensional ndarray.

vargetShape=require('@stdlib/ndarray-shape');vararr=exponential([],2.0);// returns <ndarray>varshape=getShape(arr);// returns []varv=arr.get();// returns <number>

The function accepts the following options:

  • dtype: output ndarray data type. Must be a real-valued floating-point or "generic" data type.
  • order: ndarray order (i.e., memory layout), which is either row-major (C-style) or column-major (Fortran-style). Default: 'row-major'.
  • mode: specifies how to handle indices which exceed ndarray dimensions. For a list of supported modes, see ndarray. Default: 'throw'.
  • submode: a mode array which specifies for each dimension how to handle subscripts which exceed ndarray dimensions. If provided fewer modes than dimensions, an ndarray instance recycles modes using modulo arithmetic. Default: [ options.mode ].
  • readonly: boolean indicating whether an ndarray should be read-only. Default: false.

By default, the function returns an ndarray having a data type determined by the function's output data type policy. To override the default behavior, set the dtype option.

vargetDType=require('@stdlib/ndarray-dtype');varopts={'dtype': 'generic'};vararr=exponential([3,3],2.0,opts);// returns <ndarray>vardt=String(getDType(arr));// returns 'generic'

exponential.assign( lambda, out )

Fills an ndarray with pseudorandom numbers drawn from an exponential distribution.

varzeros=require('@stdlib/ndarray-zeros');varout=zeros([3,3]);// returns <ndarray>varv=exponential.assign(2.0,out);// returns <ndarray>varbool=(v===out);// returns true

The method has the following parameters:

exponential.factory( [options] )

Returns a function for generating pseudorandom numbers drawn from an exponential distribution.

vargetShape=require('@stdlib/ndarray-shape');varrandom=exponential.factory();varout=random([3,3],2.0);// returns <ndarray>varsh=getShape(out);// returns [ 3, 3 ]

The method accepts the following options:

  • prng: pseudorandom number generator for generating uniformly distributed pseudorandom numbers on the interval [0,1). If provided, the function ignores both the state and seed options. In order to seed the underlying pseudorandom number generator, one must seed the provided prng (assuming the provided prng is seedable).
  • seed: pseudorandom number generator seed.
  • state: a Uint32Array containing pseudorandom number generator state. If provided, the function ignores the seed option.
  • copy: boolean indicating whether to copy a provided pseudorandom number generator state. Setting this option to false allows sharing state between two or more pseudorandom number generators. Setting this option to true ensures that an underlying generator has exclusive control over its internal state. Default: true.

To use a custom PRNG as the underlying source of uniformly distributed pseudorandom numbers, set the prng option.

varminstd=require('@stdlib/random-base-minstd');varopts={'prng': minstd.normalized};varrandom=exponential.factory(opts);varout=random([3,3],2.0);// returns <ndarray>

To seed the underlying pseudorandom number generator, set the seed option.

varopts={'seed': 12345};varrandom=exponential.factory(opts);varout=random([3,3],2.0);// returns <ndarray>

The function returned by the factory method has the same interface and accepts the same options as the exponential function above.

exponential.PRNG

The underlying pseudorandom number generator.

varprng=exponential.PRNG;// returns <Function>

exponential.seed

The value used to seed the underlying pseudorandom number generator.

varseed=exponential.seed;// returns <Uint32Array>

If the factory method is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

varminstd=require('@stdlib/random-base-minstd-shuffle').normalized;varrandom=exponential.factory({'prng': minstd});varseed=random.seed;// returns null

exponential.seedLength

Length of underlying pseudorandom number generator seed.

varlen=exponential.seedLength;// returns <number>

If the factory method is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

varminstd=require('@stdlib/random-base-minstd-shuffle').normalized;varrandom=exponential.factory({'prng': minstd});varlen=random.seedLength;// returns null

exponential.state

Writable property for getting and setting the underlying pseudorandom number generator state.

varstate=exponential.state;// returns <Uint32Array>

If the factory method is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

varminstd=require('@stdlib/random-base-minstd-shuffle').normalized;varrandom=exponential.factory({'prng': minstd});varstate=random.state;// returns null

exponential.stateLength

Length of underlying pseudorandom number generator state.

varlen=exponential.stateLength;// returns <number>

If the factory method is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

varminstd=require('@stdlib/random-base-minstd-shuffle').normalized;varrandom=exponential.factory({'prng': minstd});varlen=random.stateLength;// returns null

exponential.byteLength

Size (in bytes) of underlying pseudorandom number generator state.

varsz=exponential.byteLength;// returns <number>

If the factory method is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

varminstd=require('@stdlib/random-base-minstd-shuffle').normalized;varrandom=exponential.factory({'prng': minstd});varsz=random.byteLength;// returns null

Notes

  • If PRNG state is "shared" (meaning a state array was provided during function creation and not copied) and one sets the underlying generator state to a state array having a different length, the function returned by the factory method does not update the existing shared state and, instead, points to the newly provided state array. In order to synchronize the output of the underlying generator according to the new shared state array, the state array for each relevant creation function and/or PRNG must be explicitly set.
  • If PRNG state is "shared" and one sets the underlying generator state to a state array of the same length, the PRNG state is updated (along with the state of all other creation functions and/or PRNGs sharing the PRNG's state array).
  • The output data type policy only applies to the main function and specifies that, by default, the function must return an ndarray having a real-valued floating-point or "generic" data type. For the assign method, the output ndarray is allowed to have any supported output data type.

Examples

varlogEach=require('@stdlib/console-log-each');varndarray2array=require('@stdlib/ndarray-to-array');varexponential=require('@stdlib/random-exponential');// Create a function for generating random arrays originating from the same state:varrandom=exponential.factory({'state': exponential.state,'copy': true});// Generate 3 one-dimensional arrays:varx1=random([5],2.0);varx2=random([5],2.0);varx3=random([5],2.0);// Print the contents:logEach('%f, %f, %f',ndarray2array(x1),ndarray2array(x2),ndarray2array(x3));// Create another function for generating random arrays with the original state:random=exponential.factory({'state': exponential.state,'copy': true});// Generate a two-dimensional array which replicates the above pseudorandom number generation sequence:varx4=random([3,5],2.0);// Convert to a list of nested arrays:vararr=ndarray2array(x4);// Print the contents:console.log('');logEach('%f, %f, %f',arr[0],arr[1],arr[2]);

See Also


Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2026. The Stdlib Authors.

Releases

Sponsor this project

Packages

Used by

Contributors

Languages