diff --git a/base/assert/is-nonpositive-finite/README.md b/base/assert/is-nonpositive-finite/README.md index 8b44f2a0f..fbc57c28d 100644 --- a/base/assert/is-nonpositive-finite/README.md +++ b/base/assert/is-nonpositive-finite/README.md @@ -35,10 +35,10 @@ var isNonPositiveFinite = require( '@stdlib/math/base/assert/is-nonpositive-fini Tests if a `numeric` value is a nonpositive finite number. ```javascript -var bool = isNonPositiveFinite( 3.14 ); +var bool = isNonPositiveFinite( -3.14 ); // returns true -bool = isNonPositiveFinite( -2.0 ); +bool = isNonPositiveFinite( 2.0 ); // returns false ``` @@ -61,13 +61,13 @@ bool = isNonPositiveFinite( -2.0 ); ```javascript var isNonPositiveFinite = require( '@stdlib/math/base/assert/is-nonpositive-finite' ); -var bool = isNonPositiveFinite( 3.14 ); +var bool = isNonPositiveFinite( -3.14 ); // returns true bool = isNonPositiveFinite( 0.0 ); // returns true -bool = isNonPositiveFinite( -2.0 ); +bool = isNonPositiveFinite( 2.0 ); // returns false bool = isNonPositiveFinite( Infinity ); @@ -81,6 +81,97 @@ bool = isNonPositiveFinite( NaN ); + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/math/base/assert/is_nonpositive_finite.h" +``` + +#### stdlib_base_is_nonpositive_finite( x ) + +Tests if a numeric value is a nonpositive finite number. + +```c +#include + +bool out = stdlib_base_is_nonpositive_finite( -3.14 ); +// returns true + +out = stdlib_base_is_nonpositive_finite( 2.0 ); +// returns false +``` + +The function accepts the following arguments: + +- **x**: `[in] double` input value. + +```c +bool stdlib_base_is_nonpositive_finite( const double x ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/math/base/assert/is_nonpositive_finite.h" +#include +#include + +int main( void ) { + const double x[] = { 5.0, -5.0, 3.14, -3.14, 0.0, 0.0/0.0 }; + + bool b; + int i; + for ( i = 0; i < 6; i++ ) { + b = stdlib_base_is_nonpositive_finite( x[ i ] ); + printf( "Value: %lf. Is NonPositive Finite? %s.\n", x[ i ], ( b ) ? "True" : "False" ); + } +} +``` + +
+ + + +
+ + +