diff --git a/lib/node_modules/@stdlib/math/base/assert/is-composite/README.md b/lib/node_modules/@stdlib/math/base/assert/is-composite/README.md index c7c7e06b424f..71c456907a15 100644 --- a/lib/node_modules/@stdlib/math/base/assert/is-composite/README.md +++ b/lib/node_modules/@stdlib/math/base/assert/is-composite/README.md @@ -80,6 +80,95 @@ bool = isComposite( NaN ); + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/math/base/special/is_composite.h" +``` + +#### stdlib_base_is_composite( x ) + +Tests if a finite double-precision floating-point number is a composite number. + +```c +#include + +bool out = stdlib_base_is_composite( 3.0 ); +// returns false +``` + +The function accepts the following arguments: + +- **x**: `[in] double` input value. + +```c +bool stdlib_base_is_composite( const double x ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/math/base/assert/is_composite.h" +#include +#include + +int main( void ) { + const double x[] = { 0.0, 0.0/0.0, 1.0, -1.0 , 4.0 }; + + bool r; + int i; + for ( i = 0; i < 5; i++ ) { + r = stdlib_base_is_composite( x[ i ] ); + printf( "Value: %lf. Is Composite? %s.\n", x[ i ], ( r ) ? "True" : "False" ); + } +} +``` + +
+ + + +
+ + + +