Data

Tools

Indexes

Applications

Experiments

Awesome

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

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

Create a factory function for generating pseudorandom values drawn from a ternary PRNG.
https://github.com/stdlib-js/random-array-tools-ternary-factory

factory fcn func function generator javascript math mathematics node node-js nodejs prng pseudorandom rand random rng statistics stats stdlib tools

Last synced: 17 days ago
JSON representation

Create a factory function for generating pseudorandom values drawn from a ternary 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!



# ternaryFactory



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



> Create a factory function for generating pseudorandom values drawn from a ternary PRNG.



## Installation



```bash

npm install @stdlib/random-array-tools-ternary-factory

```



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 ternaryFactory = require( '@stdlib/random-array-tools-ternary-factory' );

```



#### ternaryFactory( prng, dtypes, dtype )



Returns a factory function for generating pseudorandom values drawn from a ternary PRNG.



```javascript

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



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



var factory = ternaryFactory( triangular, dtypes, 'float64' );

// returns 

```



The function has the following parameters:



-   **prng**: ternary pseudorandom number generator.

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

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



* * *



#### factory( \[param1, param2, param3, ]\[options] )



Returns a function for generating pseudorandom values drawn from a ternary PRNG.



```javascript

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



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



var factory = ternaryFactory( triangular, dtypes, dtypes[ 0 ] );

// returns 



var random = factory();

// returns 

```



The function has the following parameters:



-   **param1**: first PRNG parameter.

-   **param2**: second PRNG parameter.

-   **param3**: third PRNG parameter.

-   **options**: function options.



The function supports the following options:



-   **prng**: pseudorandom number generator which generates uniformly distributed pseudorandom numbers.

-   **seed**: pseudorandom value generator seed.

-   **state**: pseudorandom value generator state.

-   **copy**: boolean indicating whether to copy a provided pseudorandom value generator state.

-   **dtype**: default output array data type. Setting this option overrides the default output array data type provided to the parent function.



If provided PRNG parameters, the function returns a partially applied function for creating arrays, which can be useful when wanting to pass around a parameterized function for array creation.



* * *



### Full Arity



#### random( len, param1, param2, param3\[, options] )



Returns an array of pseudorandom values drawn from a ternary PRNG.



```javascript

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



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



var factory = ternaryFactory( triangular, dtypes, dtypes[ 0 ] );

// returns 



var random = factory();

// returns 



var v = random( 10, 2.0, 5.0, 3.33 );

// returns 

```



The function has the following parameters:



-   **len**: output array length.

-   **param1**: first PRNG parameter.

-   **param2**: second PRNG parameter.

-   **param3**: third PRNG parameter.

-   **options**: function options.



The function accepts the following options:



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



```javascript

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



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



var factory = ternaryFactory( triangular, dtypes, dtypes[ 0 ] );

// returns 



var random = factory();

// returns 



var v = random( 10, 2.0, 5.0, 3.33, {

    'dtype': 'float32'

});

// returns 

```



#### random.assign( param1, param2, param3, out )



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



```javascript

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

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



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



var factory = ternaryFactory( triangular, dtypes, dtypes[ 0 ] );

// returns 



var random = factory();

// returns 



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

// returns 



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

// returns 



var bool = ( out === v );

// returns true

```



The method has the following parameters:



-   **param1**: first PRNG parameter.

-   **param2**: second PRNG parameter.

-   **param3**: third PRNG parameter.

-   **out**: output array.



### Partial Application



#### random( len\[, options] )



Returns an array of pseudorandom values drawn from a ternary PRNG.



```javascript

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



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



var factory = ternaryFactory( triangular, dtypes, dtypes[ 0 ] );

// returns 



var random = factory( 2.0, 5.0, 3.33 );

// returns 



var v = random( 10 );

// returns 



v = random( 10 );

// returns 

```



The function has the following parameters:



-   **len**: output array length.

-   **options**: function options.



The function accepts the following options:



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



```javascript

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



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



var factory = ternaryFactory( triangular, dtypes, dtypes[ 0 ] );

// returns 



var random = factory( 2.0, 5.0, 3.33 );

// returns 



var v = random( 10, {

    'dtype': 'float32'

});

// returns 



v = random( 10, {

    'dtype': 'generic'

});

