Skip to content

Commit 4b6db32

Browse files
committed
docs: update typescript docs for math/base/special/airy
--- 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 ab481ef commit 4b6db32

File tree

1 file changed

+11
-25
lines changed
  • lib/node_modules/@stdlib/math/base/special/airy/docs/types

1 file changed

+11
-25
lines changed

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

Lines changed: 11 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -19,40 +19,26 @@
1919
// TypeScript Version: 4.1
2020

2121
/**
22-
* Computes the Jacobi elliptic functions sn, cn, and dn.
22+
* Computes Airy functions of the first and second kind, Ai(x) and Bi(x), and their first derivatives, Ai'(x) and Bi'(x).
2323
*
24-
* ## Notes
24+
* @param x - input value
25+
* @returns Ai(x), Ai'(x), Bi(x), and Bi'(x)
2526
*
26-
* - The functions are evaluated using the [complete elliptic integral of the first kind](https://en.wikipedia.org/wiki/Elliptic_integral#Complete_elliptic_integral_of_the_first_kind) `K`.
27-
*
28-
* - The `x` argument is converted to double-precision floating-point format.
29-
*
30-
* - The returned values are exact for `m` values where `|m| < 2**-24`.
31-
*
32-
* - The functions return `NaN` for `m >= 1`.
33-
*
34-
* - When `m < 1`, the following relations hold
35-
*
36-
* ```tex
37-
* \operatorname{sn}(x+x) = 2\operatorname{sn}(x)\operatorname{cn}(x)
38-
* \operatorname{cn}(x+x) = 1 - 2\operatorname{sn}(x)^{2}
39-
* \operatorname{dn}(x+x) = 1 - 2\operatorname{sn}(x)^{2}\operatorname{dn}(x)
40-
* ```
41-
*
42-
* @param x - argument
43-
* @returns array containing four elements corresponding to the Jacobi elliptic functions and the Jacobi amplitude `am`.
27+
* @example
28+
* var v = airy( 0.0 );
29+
* // returns [ ~0.355, ~-0.259, ~0.615, ~0.448 ]
4430
*
4531
* @example
46-
* var v = airy( 0.5 );
47-
* // returns [ ~0.479, ~0.878, 1 ]
32+
* var v = airy( 1.0 );
33+
* // returns [ ~0.135, ~-0.159, ~1.207, ~0.932 ]
4834
*
4935
* @example
50-
* var v = airy( 0.5 );
51-
* // returns [ ~0.497, ~0.868, ~1.117 ]
36+
* var v = airy( -1.0 );
37+
* // returns [ ~0.536, ~-0.01, ~0.104, ~0.592 ]
5238
*
5339
* @example
5440
* var v = airy( Infinity );
55-
* // returns [ NaN, NaN, NaN, NaN ]
41+
* // returns [ 0, 0, Infinity, Infinity ]
5642
*
5743
* @example
5844
* var v = airy( -Infinity );

0 commit comments

Comments
 (0)