Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stdlib-js/random-array-tools-unary

Constructor for creating arrays filled with pseudorandom values drawn from a unary PRNG.
https://github.com/stdlib-js/random-array-tools-unary

array generator javascript math mathematics node node-js nodejs prng pseudorandom rand random rng seed seedable statistics stats stdlib tools vector

Last synced: about 9 hours ago
JSON representation

Constructor for creating arrays filled with pseudorandom values drawn from a unary PRNG.

Awesome Lists containing this project

README 

        



  

    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!



# Unary



[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] 



> Constructor for creating arrays filled with pseudorandom values drawn from a unary PRNG.



## Installation



```bash

npm install @stdlib/random-array-tools-unary

```



Alternatively,



-   To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).

-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).

-   For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).



The [branches.md][branches-url] 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



```javascript

var Random = require( '@stdlib/random-array-tools-unary' );

```



#### Random( prng, dtypes, dtype )



Constructor for creating arrays filled with pseudorandom values drawn from a unary PRNG.



```javascript

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



var dtypes = [ 'float64', 'float32', 'generic' ];

var defaultDType = 'float64';



var random = new Random( exponential, dtypes, defaultDType );

```



The constructor has the following parameters:



-   **prng**: unary pseudorandom value generator.

-   **dtypes**: list of supported output data types.

-   **dtype**: default output data type.



#### Random.prototype.generate( len, param1\[, options] )



Returns an array filled with pseudorandom values drawn from a unary PRNG.



```javascript

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



var dtypes = [ 'float64', 'float32', 'generic' ];

var defaultDType = 'float64';



var random = new Random( exponential, dtypes, defaultDType );



var v = random.generate( 10, 2.0 );

// returns 

```



The method has the following parameters:



-   **len**: output array length.

-   **param1**: PRNG parameter.

-   **options**: function options.



The method accepts the following options:



-   **dtype**: output array data type. Setting this option, overrides the default output array data type.



By default, the method returns an array having the default output array data type. To override the default, set the `dtype` option.



```javascript

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



var dtypes = [ 'float64', 'float32', 'generic' ];

var defaultDType = 'float64';



var random = new Random( exponential, dtypes, defaultDType );



var v = random.generate( 10, 2.0, {

    'dtype': 'float32'

});

// returns 

```



#### Random.prototype.assign( param1, out )



Fills an array with pseudorandom values drawn from a unary PRNG.



```javascript

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

var zeros = require( '@stdlib/array-zeros' );



var dtypes = [ 'float64', 'float32', 'generic' ];

var defaultDType = 'float64';



var random = new Random( exponential, dtypes, defaultDType );



var out = zeros( 10, 'float64' );

// returns 



var v = random.assign( 2.0, out );

// returns 



var bool = ( v === out );

// returns true

```



The method has the following parameters:



-   **param1**: PRNG parameter.

-   **out**: output array.



## Examples



```javascript

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

var dtypes = require( '@stdlib/array-dtypes' );

var Random = require( '@stdlib/random-array-tools-unary' );



var dt = dtypes( 'real_floating_point_and_generic' );

var random = new Random( exponential, dt, 'float64' );



var x = random.generate( 10, 2.0 );

// returns 



x = random.generate( 10, 2.0, {

    'dtype': 'float32'

});

// returns 



x = random.generate( 10, 2.0, {

    'dtype': 'generic'

});

// returns [...]

```



* * *



## Notice



This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].



#### Community



[![Chat][chat-image]][chat-url]



---



## License



See [LICENSE][stdlib-license].



## Copyright



Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].



[npm-image]: http://img.shields.io/npm/v/@stdlib/random-array-tools-unary.svg

[npm-url]: https://npmjs.org/package/@stdlib/random-array-tools-unary



[test-image]: https://github.com/stdlib-js/random-array-tools-unary/actions/workflows/test.yml/badge.svg?branch=main

[test-url]: https://github.com/stdlib-js/random-array-tools-unary/actions/workflows/test.yml?query=branch:main



[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/random-array-tools-unary/main.svg

[coverage-url]: https://codecov.io/github/stdlib-js/random-array-tools-unary?branch=main



[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg

[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im



[stdlib]: https://github.com/stdlib-js/stdlib



[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors



[umd]: https://github.com/umdjs/umd

[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules



[deno-url]: https://github.com/stdlib-js/random-array-tools-unary/tree/deno

[deno-readme]: https://github.com/stdlib-js/random-array-tools-unary/blob/deno/README.md

[umd-url]: https://github.com/stdlib-js/random-array-tools-unary/tree/umd

[umd-readme]: https://github.com/stdlib-js/random-array-tools-unary/blob/umd/README.md

[esm-url]: https://github.com/stdlib-js/random-array-tools-unary/tree/esm

[esm-readme]: https://github.com/stdlib-js/random-array-tools-unary/blob/esm/README.md

[branches-url]: https://github.com/stdlib-js/random-array-tools-unary/blob/main/branches.md



[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-array-tools-unary/main/LICENSE