diff --git a/lib/node_modules/@stdlib/math/base/assert/int32-is-even/README.md b/lib/node_modules/@stdlib/math/base/assert/int32-is-even/README.md index 89358ad1ead..2945bcb9fcb 100644 --- a/lib/node_modules/@stdlib/math/base/assert/int32-is-even/README.md +++ b/lib/node_modules/@stdlib/math/base/assert/int32-is-even/README.md @@ -81,6 +81,98 @@ for ( i = 0; i < 100; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/math/base/assert/int32_is_even.h" +``` + +#### stdlib_base_int32_is_even( x ) + +Tests if 32-bit integer is even. + +```c +#include + +bool out = stdlib_base_int32_is_even( -2 ); +// returns true + +out = stdlib_base_int32_is_even( 5 ); +// returns false +``` + +The function accepts the following arguments: + +- **x**: `[in] int32_t` input value. + +```c +bool stdlib_base_int32_is_even( const int32_t x ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/math/base/assert/int32_is_even.h" +#include +#include +#include + +int main( void ) { + const int32_t x[] = { 5, -5, 3, -3, 0, 2 }; + + bool b; + int i; + for ( i = 0; i < 5; i++ ) { + b = stdlib_base_int32_is_even( x[ i ] ); + printf( "Value: %d. int32 Is even? %s.\n", x[ i ], ( b ) ? "True" : "False" ); + } +} +``` + +
+ + + +
+ + +