diff --git a/lib/node_modules/@stdlib/math/base/assert/is-evenf/README.md b/lib/node_modules/@stdlib/math/base/assert/is-evenf/README.md new file mode 100644 index 000000000000..befd8dc79fc4 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/assert/is-evenf/README.md @@ -0,0 +1,213 @@ + + +# isEvenf + +> Test if a finite single-precision floating-point number is an even number. + +
+ +## Usage + +```javascript +var isEvenf = require( '@stdlib/math/base/assert/is-evenf' ); +``` + +#### isEvenf( x ) + +Tests if a **finite** single-precision floating-point number is an even number. + +```javascript +var bool = isEvenf( 5.0 ); +// returns false + +bool = isEvenf( -2.0 ); +// returns true + +bool = isEvenf( 0.0 ); +// returns true + +bool = isEvenf( NaN ); +// returns false +``` + +
+ + + +
+ +## Notes + +- The function assumes a **finite** `number`. If provided positive or negative `infinity`, the function will return `true`, when, in fact, the result is undefined. If `x` can be `infinite`, wrap the implementation as follows: + + ```javascript + function check( x ) { + return ( + x < Infinity && + x > -Infinity && + isEvenf( x ) + ); + } + + var bool = check( Infinity ); + // returns false + + bool = check( -Infinity ); + // returns false + ``` + +
+ + + +
+ +## Examples + + + +```javascript +var randu = require( '@stdlib/random/array/discrete-uniform' ); +var isEvenf = require( '@stdlib/math/base/assert/is-evenf' ); + +var bool; +var x; +var i; + +x = randu( 100, 0, 100 ); + +for ( i = 0; i < 100; i++ ) { + bool = isEvenf( x[ i ] ); + console.log( '%d is %s', x[ i ], ( bool ) ? 'even' : 'not even' ); +} +``` + +
+ + + + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/math/base/assert/is_evenf.h" +``` + +#### stdlib_base_is_evenf( x ) + +Tests if a finite single-precision floating-point number is an even number. + +```c +bool out = stdlib_base_is_evenf( 1.0f ); +// returns false + +out = stdlib_base_is_evenf( 4.0f ); +// returns true +``` + +The function accepts the following arguments: + +- **x**: `[in] float` input value. + +```c +bool stdlib_base_is_evenf( const float x ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include +#include +#include + +int main( void ) { + float x; + bool v; + int i; + + for ( i = 0; i < 100; i++ ) { + x = ( ( (float)rand() / (float)RAND_MAX ) * 100.0f ); + v = stdlib_base_is_evenf( x ); + printf( "x = %f, is_evenf(x) = %s\n", x, ( v ) ? "even" : "not even" ); + } +} +``` + +
+ + + +
+ + + + + +