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

isProbability

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

Test if a double-precision floating-point number 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 double-precision floating-point number 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' );
}

C APIs

Usage

#include "stdlib/math/base/assert/is_probability.h"

stdlib_base_is_probability( x )

Tests if a double-precision floating-point number is a probability.

bool out = stdlib_base_is_probability( 0.5 );
// returns true

out = stdlib_base_is_probability( 3.14 );
// returns false

The function accepts the following arguments:

x: [in] double input value.

bool stdlib_base_is_probability( const double x );

Examples

#include "stdlib/math/base/assert/is_probability.h"
#include <stdio.h>
#include <stdlib.h>
#include <stdbool.h>

int main( void ) {
    double x;
    bool v;
    int i;
    
    for ( i = 0; i < 100; i++ ) {
        x = ( ( (double)rand() / (double)RAND_MAX ) * 2.0 ) - 1.0;
        v = stdlib_base_is_probability( x );
        printf( "%lf is %sa probability\n", x, ( v ) ? "" : "not " );
    }
}

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.