isProbability
Test if a numeric value is a probability.
Installation
npm install @stdlib/math-base-assert-is-probability
Usage
var isProbability = require( '@stdlib/math-base-assert-is-probability' );
isProbability( x )
Tests if a numeric
value is a probability.
var bool = isProbability( 0.5 );
bool = isProbability( 3.14 );
bool = isProbability( NaN );
Examples
var randu = require( '@stdlib/random-base-randu' );
var isProbability = require( '@stdlib/math-base-assert-is-probability' );
var bool;
var x;
var i;
for ( i = 0; i < 100; i++ ) {
x = ( randu()*2.0 ) - 1.0;
bool = isProbability( x );
console.log( '%d is %s', x, ( bool ) ? 'a probability' : 'not a probability' );
}
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.
License
See LICENSE.
Copyright
Copyright © 2016-2021. The Stdlib Authors.
0.0.2 (2021-06-15)
No changes reported for this release.
</section>
<!-- /.release -->
<section class="release" id="v0.0.1">