Update namespace TypeScript declarations (stdlib-js#615)

github-actions[bot] · kgryte · web-flow · commit e274b609b224 · 2022-11-11T01:49:22.000-08:00
Co-authored-by: kgryte &lt;kgryte@users.noreply.github.com&gt;
diff --git a/lib/node_modules/@stdlib/constants/float32/docs/types/index.d.ts b/lib/node_modules/@stdlib/constants/float32/docs/types/index.d.ts
@@ -21,16 +21,20 @@
 /* tslint:disable:max-line-length */
 /* tslint:disable:max-file-line-count */
 
+import ABS_MASK = require( '@stdlib/constants/float32/abs-mask' );
 import CBRT_EPS = require( '@stdlib/constants/float32/cbrt-eps' );
 import EPS = require( '@stdlib/constants/float32/eps' );
 import EXPONENT_BIAS = require( '@stdlib/constants/float32/exponent-bias' );
+import EXPONENT_MASK = require( '@stdlib/constants/float32/exponent-mask' );
 import MAX = require( '@stdlib/constants/float32/max' );
 import MAX_SAFE_INTEGER = require( '@stdlib/constants/float32/max-safe-integer' );
 import MIN_SAFE_INTEGER = require( '@stdlib/constants/float32/min-safe-integer' );
 import NINF = require( '@stdlib/constants/float32/ninf' );
 import NUM_BYTES = require( '@stdlib/constants/float32/num-bytes' );
 import PINF = require( '@stdlib/constants/float32/pinf' );
 import PRECISION = require( '@stdlib/constants/float32/precision' );
+import SIGN_MASK = require( '@stdlib/constants/float32/sign-mask' );
+import SIGNIFICAND_MASK = require( '@stdlib/constants/float32/significand-mask' );
 import SMALLEST_NORMAL = require( '@stdlib/constants/float32/smallest-normal' );
 import SMALLEST_SUBNORMAL = require( '@stdlib/constants/float32/smallest-subnormal' );
 import SQRT_EPS = require( '@stdlib/constants/float32/sqrt-eps' );
@@ -39,6 +43,15 @@ import SQRT_EPS = require( '@stdlib/constants/float32/sqrt-eps' );
 * Interface describing the `float32` namespace.
 */
 interface Namespace {
+	/**
+	* Mask for excluding the sign bit of a single-precision floating-point number.
+	*
+	* @example
+	* var mask = ns.ABS_MASK;
+	* // returns 2147483647
+	*/
+	ABS_MASK: typeof ABS_MASK;
+
 	/**
 	* Cube root of single-precision floating-point epsilon.
 	*
@@ -66,6 +79,15 @@ interface Namespace {
 	*/
 	EXPONENT_BIAS: typeof EXPONENT_BIAS;
 
+	/**
+	* Mask for the exponent of a single-precision floating-point number.
+	*
+	* @example
+	* var mask = ns.EXPONENT_MASK;
+	* // returns 2139095040
+	*/
+	EXPONENT_MASK: typeof EXPONENT_MASK;
+
 	/**
 	* Maximum single-precision floating-point number.
 	*
@@ -129,6 +151,24 @@ interface Namespace {
 	*/
 	PRECISION: typeof PRECISION;
 
+	/**
+	* Mask for the sign bit of a single-precision floating-point number.
+	*
+	* @example
+	* var mask = ns.SIGN_MASK;
+	* // returns 2147483648
+	*/
+	SIGN_MASK: typeof SIGN_MASK;
+
+	/**
+	* Mask for the significand of a single-precision floating-point number.
+	*
+	* @example
+	* var mask = ns.SIGNIFICAND_MASK;
+	* // returns 8388607
+	*/
+	SIGNIFICAND_MASK: typeof SIGNIFICAND_MASK;
+
 	/**
 	* Smallest positive single-precision floating-point normal number.
 	*
diff --git a/lib/node_modules/@stdlib/constants/float64/docs/types/index.d.ts b/lib/node_modules/@stdlib/constants/float64/docs/types/index.d.ts
@@ -34,7 +34,9 @@ import GAMMA_LANCZOS_G = require( '@stdlib/constants/float64/gamma-lanczos-g' );
 import GLAISHER = require( '@stdlib/constants/float64/glaisher-kinkelin' );
 import HALF_LN2 = require( '@stdlib/constants/float64/half-ln-two' );
 import HALF_PI = require( '@stdlib/constants/float64/half-pi' );
+import HIGH_WORD_ABS_MASK = require( '@stdlib/constants/float64/high-word-abs-mask' );
 import HIGH_WORD_EXPONENT_MASK = require( '@stdlib/constants/float64/high-word-exponent-mask' );
+import HIGH_WORD_SIGN_MASK = require( '@stdlib/constants/float64/high-word-sign-mask' );
 import HIGH_WORD_SIGNIFICAND_MASK = require( '@stdlib/constants/float64/high-word-significand-mask' );
 import LN_HALF = require( '@stdlib/constants/float64/ln-half' );
 import LN_PI = require( '@stdlib/constants/float64/ln-pi' );
@@ -201,6 +203,15 @@ interface Namespace {
 	*/
 	HALF_PI: typeof HALF_PI;
 
+	/**
+	* High word mask for excluding the sign bit of a double-precision floating-point number.
+	*
+	* @example
+	* var mask = ns.HIGH_WORD_ABS_MASK;
+	* // returns 2147483647
+	*/
+	HIGH_WORD_ABS_MASK: typeof HIGH_WORD_ABS_MASK;
+
 	/**
 	* High word mask for the exponent of a double-precision floating-point number.
 	*
@@ -210,6 +221,15 @@ interface Namespace {
 	*/
 	HIGH_WORD_EXPONENT_MASK: typeof HIGH_WORD_EXPONENT_MASK;
 
+	/**
+	* High word mask for the sign bit of a double-precision floating-point number.
+	*
+	* @example
+	* var mask = ns.HIGH_WORD_SIGN_MASK;
+	* // returns 2147483648
+	*/
+	HIGH_WORD_SIGN_MASK: typeof HIGH_WORD_SIGN_MASK;
+
 	/**
 	* High word mask for the significand of a double-precision floating-point number.
 	*
diff --git a/lib/node_modules/@stdlib/nlp/docs/types/index.d.ts b/lib/node_modules/@stdlib/nlp/docs/types/index.d.ts
@@ -41,7 +41,7 @@ interface Namespace {
 	* @example
 	* var str = 'LOL, this is fun. I am ROFL.';
 	* var out = ns.expandAcronyms( str );
-	* // returns 'laughing out loud, this is fun. I am rolling on the floor laughing.' 
+	* // returns 'laughing out loud, this is fun. I am rolling on the floor laughing.'
 	*
 	* @example
 	* var str = 'brb, I need to check my mail. thx!';

Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ interface Namespace {`
`41`	`41`	`* @example`
`42`	`42`	`* var str = 'LOL, this is fun. I am ROFL.';`
`43`	`43`	`* var out = ns.expandAcronyms( str );`
`44`		`- * // returns 'laughing out loud, this is fun. I am rolling on the floor laughing.'`
	`44`	`+ * // returns 'laughing out loud, this is fun. I am rolling on the floor laughing.'`
`45`	`45`	`*`
`46`	`46`	`* @example`
`47`	`47`	`* var str = 'brb, I need to check my mail. thx!';`