diff --git a/lib/node_modules/@stdlib/math/base/assert/is-prime/README.md b/lib/node_modules/@stdlib/math/base/assert/is-prime/README.md index 518c4a34647e..c6de58a6fdde 100644 --- a/lib/node_modules/@stdlib/math/base/assert/is-prime/README.md +++ b/lib/node_modules/@stdlib/math/base/assert/is-prime/README.md @@ -80,6 +80,97 @@ bool = isPrime( NaN ); + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/math/base/assert/is_prime.h" +``` + +#### stdlib_base_is_prime( x ) + +Tests if a finite double-precision floating-point number is a prime number. + +```c +#include + +bool out = stdlib_base_is_prime( 11.0 ); +// returns true + +out = stdlib_base_is_prime( 3.14 ); +// returns false +``` + +The function accepts the following arguments: + +- **x**: `[in] double` input value. + +```c +bool stdlib_base_is_prime( const double x ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/math/base/assert/is_prime.h" +#include +#include + +int main( void ) { + const double x[] = { 5.0, -5.0, 3.14, -3.14, -2.0, 2.0, 0.0, 0.0/0.0 }; + + bool b; + int i; + for ( i = 0; i < 6; i++ ) { + b = stdlib_base_is_prime( x[ i ] ); + printf( "Value: %lf. Is Prime? %s.\n", x[ i ], ( b ) ? "True" : "False" ); + } +} +``` + +
+ + + +
+ + +