diff --git a/lib/node_modules/@stdlib/math/base/special/sici/README.md b/lib/node_modules/@stdlib/math/base/special/sici/README.md index 1c76aa5ec9f5..547197c63ae3 100644 --- a/lib/node_modules/@stdlib/math/base/special/sici/README.md +++ b/lib/node_modules/@stdlib/math/base/special/sici/README.md @@ -131,6 +131,98 @@ for ( i = 0; i < 100; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/math/base/special/sici.h" +``` + +#### stdlib_base_sici( x, si, ci ) + +Computes the sine and cosine integrals. + +```c +double si; +double ci; + +stdlib_base_sici( 3.0, &si, &ci ); +// si => ~1.849 +// ci => ~0.12 +``` + +The function accepts the following arguments: + +- **x**: `[in] double` input value. +- **si**: `[out] double*` destination for the sine integral. +- **ci**: `[out] double*` destination for the cosine integral. + +```c +void stdlib_base_sici( const double x, double *si, double *ci ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/math/base/special/sici.h" +#include + +int main( void ) { + const double x[] = { 0.0, 0.5, 1.0, 3.0, 5.0, -3.0, 9.0 }; + + double si; + double ci; + int i; + for ( i = 0; i < 7; i++ ) { + stdlib_base_sici( x[ i ], &si, &ci ); + printf( "sici(%lf) => Si: %lf, Ci: %lf\n", x[ i ], si, ci ); + } +} +``` + +
+ + + +
+ + +