// returns [...]

```



#### random.assign( out )



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



```javascript

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

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



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



var factory = ternaryFactory( triangular, dtypes, dtypes[ 0 ] );

// returns 



var random = factory( 2.0, 5.0, 3.33 );

// returns 



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

// returns 



var v = random.assign( out );

// returns 



var bool = ( out === v );

// returns true

```



The method has the following parameters:



-   **out**: output array.



* * *



#### random.PRNG



The underlying pseudorandom number generator.



```javascript

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



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



var factory = ternaryFactory( triangular, dtypes, dtypes[ 0 ] );

// returns 



var random = factory();

// returns 



var prng = random.PRNG;

// returns 

```



#### random.seed



The value used to seed the underlying pseudorandom number generator.



```javascript

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



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



var factory = ternaryFactory( triangular, dtypes, dtypes[ 0 ] );

// returns 



var random = factory();

// returns 



var seed = random.seed;

// returns 

```



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



```javascript

var minstd = require( '@stdlib/random-base-minstd-shuffle' ).normalized;

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



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



var factory = ternaryFactory( triangular, dtypes, dtypes[ 0 ] );

// returns 



var random = factory({

    'prng': minstd

});

// returns 



var seed = random.seed;

// returns null

```



#### random.seedLength



Length of underlying pseudorandom number generator seed.



```javascript

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



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



var factory = ternaryFactory( triangular, dtypes, dtypes[ 0 ] );

// returns 



var random = factory();

// returns 



var len = random.seedLength;

// returns 

```



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



```javascript

var minstd = require( '@stdlib/random-base-minstd-shuffle' ).normalized;

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



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



var factory = ternaryFactory( triangular, dtypes, dtypes[ 0 ] );

// returns 



var random = factory({

    'prng': minstd

});

// returns 



var len = random.seedLength;

// returns null

```



#### random.state



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



```javascript

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



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



var factory = ternaryFactory( triangular, dtypes, dtypes[ 0 ] );

// returns 



var random = factory();

// returns 



var state = random.state;

// returns 

```



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



```javascript

var minstd = require( '@stdlib/random-base-minstd-shuffle' ).normalized;

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



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



var factory = ternaryFactory( triangular, dtypes, dtypes[ 0 ] );

// returns 



var random = factory({

    'prng': minstd

});

// returns 



var state = random.state;

// returns null

```



#### random.stateLength



Length of underlying pseudorandom number generator state.



```javascript

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



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



var factory = ternaryFactory( triangular, dtypes, dtypes[ 0 ] );

// returns 



var random = factory();

// returns 



var len = random.stateLength;

// returns 

```



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



```javascript

var minstd = require( '@stdlib/random-base-minstd-shuffle' ).normalized;

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



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



var factory = ternaryFactory( triangular, dtypes, dtypes[ 0 ] );

// returns 



var random = factory({

    'prng': minstd

});

// returns 



var len = random.stateLength;

// returns null

```



#### random.byteLength



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



```javascript

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



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



var factory = ternaryFactory( triangular, dtypes, dtypes[ 0 ] );

// returns 



var random = factory();

// returns 



var sz = random.byteLength;

// returns 

```



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



```javascript

var minstd = require( '@stdlib/random-base-minstd-shuffle' ).normalized;

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



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



var factory = ternaryFactory( triangular, dtypes, dtypes[ 0 ] );

// returns 



var random = factory({

    'prng': minstd

});

// returns 



var sz = random.byteLength;

// returns null

```



* * *



## Examples



```javascript

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

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

var ternaryFactory = require( '@stdlib/random-array-tools-ternary-factory' );



var dt = dtypes( 'real_floating_point_and_generic' );



var factory = ternaryFactory( triangular, dt, 'float64' );

// returns 



var random = factory();

// returns 



var x = random( 10, 2.0, 5.0, 3.33 );

// returns 



x = random( 10, 2.0, 5.0, 3.33, {

    'dtype': 'float32'

});

// returns 



x = random( 10, 2.0, 5.0, 3.33, {

    '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-2026. The Stdlib [Authors][stdlib-authors].



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

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



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

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



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

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



[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg

[chat-url]: https://stdlib.zulipchat.com



[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-ternary-factory/tree/deno

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

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

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

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

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

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



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