@stdlib/assert-is-probability
v0.2.2
Published
Test if a value is a probability.
Downloads
20,790
Readme
isProbability
Test if a value is a probability.
A probability is defined as a numeric value on the interval [0,1]
.
Installation
npm install @stdlib/assert-is-probability
Usage
var isProbability = require( '@stdlib/assert-is-probability' );
isProbability( value )
Tests if a value
is a probability.
var Number = require( '@stdlib/number-ctor' );
var bool = isProbability( 0.5 );
// returns true
bool = isProbability( new Number( 0.5 ) );
// returns true
bool = isProbability( 3.14 );
// returns false
bool = isProbability( -5.0 );
// returns false
bool = isProbability( NaN );
// returns false
bool = isProbability( null );
// returns false
isProbability.isPrimitive( value )
Tests if a value
is a primitive probability.
var Number = require( '@stdlib/number-ctor' );
var bool = isProbability.isPrimitive( 0.33 );
// returns true
bool = isProbability.isPrimitive( new Number( 0.33 ) );
// returns false
isProbability.isObject( value )
Tests if a value
is a Number
object having a value which is a probability.
var Number = require( '@stdlib/number-ctor' );
var bool = isProbability.isObject( 0.11 );
// returns false
bool = isProbability.isObject( new Number( 0.11 ) );
// returns true
Examples
var Number = require( '@stdlib/number-ctor' );
var isProbability = require( '@stdlib/assert-is-probability' );
var bool = isProbability( 0.5 );
// returns true
bool = isProbability( new Number( 0.5 ) );
// returns true
bool = isProbability( 0.0 );
// returns true
bool = isProbability( 1.0 );
// returns true
bool = isProbability( 3.14 );
// returns false
bool = isProbability( -5.0 );
// returns false
bool = isProbability( NaN );
// returns false
bool = isProbability( '0.5' );
// returns false
bool = isProbability( null );
// returns false
See Also
@stdlib/assert-is-number
: test if a value is a number.
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.
Copyright
Copyright © 2016-2024. The Stdlib Authors.