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!
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].
npm install @stdlib/assert-is-probability-arrayAlternatively,
- To load the package in a website via a
scripttag without installation and bundlers, use the ES Module available on theesmbranch (see README). - If you are using Deno, visit the
denobranch (see README for usage intructions). - For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the
umdbranch (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.
var isProbabilityArray = require( '@stdlib/assert-is-probability-array' );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 falseTests 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 falseTests 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 falsevar 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@stdlib/assert-is-array: test if a value is an array.@stdlib/assert-is-probability: test if a value is a probability.
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.
See LICENSE.
Copyright © 2016-2024. The Stdlib Authors.