README

isProbability

$NPM version$ $Build Status$ $Coverage Status$

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 );
// returns true

bool = isProbability( 3.14 );
// returns false

bool = isProbability( NaN );
// returns false

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.

Community

License

See LICENSE.

@stdlib/math-base-assert-is-probability

Usage no npm install needed!