Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ static const float SQRT_5 = 2.23606797749979f;
* @return Fibonacci number index
*
* @example
* float out = stdlib_base_fibonacci_index( 2.0f );
* float out = stdlib_base_fibonacci_indexf( 2.0f );
* // returns 3.0f
*/
float stdlib_base_fibonacci_indexf( const float F ) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ static double rational_pq( const double x ) {
* @return Lanczos sum approximation
*
* @example
* double v = stdlib_base_gammaLanczosSum( 4.0 );
* double v = stdlib_base_gamma_lanczos_sum( 4.0 );
* // returns ~950.366
*/
double stdlib_base_gamma_lanczos_sum( const double x ) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -408,7 +408,7 @@ static double hyt2f1( const double a, const double b, const double c, const doub
* @return function value
*
* @example
* double v = stdlib_base_gamma( 1.0, 1.0, 1.0, 0.0 );
* double v = stdlib_base_hyp2f1( 1.0, 1.0, 1.0, 0.0 );
* // returns 1.0
*/
double stdlib_base_hyp2f1( const double a, const double b, const double c, const double x ) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,11 @@
* @return function value
*
* @example
* float v = stdlib_base_kronecker_delta( 3.0f, 3.0f );
* float v = stdlib_base_kronecker_deltaf( 3.0f, 3.0f );
* // returns 1.0f
*
* @example
* float v = stdlib_base_kronecker_delta( 3.0f, 3.14f );
* float v = stdlib_base_kronecker_deltaf( 3.0f, 3.14f );
* // returns 0.0f
*/
float stdlib_base_kronecker_deltaf( const float i, const float j ) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
*
* @example
* double out = stdlib_base_log1pmx( 0.0 );
* // returns ~0.693
* // returns 0.0
*/
double stdlib_base_log1pmx( const double x ) {
double ax;
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/math/base/special/sech/src/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
* @return hyperbolic secant
*
* @example
* var v = stdlib_base_sech( 2.0 );
* double v = stdlib_base_sech( 2.0 );
* // returns ~0.2658
*/
double stdlib_base_sech( const double x ) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
*
* @example
* double out = stdlib_base_sqrtpi( 4.0 );
* // returns 3.5449
* // returns ~3.5449
*/
double stdlib_base_sqrtpi( const double x ) {
return stdlib_base_sqrt( x * STDLIB_CONSTANT_FLOAT64_PI );
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
* @return rounded value
*
* @example
* double y = stdlib_base_trunc2( 13.0 );
* double y = stdlib_base_trunc10( 13.0 );
* // returns 10.0
*/
double stdlib_base_trunc10( const double x ) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
*
* @example
* float y = stdlib_base_vercosf( 3.141592653589793f / 2.0f );
* // returns 1.0f
* // returns ~1.0f
*/
float stdlib_base_vercosf( const float x ) {
return 1.0f + stdlib_base_cosf( x );
Expand Down