diff --git a/lib/node_modules/@stdlib/math/base/special/heavisidef/README.md b/lib/node_modules/@stdlib/math/base/special/heavisidef/README.md index df19a274c4f4..7e44bf80c52b 100644 --- a/lib/node_modules/@stdlib/math/base/special/heavisidef/README.md +++ b/lib/node_modules/@stdlib/math/base/special/heavisidef/README.md @@ -155,7 +155,7 @@ var heavisidef = require( '@stdlib/math/base/special/heavisidef' ); var opts = { 'dtype': 'float32' }; -var x = uniform( 101, -10.0, 10.0, opts ); +var x = uniform( 100, -10.0, 10.0, opts ); logEachMap( 'H(%0.4f) = %0.4f', x, heavisidef ); ``` @@ -164,6 +164,104 @@ logEachMap( 'H(%0.4f) = %0.4f', x, heavisidef ); + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/math/base/special/heavisidef.h" +``` + +#### stdlib_base_heavisidef( x, continuity ) + +Evaluates the [Heaviside function][heaviside-function] for a single-precision floating-point number. + +```c +float y = stdlib_base_heavisidef( 0.0f, STDLIB_BASE_HEAVISIDEF_CONTINUITY_HALF_MAXIMUM ); +// returns 0.5f + +y = stdlib_base_heavisidef( 0.0f, STDLIB_BASE_HEAVISIDEF_CONTINUITY_LEFT_CONTINUOUS ); +// returns 0.0f +``` + +The function accepts the following arguments: + +- **x**: `[in] float` input value. +- **continuity**: `[in] STDLIB_BASE_HEAVISIDEF_CONTINUITY` continuity option. + +The `continuity` parameter may be one of the following values: + +- `STDLIB_BASE_HEAVISIDEF_CONTINUITY_HALF_MAXIMUM`: if `x == 0`, the function returns `0.5`. +- `STDLIB_BASE_HEAVISIDEF_CONTINUITY_LEFT_CONTINUOUS`: if `x == 0`, the function returns `0.0`. +- `STDLIB_BASE_HEAVISIDEF_CONTINUITY_RIGHT_CONTINUOUS`: if `x == 0`, the function returns `1.0`. +- `STDLIB_BASE_HEAVISIDEF_CONTINUITY_DISCONTINUOUS`: if `x == 0`, the function returns `NaN`. + +If provided a `continuity` argument which is not one of the enumeration constants listed above, the function returns `NaN` for `x == 0`, behaving like the discontinuous case. + +```c +float stdlib_base_heavisidef( const float x, const STDLIB_BASE_HEAVISIDEF_CONTINUITY continuity ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/math/base/special/heavisidef.h" +#include + +int main( void ) { + const float x[] = { -4.0f, -3.0f, -2.0f, -1.0f, 0.0f, 1.0f, 2.0f, 3.0f, 4.0f, 5.0f }; + + float y; + int i; + for ( i = 0; i < 10; i++ ) { + y = stdlib_base_heavisidef( x[ i ], STDLIB_BASE_HEAVISIDEF_CONTINUITY_HALF_MAXIMUM ); + printf( "H(%f) = %f\n", x[ i ], y ); + } +} +``` + +
+ + + +
+ + +