About stdlib...
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
isProbability
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 );
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' );
}
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 );
out = stdlib_base_is_probability( 3.14 );
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.
License
See LICENSE.
Copyright
Copyright © 2016-2024. The Stdlib Authors.
0.2.2 (2024-04-04)
<section class="bug-fixes">
Bug Fixes
ca6614a
- add missing gypfile field entries
</section>
<!-- /.bug-fixes -->
<section class="commits">
Commits
<details>
ca6614a
- fix: add missing gypfile field entries (by Philipp Burckhardt)
</details>
</section>
<!-- /.commits -->
<section class="contributors">
Contributors
A total of 1 person contributed to this release. Thank you to this contributor:
</section>
<!-- /.contributors -->
</section>
<!-- /.release -->
<section class="release" id="v0.2.1">