diff --git a/lib/node_modules/@stdlib/math/base/special/erfcx/README.md b/lib/node_modules/@stdlib/math/base/special/erfcx/README.md index bc82e9f0381..3ec5fd40a23 100644 --- a/lib/node_modules/@stdlib/math/base/special/erfcx/README.md +++ b/lib/node_modules/@stdlib/math/base/special/erfcx/README.md @@ -120,6 +120,94 @@ for ( i = 0; i < x.length; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/math/base/special/erfcx.h" +``` + +#### erfcx( x ) + +Evaluates the [scaled complementary error function][complementary-error-function]. + +```c +double y = stdlib_base_erfcx( 0.0 ); +// returns 1.0 + +y = stdlib_base_erfcx( 1.0 ); +// returns ~0.4276 +``` + +The function accepts the following arguments: + +- **x**: `[in] double` input value. + +```c +double stdlib_base_erfcx( const double x ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/math/base/special/erfcx.h" +#include + +int main( void ) { + const double x[] = { 0.0, 0.22, 0.44, 0.67, 0.89, 1.11, 1.33, 1.56, 1.78, 2.0 }; + + double v; + int i; + for ( i = 0; i < 10; i++ ) { + v = stdlib_base_erfcx( x[ i ] ); + printf( "x: %lf, erfcx(x): %lf\n", x[ i ], v ); + } +} +``` + +
+ + + +
+ + +