isProbabilityf

Test if a single-precision floating-point number is a probability.

Installation

npm install @stdlib/math-base-assert-is-probabilityf

Usage

var isProbabilityf = require( '@stdlib/math-base-assert-is-probabilityf' );

isProbabilityf( x )

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

var bool = isProbabilityf( 0.5 );
// returns true

bool = isProbabilityf( 3.14 );
// returns false

bool = isProbabilityf( NaN );
// returns false

Examples

var uniform = require( '@stdlib/random-array-uniform' );
var logEachMap = require( '@stdlib/console-log-each-map' );
var isProbabilityf = require( '@stdlib/math-base-assert-is-probabilityf' );

var opts = {
    'dtype': 'float32'
};
var x = uniform( 100, -1.0, 1.0, opts );

function isProbabilityfWrapper( value ) {
    return ( isProbabilityf( value ) ) ? 'a probability' : 'not a probability';
}
logEachMap( '%0.4f is %s', x, isProbabilityfWrapper );

C APIs

Usage

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

stdlib_base_is_probabilityf( x )

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

#include <stdbool.h>

bool out = stdlib_base_is_probabilityf( 0.5f );
// returns true

out = stdlib_base_is_probabilityf( 3.14f );
// returns false

The function accepts the following arguments:

• x: [in] float input value.

bool stdlib_base_is_probabilityf( const float x );

Examples

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

int main( void ) {
    float x;
    bool v;
    int i;

    for ( i = 0; i < 100; i++ ) {
        x = ( ( (float)rand() / (float)RAND_MAX ) * 2.0f ) - 1.0f;
        v = stdlib_base_is_probabilityf( x );
        printf( "%f 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.

Community

License

See LICENSE.

Copyright

Copyright © 2016-2026. The Stdlib Authors.