Update descriptions and examples and clean-up

kgryte · kgryte · commit 4cb9cc33dcd7 · 2023-02-13T18:45:23.000-08:00
diff --git a/lib/node_modules/@stdlib/math/base/special/sinh/README.md b/lib/node_modules/@stdlib/math/base/special/sinh/README.md
@@ -20,7 +20,7 @@ limitations under the License.
 
 # sinh
 
-> Compute the [hyperbolic sine][hyperbolic-sine] of a number.
+> Compute the [hyperbolic sine][hyperbolic-sine] of a double-precision floating-point number.
 
 <section class="usage">
 
@@ -32,7 +32,7 @@ var sinh = require( '@stdlib/math/base/special/sinh' );
 
 #### sinh( x )
 
-Computes the [hyperbolic sine][hyperbolic-sine] of `x`.
+Computes the [hyperbolic sine][hyperbolic-sine] of double-precision floating-point number `x`.
 
 ```javascript
 var v = sinh( 0.0 );
@@ -105,7 +105,7 @@ for ( i = 0; i < x.length; i++ ) {
 
 #### stdlib_base_sinh( x )
 
-Computes the [hyperbolic sine][hyperbolic-sine] of `x`.
+Computes the [hyperbolic sine][hyperbolic-sine] of double-precision floating-point number `x`.
 
 ```c
 double out = stdlib_base_sinh( 2.0 );
