@stdlib/assert-is-probability-array

0.2.1 • Public • Published

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!

isProbabilityArray

Test if a value is an array-like object containing only probabilities.

A probability is defined as a numeric value on the interval `[0,1]`.

Installation

`npm install @stdlib/assert-is-probability-array`

Usage

`var isProbabilityArray = require( '@stdlib/assert-is-probability-array' );`

isProbabilityArray( value )

Tests if a `value` is an array-like object containing only probabilities.

```var Number = require( '@stdlib/number-ctor' );
var Uint8Array = require( '@stdlib/array-uint8' );

var bool = isProbabilityArray( [ 0.6, 0.5, 0.25 ] );
// returns true

bool = isProbabilityArray( [ 0.6, 0.5, new Number( 0.25 ) ] );
// returns true

bool = isProbabilityArray( new Uint8Array( [ 0, 1 ] ) );
// returns true

bool = isProbabilityArray( [ 3.14, 0.0 ] );
// returns false```

isProbabilityArray.primitives( value )

Tests if a `value` is an array-like object `array` containing only primitive probabilities.

```var Number = require( '@stdlib/number-ctor' );

var bool = isProbabilityArray.primitives( [ 1.0, 0.0, 0.8 ] );
// returns true

bool = isProbabilityArray.primitives( [ 0.9, new Number(1.0) ] );
// returns false```

isProbabilityArray.objects( value )

Tests if a `value` is an array-like object `array` containing only `Number` objects whose values are probabilities.

```var Number = require( '@stdlib/number-ctor' );

var bool = isProbabilityArray.objects( [ new Number(1.0), new Number(1.0) ] );
// returns true

bool = isProbabilityArray.objects( [ 1.0, 0.0, 0.6 ] );
// returns false```

Examples

```var Uint8Array = require( '@stdlib/array-uint8' );
var isProbabilityArray = require( '@stdlib/assert-is-probability-array' );

var arr = [ 0.0, 1.0, 0.5 ];
var bool = isProbabilityArray( arr );
// returns true

arr = [ 0.5, 0.25, 0.25 ];
bool = isProbabilityArray( arr );
// returns true

arr = new Uint8Array( [ 0, 0, 1, 0, 1 ] );
bool = isProbabilityArray( arr );
// returns true

arr = [ 3.14, -1.0 ];
bool = isProbabilityArray( arr );
// returns false

bool = isProbabilityArray( [] );
// returns false

bool = isProbabilityArray( null );
// returns false```

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.

Package Sidebar

Install

`npm i @stdlib/assert-is-probability-array`

stdlib.io

19

0.2.1

Apache-2.0

28.6 kB

10