diff --git a/lib/node_modules/@stdlib/math/base/assert/is-nonpositive-integer/README.md b/lib/node_modules/@stdlib/math/base/assert/is-nonpositive-integer/README.md index 6cdb584bbe3..bd5f216fdbd 100644 --- a/lib/node_modules/@stdlib/math/base/assert/is-nonpositive-integer/README.md +++ b/lib/node_modules/@stdlib/math/base/assert/is-nonpositive-integer/README.md @@ -110,6 +110,97 @@ bool = isNonPositiveInteger( NaN ); + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/math/base/assert/is_nonpositive-integer.h" +``` + +#### stdlib_base_is_nonpositive_integer( x ) + +Tests if a finite double-precision floating-point number is a nonpositive integer. + +```c +bool out = stdlib_base_is_nonpositive_integer( -5.0 ); +// returns true + +out = stdlib_base_is_nonpositive_integer( 0.0 ); +// returns true +``` + +The function accepts the following arguments: + +- **x**: `[in] double` input value. + +```c +bool stdlib_base_is_nonpositive_integer( const double x ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/math/base/assert/is_nonpositive_integer.h" +#include +#include +#include + +int main( void ) { + double x; + bool v; + int i; + + for ( i = 0; i < 100; i++ ) { + x = ( ( (double)rand() / (double)RAND_MAX ) * 100.0 ); + v = stdlib_base_is_nonpositive_integer( x ); + printf( "x = %lf, is_nonpositive_integer(x) = %s\n", x, ( v ) ? "True" : "False" ); + } +} +``` + +
+ + + +
+ + +