@@ -146,7 +146,7 @@ double stdlib_base_sinh( const double x );
 #include <stdio.h>
 
 int main() {
-    double x[] = { -5.0, -3.89, -2.78, -1.67, -0.56, 0.56, 1.67, 2.78, 3.89, 5.0 };
+    const double x[] = { -5.0, -3.89, -2.78, -1.67, -0.56, 0.56, 1.67, 2.78, 3.89, 5.0 };
     double v;
     int i;
     
diff --git a/lib/node_modules/@stdlib/math/base/special/sinh/docs/repl.txt b/lib/node_modules/@stdlib/math/base/special/sinh/docs/repl.txt
@@ -1,6 +1,6 @@
 
 {{alias}}( x )
-    Computes the hyperbolic sine of a number.
+    Computes the hyperbolic sine of a double-precision floating-point number.
 
     Parameters
     ----------
diff --git a/lib/node_modules/@stdlib/math/base/special/sinh/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/sinh/docs/types/index.d.ts
@@ -19,7 +19,7 @@
 // TypeScript Version: 2.0
 
 /**
-* Computes the hyperbolic sine of a number.
+* Computes the hyperbolic sine of a double-precision floating-point number.
 *
 * @param x - input value
 * @returns hyperbolic sine
diff --git a/lib/node_modules/@stdlib/math/base/special/sinh/examples/c/example.c b/lib/node_modules/@stdlib/math/base/special/sinh/examples/c/example.c
@@ -20,7 +20,7 @@
 #include <stdio.h>
 
 int main() {
-    double x[] = { -5.0, -3.89, -2.78, -1.67, -0.56, 0.56, 1.67, 2.78, 3.89, 5.0 };
+    const double x[] = { -5.0, -3.89, -2.78, -1.67, -0.56, 0.56, 1.67, 2.78, 3.89, 5.0 };
     double v;
     int i;
     
diff --git a/lib/node_modules/@stdlib/math/base/special/sinh/include/stdlib/math/base/special/sinh.h b/lib/node_modules/@stdlib/math/base/special/sinh/include/stdlib/math/base/special/sinh.h
@@ -27,7 +27,7 @@ extern "C" {
 #endif
 
 /**
-* Computes the hyperbolic sine of a number.
+* Computes the hyperbolic sine of a double-precision floating-point number.
 */
 double stdlib_base_sinh( const double x );
 
diff --git a/lib/node_modules/@stdlib/math/base/special/sinh/lib/index.js b/lib/node_modules/@stdlib/math/base/special/sinh/lib/index.js
@@ -19,7 +19,7 @@
 'use strict';
 
 /**
-* Compute the hyperbolic sine of a number.
+* Compute the hyperbolic sine of a double-precision floating-point number.
 *
 * @module @stdlib/math/base/special/sinh
 *
diff --git a/lib/node_modules/@stdlib/math/base/special/sinh/lib/main.js b/lib/node_modules/@stdlib/math/base/special/sinh/lib/main.js
@@ -59,7 +59,7 @@ var LARGE = MAXLOG - LN2;
 // MAIN //
 
 /**
-* Computes the hyperbolic sine of a number.
+* Computes the hyperbolic sine of a double-precision floating-point number.
 *
 * ## Method
 *
@@ -109,10 +109,10 @@ function sinh( x ) {
 	if ( x === 0.0 ) {
 		return x; // handles `+-0`
 	}
-	a = abs( x );
 	if ( x > POS_OVERFLOW || x < NEG_OVERFLOW ) {
 		return ( x > 0.0 ) ? PINF : NINF;
 	}
+	a = abs( x );
 	if ( a > 1.0 ) {
 		if ( a >= LARGE ) {
 			a = exp( 0.5*a );
diff --git a/lib/node_modules/@stdlib/math/base/special/sinh/lib/native.js b/lib/node_modules/@stdlib/math/base/special/sinh/lib/native.js
@@ -26,7 +26,7 @@ var addon = require( './../src/addon.node' );
 // MAIN //
 
 /**
-* Computes the hyperbolic sine of a number.
+* Computes the hyperbolic sine of a double-precision floating-point number.
 *
 * @private
 * @param {number} x - input value
diff --git a/lib/node_modules/@stdlib/math/base/special/sinh/package.json b/lib/node_modules/@stdlib/math/base/special/sinh/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@stdlib/math/base/special/sinh",
   "version": "0.0.0",
-  "description": "Compute the hyperbolic sine of a number.",
+  "description": "Compute the hyperbolic sine of a double-precision floating-point number.",
   "license": "Apache-2.0",
   "author": {
     "name": "The Stdlib Authors",
diff --git a/lib/node_modules/@stdlib/math/base/special/sinh/src/main.c b/lib/node_modules/@stdlib/math/base/special/sinh/src/main.c
@@ -18,7 +18,7 @@
 *
 * ## Notice
 *
-* The original C code, long comment, copyright, license, and constants are from [Cephes]{@link http://www.netlib.org/cephes}. The implementation follows the original, but has been modified for JavaScript.
+* The original C code, long comment, copyright, license, and constants are from [Cephes]{@link http://www.netlib.org/cephes}. The implementation follows the original, but has been modified according to project conventions.
 *
 * ```text
 * Copyright 1984, 1995, 2000 by Stephen L. Moshier
@@ -38,8 +38,13 @@
 #include "stdlib/constants/float64/ln_two.h"
 #include <stdint.h>
 
+// MAXLOG + LN2 = ln(2^1024) + LN2
 static const double POS_OVERFLOW = 7.09782712893383996843e2 + STDLIB_CONSTANT_FLOAT64_LN2;
+
+// MINLOG - LN2 = ln(2^-1022) - LN2
 static const double NEG_OVERFLOW = -7.08396418532264106224e2 - STDLIB_CONSTANT_FLOAT64_LN2;
+
+// MAXLOG - LN2 = ln(2^1024) - LN2
 static const double LARGE = 7.09782712893383996843e2 - STDLIB_CONSTANT_FLOAT64_LN2;
 
 /* Begin auto-generated functions. The following functions are auto-generated. Do not edit directly. */
@@ -88,40 +93,67 @@ static double rational_pq( const double x ) {
 /* End auto-generated functions. */
 
 /**
-* Computes the hyperbolic sine of a number.
+* Computes the hyperbolic sine of a double-precision floating-point number.
+*
+* ## Method
+*
+* The range is partitioned into two segments. If \\( |x| \le 1 \\), we use a rational function of the form
+*
+* ```tex
+* x + x^3 \frac{\mathrm{P}(x)}{\mathrm{Q}(x)}
+* ```
+*
+* Otherwise, the calculation is
+*
+* ```tex
+* \operatorname{sinh}(x) = \frac{ e^x - e^{-x} }{2}.
+* ```
+*
+* ## Notes
+*
+* -   Relative error:
+*
+*     | arithmetic | domain   | # trials | peak    | rms     |
+*     |:----------:|:--------:|:--------:|:-------:|:-------:|
+*     | DEC        | +- 88    | 50000    | 4.0e-17 | 7.7e-18 |
+*     | IEEE       | +-MAXLOG | 30000    | 2.6e-16 | 5.7e-17 |
 *
 * @param x    input value
 * @return     output value
 *
 * @example
 * double out = stdlib_base_sinh( 0.0 );
 * // returns 0.0
+*
+* @example
+* double out = stdlib_base_sinh( 2.0 );
+* // returns ~3.627
 */
 double stdlib_base_sinh( const double x ) {
-    double a;
-    if ( x == 0.0 ) {
-        return x; // handles `+-0`
-    }
-    a = stdlib_base_abs( x );
-    if ( x > POS_OVERFLOW || x < NEG_OVERFLOW ) {
-        return ( x > 0.0 ) ? STDLIB_CONSTANT_FLOAT64_PINF : STDLIB_CONSTANT_FLOAT64_NINF;
-    }
-    if ( a > 1.0 ) {
-        if ( a >= LARGE ) {
-            a = stdlib_base_exp( 0.5 * a );
-            a *= 0.5 * a;
-            if ( x < 0.0 ) {
-                a = -a;
-            }
-            return a;
-        }
-        a = stdlib_base_exp( a );
-        a = ( 0.5 * a ) - ( 0.5 / a );
-        if ( x < 0.0 ) {
-            a = -a;
-        }
-        return a;
-    }
-    a *= a;
-    return x + ( x * a * rational_pq( a ) );
+	double a;
+	if ( x == 0.0 ) {
+		return x; // handles `+-0`
+	}
+	if ( x > POS_OVERFLOW || x < NEG_OVERFLOW ) {
+		return ( x > 0.0 ) ? STDLIB_CONSTANT_FLOAT64_PINF : STDLIB_CONSTANT_FLOAT64_NINF;
+	}
+	a = stdlib_base_abs( x );
+	if ( a > 1.0 ) {
+		if ( a >= LARGE ) {
+			a = stdlib_base_exp( 0.5*a );
+			a *= 0.5 * a;
+			if ( x < 0.0 ) {
+				a = -a;
+			}
+			return a;
+		}
+		a = stdlib_base_exp( a );
+		a = ( 0.5*a ) - ( 0.5/a );
+		if ( x < 0.0 ) {
+			a = -a;
+		}
+		return a;
+	}
+	a *= a;
+	return x + ( x * a * rational_pq( a ) );
 }
diff --git a/lib/node_modules/@stdlib/math/base/special/sinh/test/test.native.js b/lib/node_modules/@stdlib/math/base/special/sinh/test/test.native.js
@@ -28,9 +28,9 @@ var isNegativeZero = require( '@stdlib/math/base/assert/is-negative-zero' );
 var isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' );
 var PINF = require( '@stdlib/constants/float64/pinf' );
 var NINF = require( '@stdlib/constants/float64/ninf' );
-var tryRequire = require( '@stdlib/utils/try-require' );
 var EPS = require( '@stdlib/constants/float64/eps' );
 var abs = require( '@stdlib/math/base/special/abs' );
+var tryRequire = require( '@stdlib/utils/try-require' );
 
 
 // FIXTURES //

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@`
`19`	`19`	`// TypeScript Version: 2.0`
`20`	`20`
`21`	`21`	`/**`
`22`		`-* Computes the hyperbolic sine of a number.`
	`22`	`+* Computes the hyperbolic sine of a double-precision floating-point number.`
`23`	`23`	`*`
`24`	`24`	`* @param x - input value`
`25`	`25`	`* @returns hyperbolic sine`
Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ var LARGE = MAXLOG - LN2;`
`59`	`59`	`// MAIN //`
`60`	`60`
`61`	`61`	`/**`
`62`		`-* Computes the hyperbolic sine of a number.`
	`62`	`+* Computes the hyperbolic sine of a double-precision floating-point number.`
`63`	`63`	`*`
`64`	`64`	`* ## Method`
`65`	`65`	`*`
`@@ -109,10 +109,10 @@ function sinh( x ) {`
`109`	`109`	`if ( x === 0.0 ) {`
`110`	`110`	return x; // handles `+-0`
`111`	`111`	`}`
`112`		`- a = abs( x );`
`113`	`112`	`if ( x > POS_OVERFLOW \|\| x < NEG_OVERFLOW ) {`
`114`	`113`	`return ( x > 0.0 ) ? PINF : NINF;`
`115`	`114`	`}`
	`115`	`+ a = abs( x );`
`116`	`116`	`if ( a > 1.0 ) {`
`117`	`117`	`if ( a >= LARGE ) {`
`118`	`118`	`a = exp( 0.5*a );`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ var addon = require( './../src/addon.node' );`
`26`	`26`	`// MAIN //`
`27`	`27`
`28`	`28`	`/**`
`29`		`-* Computes the hyperbolic sine of a number.`
	`29`	`+* Computes the hyperbolic sine of a double-precision floating-point number.`
`30`	`30`	`*`
`31`	`31`	`* @private`
`32`	`32`	`* @param {number} x - input value`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@stdlib/math/base/special/sinh",`
`3`	`3`	`"version": "0.0.0",`
`4`		`- "description": "Compute the hyperbolic sine of a number.",`
	`4`	`+ "description": "Compute the hyperbolic sine of a double-precision floating-point number.",`
`5`	`5`	`"license": "Apache-2.0",`
`6`	`6`	`"author": {`
`7`	`7`	`"name": "The Stdlib Authors",`