Skip to content

Commit 0c12692

Browse files
committed
feat: update math/base/special/fast TypeScript declarations
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent eb99018 commit 0c12692

1 file changed

Lines changed: 35 additions & 2 deletions

File tree

  • lib/node_modules/@stdlib/math/base/special/fast/docs/types

lib/node_modules/@stdlib/math/base/special/fast/docs/types/index.d.ts

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
/* eslint-disable max-lines */
2222

2323
import abs = require( '@stdlib/math/base/special/fast/abs' );
24+
import absf = require( '@stdlib/math/base/special/fast/absf' );
2425
import acosh = require( '@stdlib/math/base/special/fast/acosh' );
2526
import ampbm = require( '@stdlib/math/base/special/fast/alpha-max-plus-beta-min' );
2627
import asinh = require( '@stdlib/math/base/special/fast/asinh' );
@@ -68,6 +69,38 @@ interface Namespace {
6869
*/
6970
abs: typeof abs;
7071

72+
/**
73+
* Computes the absolute value of a single-precision floating-point number `x`.
74+
*
75+
* ## Notes
76+
*
77+
* - This implementation is not IEEE 754 compliant. If provided `-0`, the function returns `-0`.
78+
*
79+
* @param x - input value
80+
* @returns absolute value
81+
*
82+
* @example
83+
* var v = ns.absf( -1.0 );
84+
* // returns 1.0
85+
*
86+
* @example
87+
* var v = ns.absf( 2.0 );
88+
* // returns 2.0
89+
*
90+
* @example
91+
* var v = ns.absf( 0.0 );
92+
* // returns 0.0
93+
*
94+
* @example
95+
* var v = ns.absf( -0.0 );
96+
* // returns -0.0
97+
*
98+
* @example
99+
* var v = ns.absf( NaN );
100+
* // returns NaN
101+
*/
102+
absf: typeof absf;
103+
71104
/**
72105
* Computes the hyperbolic arccosine of a number.
73106
*
@@ -104,10 +137,10 @@ interface Namespace {
104137
* // returns ~13.5
105138
*
106139
* @example
107-
* var ampbm = ns.ampbm.factory( 1.0, 0.5 );
140+
* var fcn = ns.ampbm.factory( 1.0, 0.5 );
108141
* // returns <Function>
109142
*
110-
* var h = ampbm( -5.0, 12.0 );
143+
* var h = fcn( -5.0, 12.0 );
111144
* // returns 14.5
112145
*/
113146
ampbm: typeof ampbm;

0 commit comments

Comments
 (0)