From 395f69009a4d8e22dd42b9337953b08054aec5b8 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Tue, 2 Jun 2026 17:54:43 -0500 Subject: [PATCH] docs: fix TSDoc issues across many `@stdlib/math/base/special` declarations Correct documentation-only issues in the TypeScript declaration files flagged by an audit of the `@stdlib/math/base/special` namespace. No emitted types change in a behavior-affecting way; the edits are limited to TSDoc prose, examples, parameter names/descriptions, and internal interface names. Highlights: - `kernel-betainc`: the 4th/5th parameters were named `invert`/ `normalized` with descriptions swapped relative to the implementation `kernelBetainc( x, a, b, regularized, upper )`; rename to `regularized`/`upper` and re-pair the descriptions, fix the garbled "regularized boolean beta function" -> "incomplete beta function" (in the declaration and the `lib/main.js`/`lib/assign.js` JSDoc), and fix the interface doc comment misspelling `kernalBetaInc`. - `gammainc`: split the muddled `regularized`/`upper` Notes into two clear bullets and fix a stale `s <= 0` -> `a <= 0` reference. - `cfloor`: summary now says "Rounds each component of..." like its siblings; `cpolarf`/`sincosd`: fix copy-pasted/lowercase interface names (`Cpolar` -> `Cpolarf`, `sincosd` -> `SinCosd`). - `minmax`/`minmaxn`/`minmaxf`/`sincospi`: `assign` `@example`s now call the `.assign` method instead of the bare function (so `v === out` is actually `true`); correct the `assign` summary/`@returns` for `sincospi`; split merged `@example` blocks. - `minabs`: drop the empty-set Notes paragraph (the function is binary); `minabsn`/`maxabsn`/`minmaxabsn`: correct the empty-args identity Notes (a minimum's bound is the greatest *lower* bound; the absolute maximum's empty result follows from the `-infinity` identity). - `covercos`/`coversin`/`havercos`: add the defining-formula Notes block their forward-trig siblings include. - Assorted prose fixes: `frexp`/`frexpf` "Inteface" typo, `absf`/ `acsch`/`asech`/`negalucasf` summary wording, `floorn` summary ("numeric value", matching `ceiln`/`roundn`/`truncn`), `cotd`/`tand` trailing periods, `cround` unused requires, `gammaincinv` argument-order notation, `lnf`/`round` `@returns`, `truncsd`/ `binomcoef`/`fast/hypot`/`fast/hypotf` `@param` descriptions, `gamma-lanczos-sum-expg-scaled` unbalanced parenthesis, `sind` example spacing, `fast/maxf` stray blank line, and a few missing `@example` tags and interface doc comments. This PR addresses the TypeScript declarations (plus the `kernel-betainc` `lib` JSDoc); the generated namespace aggregator will pick up these fixes on regeneration. Several findings that are errors replicated across a package's other doc surfaces (`cscd`, `nonfibonaccif`, `nonfibonacci`, `powf`) are handled package-wide in a separate PR. --- 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_pkg_readmes status: na - task: lint_markdown_docs status: na - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - 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: passed - task: lint_license_headers status: passed --- --- .../base/special/absf/docs/types/index.d.ts | 2 +- .../base/special/acsch/docs/types/index.d.ts | 2 +- .../base/special/asech/docs/types/index.d.ts | 2 +- .../special/binomcoef/docs/types/index.d.ts | 2 +- .../base/special/cfloor/docs/types/index.d.ts | 2 +- .../base/special/cotd/docs/types/index.d.ts | 2 +- .../special/covercos/docs/types/index.d.ts | 4 ++++ .../special/coversin/docs/types/index.d.ts | 4 ++++ .../special/cpolarf/docs/types/index.d.ts | 4 ++-- .../base/special/cround/docs/types/index.d.ts | 2 -- .../special/fast/hypot/docs/types/index.d.ts | 4 ++-- .../special/fast/hypotf/docs/types/index.d.ts | 4 ++-- .../special/fast/maxf/docs/types/index.d.ts | 1 - .../base/special/floorn/docs/types/index.d.ts | 2 +- .../base/special/frexp/docs/types/index.d.ts | 2 +- .../base/special/frexpf/docs/types/index.d.ts | 2 +- .../docs/types/index.d.ts | 2 +- .../special/gammainc/docs/types/index.d.ts | 5 +++-- .../special/gammaincinv/docs/types/index.d.ts | 2 +- .../special/havercos/docs/types/index.d.ts | 4 ++++ .../kernel-betainc/docs/types/index.d.ts | 18 +++++++++--------- .../base/special/kernel-betainc/lib/assign.js | 2 +- .../base/special/kernel-betainc/lib/main.js | 2 +- .../base/special/lnf/docs/types/index.d.ts | 2 +- .../special/maxabsn/docs/types/index.d.ts | 2 +- .../base/special/minabs/docs/types/index.d.ts | 4 ---- .../special/minabsn/docs/types/index.d.ts | 2 +- .../base/special/minmax/docs/types/index.d.ts | 4 +++- .../special/minmaxabsn/docs/types/index.d.ts | 5 ++++- .../special/minmaxf/docs/types/index.d.ts | 4 ++-- .../special/minmaxn/docs/types/index.d.ts | 19 +++++++++++-------- .../special/negalucasf/docs/types/index.d.ts | 2 +- .../base/special/round/docs/types/index.d.ts | 2 +- .../special/sincosd/docs/types/index.d.ts | 6 +++--- .../special/sincospi/docs/types/index.d.ts | 6 +++--- .../base/special/sind/docs/types/index.d.ts | 2 +- .../base/special/tand/docs/types/index.d.ts | 2 +- .../special/truncsd/docs/types/index.d.ts | 2 +- 38 files changed, 77 insertions(+), 63 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/absf/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/absf/docs/types/index.d.ts index 42407a34cf66..c1b125087dc9 100644 --- a/lib/node_modules/@stdlib/math/base/special/absf/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/absf/docs/types/index.d.ts @@ -19,7 +19,7 @@ // TypeScript Version: 4.1 /** -* Computes the absolute value of single-precision floating-point number `x`. +* Computes the absolute value of a single-precision floating-point number `x`. * * @param x - input value * @returns absolute value diff --git a/lib/node_modules/@stdlib/math/base/special/acsch/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/acsch/docs/types/index.d.ts index 0562aff5095c..15f658789e03 100644 --- a/lib/node_modules/@stdlib/math/base/special/acsch/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/acsch/docs/types/index.d.ts @@ -19,7 +19,7 @@ // TypeScript Version: 4.1 /** -* Computes the hyperbolic arccosecant of a number. +* Computes the hyperbolic arccosecant of a double-precision floating-point number. * * @param x - input value * @returns hyperbolic arccosecant diff --git a/lib/node_modules/@stdlib/math/base/special/asech/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/asech/docs/types/index.d.ts index 5610a934f6e7..bee0403833c3 100644 --- a/lib/node_modules/@stdlib/math/base/special/asech/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/asech/docs/types/index.d.ts @@ -19,7 +19,7 @@ // TypeScript Version: 4.1 /** -* Computes the hyperbolic arcsecant of a number. +* Computes the hyperbolic arcsecant of a double-precision floating-point number. * * @param x - input value * @returns hyperbolic arcsecant diff --git a/lib/node_modules/@stdlib/math/base/special/binomcoef/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/binomcoef/docs/types/index.d.ts index 99998f8a8290..9ffcb8a65a63 100644 --- a/lib/node_modules/@stdlib/math/base/special/binomcoef/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/binomcoef/docs/types/index.d.ts @@ -21,7 +21,7 @@ /** * Computes the binomial coefficient of two integers. * -* @param n - input value +* @param n - first input value * @param k - second input value * @returns function value * diff --git a/lib/node_modules/@stdlib/math/base/special/cfloor/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/cfloor/docs/types/index.d.ts index f1ba06b80bac..f1a2a36bbec1 100644 --- a/lib/node_modules/@stdlib/math/base/special/cfloor/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/cfloor/docs/types/index.d.ts @@ -23,7 +23,7 @@ import { Complex128 } from '@stdlib/types/complex'; /** -* Rounds a double-precision complex floating-point number toward negative infinity. +* Rounds each component of a double-precision complex floating-point number toward negative infinity. * * @param z - input value * @returns result diff --git a/lib/node_modules/@stdlib/math/base/special/cotd/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/cotd/docs/types/index.d.ts index ebc80c6471b5..d127a75d1289 100644 --- a/lib/node_modules/@stdlib/math/base/special/cotd/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/cotd/docs/types/index.d.ts @@ -19,7 +19,7 @@ // TypeScript Version: 4.1 /** -* Computes the cotangent of an angle measured in degrees +* Computes the cotangent of an angle measured in degrees. * * @param x - input value (in degrees) * @returns cotangent diff --git a/lib/node_modules/@stdlib/math/base/special/covercos/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/covercos/docs/types/index.d.ts index 8820c0fd2cdf..e722e32668c7 100644 --- a/lib/node_modules/@stdlib/math/base/special/covercos/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/covercos/docs/types/index.d.ts @@ -21,6 +21,10 @@ /** * Computes the coversed cosine. * +* ## Notes +* +* - The coversed cosine is defined as `1 + sin(x)`. +* * @param x - input value (in radians) * @returns coversed cosine * diff --git a/lib/node_modules/@stdlib/math/base/special/coversin/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/coversin/docs/types/index.d.ts index e98f2dfd8739..d8d605b4400c 100644 --- a/lib/node_modules/@stdlib/math/base/special/coversin/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/coversin/docs/types/index.d.ts @@ -21,6 +21,10 @@ /** * Computes the coversed sine. * +* ## Notes +* +* - The coversed sine is defined as `1 - sin(x)`. +* * @param x - input value (in radians) * @returns coversed sine * diff --git a/lib/node_modules/@stdlib/math/base/special/cpolarf/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/cpolarf/docs/types/index.d.ts index 591fbb87d157..f1ad592ab7e3 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolarf/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/cpolarf/docs/types/index.d.ts @@ -26,7 +26,7 @@ import { Collection } from '@stdlib/types/array'; /** * Interface describing `cpolarf`. */ -interface Cpolar { +interface Cpolarf { /** * Computes the absolute value and the phase of a single-precision complex floating-point number. * @@ -77,7 +77,7 @@ interface Cpolar { * var v = cpolarf( new Complex64( 5.0, 3.0 ) ); * // returns [ ~5.83, ~0.5404 ] */ -declare var cpolarf: Cpolar; +declare var cpolarf: Cpolarf; // EXPORTS // diff --git a/lib/node_modules/@stdlib/math/base/special/cround/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/cround/docs/types/index.d.ts index 5aa41d145a06..ea8a1d9ee679 100644 --- a/lib/node_modules/@stdlib/math/base/special/cround/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/cround/docs/types/index.d.ts @@ -30,8 +30,6 @@ import { Complex128 } from '@stdlib/types/complex'; * * @example * var Complex128 = require( '@stdlib/complex/float64/ctor' ); -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * * var v = cround( new Complex128( -4.2, 5.5 ) ); * // returns [ -4.0, 6.0 ] diff --git a/lib/node_modules/@stdlib/math/base/special/fast/hypot/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/fast/hypot/docs/types/index.d.ts index d664bf072911..08ea9745fd33 100644 --- a/lib/node_modules/@stdlib/math/base/special/fast/hypot/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/fast/hypot/docs/types/index.d.ts @@ -21,8 +21,8 @@ /** * Computes the hypotenuse. * -* @param x - number -* @param y - number +* @param x - first number +* @param y - second number * @returns hypotenuse * * @example diff --git a/lib/node_modules/@stdlib/math/base/special/fast/hypotf/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/fast/hypotf/docs/types/index.d.ts index 369e2db344aa..188c242ead4f 100644 --- a/lib/node_modules/@stdlib/math/base/special/fast/hypotf/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/fast/hypotf/docs/types/index.d.ts @@ -21,8 +21,8 @@ /** * Computes the hypotenuse of two single-precision floating-point numbers. * -* @param x - number -* @param y - number +* @param x - first number +* @param y - second number * @returns hypotenuse * * @example diff --git a/lib/node_modules/@stdlib/math/base/special/fast/maxf/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/fast/maxf/docs/types/index.d.ts index 64b7329c1b01..b1c20a2bec81 100644 --- a/lib/node_modules/@stdlib/math/base/special/fast/maxf/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/fast/maxf/docs/types/index.d.ts @@ -49,7 +49,6 @@ * var v = maxf( +0.0, -0.0 ); * // returns -0.0 */ - declare function maxf( x: number, y: number ): number; diff --git a/lib/node_modules/@stdlib/math/base/special/floorn/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/floorn/docs/types/index.d.ts index 665889ff8000..7df28828b998 100644 --- a/lib/node_modules/@stdlib/math/base/special/floorn/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/floorn/docs/types/index.d.ts @@ -19,7 +19,7 @@ // TypeScript Version: 4.1 /** -* Rounds a double-precision floating-point number to the nearest multiple of `10^n` toward negative infinity. +* Rounds a numeric value to the nearest multiple of `10^n` toward negative infinity. * * ## Notes * diff --git a/lib/node_modules/@stdlib/math/base/special/frexp/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/frexp/docs/types/index.d.ts index 888a599f0305..24a18e18c430 100644 --- a/lib/node_modules/@stdlib/math/base/special/frexp/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/frexp/docs/types/index.d.ts @@ -23,7 +23,7 @@ import { Collection } from '@stdlib/types/array'; /** -* Inteface describing `frexp`. +* Interface describing `frexp`. */ interface Frexp { /** diff --git a/lib/node_modules/@stdlib/math/base/special/frexpf/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/frexpf/docs/types/index.d.ts index e93d01c80a25..338ae23912f0 100644 --- a/lib/node_modules/@stdlib/math/base/special/frexpf/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/frexpf/docs/types/index.d.ts @@ -23,7 +23,7 @@ import { Collection } from '@stdlib/types/array'; /** -* Inteface describing `frexpf`. +* Interface describing `frexpf`. */ interface Frexpf { /** diff --git a/lib/node_modules/@stdlib/math/base/special/gamma-lanczos-sum-expg-scaled/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/gamma-lanczos-sum-expg-scaled/docs/types/index.d.ts index f80b702b4154..e03fc560ea7f 100644 --- a/lib/node_modules/@stdlib/math/base/special/gamma-lanczos-sum-expg-scaled/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/gamma-lanczos-sum-expg-scaled/docs/types/index.d.ts @@ -19,7 +19,7 @@ // TypeScript Version: 4.1 /** -* Calculates the Lanczos sum for the approximation of the gamma function (scaled by `exp(-g)`, where `g = 10.900511`. +* Calculates the Lanczos sum for the approximation of the gamma function (scaled by `exp(-g)`, where `g = 10.900511`). * * @param x - input value * @returns Lanczos sum approximation diff --git a/lib/node_modules/@stdlib/math/base/special/gammainc/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/gammainc/docs/types/index.d.ts index 698d225e7d5d..56e583ad39a7 100644 --- a/lib/node_modules/@stdlib/math/base/special/gammainc/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/gammainc/docs/types/index.d.ts @@ -23,8 +23,9 @@ * * ## Notes * -* - The `regularized` and `upper` parameters specify whether to evaluate the non-regularized and/or upper incomplete gamma functions, respectively. -* - If provided `x < 0` or `s <= 0`, the function returns `NaN`. +* - The `regularized` parameter specifies whether to evaluate the regularized (default) or non-regularized incomplete gamma function. +* - The `upper` parameter specifies whether to evaluate the lower (default) or upper incomplete gamma function. +* - If provided `x < 0` or `a <= 0`, the function returns `NaN`. * * @param x - function parameter * @param a - function parameter diff --git a/lib/node_modules/@stdlib/math/base/special/gammaincinv/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/gammaincinv/docs/types/index.d.ts index 5c1b9459482d..11e30bbe7b1b 100644 --- a/lib/node_modules/@stdlib/math/base/special/gammaincinv/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/gammaincinv/docs/types/index.d.ts @@ -24,7 +24,7 @@ * ## Notes * * - In contrast to a more commonly used definition, the first argument is the probability `p` and the second argument is the scale factor `a`. -* - By default, the function inverts the lower regularized incomplete gamma function, `P(x,a)`. To invert the upper function `Q(x,a)`, set the `upper` argument to `true`. +* - By default, the function inverts the lower regularized incomplete gamma function, `P(a,x)`. To invert the upper function `Q(a,x)`, set the `upper` argument to `true`. * - If provided `p < 0` or `p > 1`, the function returns `NaN`. * * @param p - probability value diff --git a/lib/node_modules/@stdlib/math/base/special/havercos/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/havercos/docs/types/index.d.ts index 94e2e1975d15..3629a15457f0 100644 --- a/lib/node_modules/@stdlib/math/base/special/havercos/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/havercos/docs/types/index.d.ts @@ -21,6 +21,10 @@ /** * Computes the half-value versed cosine. * +* ## Notes +* +* - The half-value versed cosine is defined as `(1 + cos(x)) / 2`. +* * @param x - input value (in radians) * @returns half-value versed cosine * diff --git a/lib/node_modules/@stdlib/math/base/special/kernel-betainc/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/kernel-betainc/docs/types/index.d.ts index a7f617ff9d6e..a9a9a40e65a4 100644 --- a/lib/node_modules/@stdlib/math/base/special/kernel-betainc/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/kernel-betainc/docs/types/index.d.ts @@ -23,7 +23,7 @@ import { Collection } from '@stdlib/types/array'; /** -* Interface describing `kernalBetaInc`. +* Interface describing `kernelBetainc`. */ interface Routine { /** @@ -38,8 +38,8 @@ interface Routine { * @param x - function input * @param a - function parameter * @param b - function parameter - * @param invert - boolean indicating if the function should return the upper tail of the incomplete beta function instead - * @param normalized - boolean indicating if the function should evaluate the regularized boolean beta function + * @param regularized - boolean indicating if the function should evaluate the regularized incomplete beta function + * @param upper - boolean indicating if the function should return the upper tail of the incomplete beta function instead * @returns function value and first derivative * * @example @@ -50,7 +50,7 @@ interface Routine { * var out = kernelBetainc( 0.2, 1.0, 2.0, true, false ); * // returns [ 0.36, 1.6 ] */ - ( x: number, a: number, b: number, invert: boolean, normalized: boolean ): Array; + ( x: number, a: number, b: number, regularized: boolean, upper: boolean ): Array; /** * Evaluates the incomplete beta function and its first derivative and assigns results to a provided output array. @@ -64,8 +64,8 @@ interface Routine { * @param x - function input * @param a - function parameter * @param b - function parameter - * @param invert - boolean indicating if the function should return the upper tail of the incomplete beta function instead - * @param normalized - boolean indicating if the function should evaluate the regularized boolean beta function + * @param regularized - boolean indicating if the function should evaluate the regularized incomplete beta function + * @param upper - boolean indicating if the function should return the upper tail of the incomplete beta function instead * @param out - output array * @param stride - output array stride * @param offset - output array index offset @@ -79,7 +79,7 @@ interface Routine { * var bool = ( arr === out ); * // returns true */ - assign( x: number, a: number, b: number, invert: boolean, normalized: boolean, out: Collection, stride: number, offset: number ): Collection; + assign( x: number, a: number, b: number, regularized: boolean, upper: boolean, out: Collection, stride: number, offset: number ): Collection; } /** @@ -94,8 +94,8 @@ interface Routine { * @param x - function input * @param a - function parameter * @param b - function parameter -* @param invert - boolean indicating if the function should return the upper tail of the incomplete beta function instead -* @param normalized - boolean indicating if the function should evaluate the regularized boolean beta function +* @param regularized - boolean indicating if the function should evaluate the regularized incomplete beta function +* @param upper - boolean indicating if the function should return the upper tail of the incomplete beta function instead * @returns function value and first derivative * * @example diff --git a/lib/node_modules/@stdlib/math/base/special/kernel-betainc/lib/assign.js b/lib/node_modules/@stdlib/math/base/special/kernel-betainc/lib/assign.js index 3868b6bd3f8c..bb3ea61c33ef 100644 --- a/lib/node_modules/@stdlib/math/base/special/kernel-betainc/lib/assign.js +++ b/lib/node_modules/@stdlib/math/base/special/kernel-betainc/lib/assign.js @@ -78,7 +78,7 @@ var ONE_OVER_PI = 1.0 / PI; * @param {Probability} x - function input * @param {NonNegativeNumber} a - function parameter * @param {NonNegativeNumber} b - function parameter -* @param {boolean} regularized - boolean indicating if the function should evaluate the regularized boolean beta function +* @param {boolean} regularized - boolean indicating if the function should evaluate the regularized incomplete beta function * @param {boolean} upper - boolean indicating if the function should return the upper tail of the incomplete beta function instead * @param {(Array|TypedArray|Object)} out - output array * @param {integer} stride - output array stride diff --git a/lib/node_modules/@stdlib/math/base/special/kernel-betainc/lib/main.js b/lib/node_modules/@stdlib/math/base/special/kernel-betainc/lib/main.js index 516d883054f0..faa6485a6956 100644 --- a/lib/node_modules/@stdlib/math/base/special/kernel-betainc/lib/main.js +++ b/lib/node_modules/@stdlib/math/base/special/kernel-betainc/lib/main.js @@ -31,7 +31,7 @@ var compute = require( './assign.js' ); * @param {Probability} x - function input * @param {NonNegativeNumber} a - function parameter * @param {NonNegativeNumber} b - function parameter -* @param {boolean} regularized - boolean indicating if the function should evaluate the regularized boolean beta function +* @param {boolean} regularized - boolean indicating if the function should evaluate the regularized incomplete beta function * @param {boolean} upper - boolean indicating if the function should return the upper tail of the incomplete beta function instead * @returns {Array} function value and first derivative * diff --git a/lib/node_modules/@stdlib/math/base/special/lnf/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/lnf/docs/types/index.d.ts index 11651f15b8b1..01858e7c57a6 100644 --- a/lib/node_modules/@stdlib/math/base/special/lnf/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/lnf/docs/types/index.d.ts @@ -22,7 +22,7 @@ * Evaluates the natural logarithm of a single-precision floating-point number. * * @param x - input value -* @returns function value +* @returns natural logarithm * * @example * var v = lnf( 4.0 ); diff --git a/lib/node_modules/@stdlib/math/base/special/maxabsn/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/maxabsn/docs/types/index.d.ts index 9b8d1d3c679f..5b603207ead3 100644 --- a/lib/node_modules/@stdlib/math/base/special/maxabsn/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/maxabsn/docs/types/index.d.ts @@ -23,7 +23,7 @@ * * ## Notes * -* - When an empty set is considered a subset of the extended reals (all real numbers, including positive and negative infinity), negative infinity is the least upper bound. Similar to zero being the identity element for the sum of an empty set and to one being the identity element for the product of an empty set, negative infinity is the identity element for the maximum, and thus, if not provided any arguments, the function returns `+infinity` (i.e., the absolute value of `-infinity`). +* - When an empty set is considered a subset of the extended reals (all real numbers, including positive and negative infinity), negative infinity is the identity element for the maximum. Because the absolute value of negative infinity is positive infinity, if not provided any arguments, the function returns `+infinity`. * * @param x - first number * @param y - second number diff --git a/lib/node_modules/@stdlib/math/base/special/minabs/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/minabs/docs/types/index.d.ts index 691683228208..4ef4ebd27ecf 100644 --- a/lib/node_modules/@stdlib/math/base/special/minabs/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/minabs/docs/types/index.d.ts @@ -21,10 +21,6 @@ /** * Returns the minimum absolute value. * -* ## Notes -* -* - When an empty set is considered a subset of the extended reals (all real numbers, including positive and negative infinity), positive infinity is the greatest upper bound. Similar to zero being the identity element for the sum of an empty set and to one being the identity element for the product of an empty set, positive infinity is the identity element for the minimum, and thus, if not provided any arguments, the function returns positive infinity. -* * @param x - first number * @param y - second number * @returns minimum absolute value diff --git a/lib/node_modules/@stdlib/math/base/special/minabsn/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/minabsn/docs/types/index.d.ts index 41a46358b744..2b4524fc57ab 100644 --- a/lib/node_modules/@stdlib/math/base/special/minabsn/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/minabsn/docs/types/index.d.ts @@ -23,7 +23,7 @@ * * ## Notes * -* - When an empty set is considered a subset of the extended reals (all real numbers, including positive and negative infinity), positive infinity is the greatest upper bound. Similar to zero being the identity element for the sum of an empty set and to one being the identity element for the product of an empty set, positive infinity is the identity element for the minimum, and thus, if not provided any arguments, the function returns positive infinity. +* - When an empty set is considered a subset of the extended reals (all real numbers, including positive and negative infinity), positive infinity is the greatest lower bound. Similar to zero being the identity element for the sum of an empty set and to one being the identity element for the product of an empty set, positive infinity is the identity element for the minimum, and thus, if not provided any arguments, the function returns positive infinity. * * @param x - first number * @param y - second number diff --git a/lib/node_modules/@stdlib/math/base/special/minmax/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/minmax/docs/types/index.d.ts index 70ba76e83f87..f747c2a8d35f 100644 --- a/lib/node_modules/@stdlib/math/base/special/minmax/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/minmax/docs/types/index.d.ts @@ -37,6 +37,7 @@ interface MinMax { * var v = minmax( 3.14, 4.2 ); * // returns [ 3.14, 4.2 ] * + * @example * var v = minmax( 3.14, NaN ); * // returns [ NaN, NaN ] * @@ -58,7 +59,7 @@ interface MinMax { * * @example * var out = [ 0.0, 0.0 ]; - * var v = minmax( 5.9, 3.14, out, 1, 0 ); + * var v = minmax.assign( 5.9, 3.14, out, 1, 0 ); * // returns [ 3.14, 5.9 ] * * var bool = ( v === out ); @@ -78,6 +79,7 @@ interface MinMax { * var v = minmax( 3.14, 4.2 ); * // returns [ 3.14, 4.2 ] * +* @example * var v = minmax( 3.14, NaN ); * // returns [ NaN, NaN ] * diff --git a/lib/node_modules/@stdlib/math/base/special/minmaxabsn/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/minmaxabsn/docs/types/index.d.ts index 94e4f0ea0696..7a5642c730c9 100644 --- a/lib/node_modules/@stdlib/math/base/special/minmaxabsn/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/minmaxabsn/docs/types/index.d.ts @@ -22,13 +22,16 @@ import { Collection } from '@stdlib/types/array'; +/** +* Interface describing an interface for computing minimum and maximum absolute values. +*/ interface MinMaxAbsN { /** * Returns the minimum and maximum absolute values. * * ## Notes * - * - When an empty set is considered a subset of the extended reals (all real numbers, including positive and negative infinity), positive infinity is the greatest lower bound and negative infinity is the least upper bound. Similar to zero being the identity element for the sum of an empty set and to one being the identity element for the product of an empty set, positive infinity is the identity element for the minimum and negative infinity is the identity element for the maximum, and thus, if not provided any arguments, the function returns positive infinity for both the minimum and maximum absolute values. + * - When an empty set is considered a subset of the extended reals (all real numbers, including positive and negative infinity), positive infinity is the greatest lower bound and negative infinity is the least upper bound. Similar to zero being the identity element for the sum of an empty set and to one being the identity element for the product of an empty set, positive infinity is the identity element for the minimum and negative infinity is the identity element for the maximum; because both the minimum (+infinity) and the maximum (-infinity) have an absolute value of positive infinity, if not provided any arguments, the function returns positive infinity for both the minimum and maximum absolute values. * * @returns minimum and maximum absolute values * diff --git a/lib/node_modules/@stdlib/math/base/special/minmaxf/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/minmaxf/docs/types/index.d.ts index 27f9a7699d97..892baa769b32 100644 --- a/lib/node_modules/@stdlib/math/base/special/minmaxf/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/minmaxf/docs/types/index.d.ts @@ -23,7 +23,7 @@ import { Collection } from '@stdlib/types/array'; /** -* Interface describing an interface for computing minimum and maximum of two single-precision floating-point numbers. +* Interface describing a function for computing the minimum and maximum of two single-precision floating-point numbers. */ interface MinMaxf { /** @@ -58,7 +58,7 @@ interface MinMaxf { * * @example * var out = [ 0.0, 0.0 ]; - * var v = minmaxf( 5.9, 3.14, out, 1, 0 ); + * var v = minmaxf.assign( 5.9, 3.14, out, 1, 0 ); * // returns [ 3.14, 5.9 ] * * var bool = ( v === out ); diff --git a/lib/node_modules/@stdlib/math/base/special/minmaxn/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/minmaxn/docs/types/index.d.ts index 8606a026d902..cc8c331fb45d 100644 --- a/lib/node_modules/@stdlib/math/base/special/minmaxn/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/minmaxn/docs/types/index.d.ts @@ -23,7 +23,7 @@ import { Collection } from '@stdlib/types/array'; /** -* Interface describing an interface for computing minimum and maximum values. +* Interface describing a function for computing the minimum and maximum values. */ interface MinMaxN { /** @@ -52,6 +52,7 @@ interface MinMaxN { * // returns [ 3.14, 3.14 ] */ ( x: number ): Array; // eslint-disable-line @typescript-eslint/unified-signatures + /** * Returns the minimum and maximum values. * @@ -63,6 +64,7 @@ interface MinMaxN { * var v = minmaxn( 3.14, 4.2 ); * // returns [ 3.14, 4.2 ] * + * @example * var v = minmaxn( 3.14, NaN ); * // returns [ NaN, NaN ] * @@ -129,6 +131,7 @@ interface MinMaxN { * var v = minmaxn( 3.14, 4.2 ); * // returns [ 3.14, 4.2 ] * + * @example * var v = minmaxn( 3.14, NaN ); * // returns [ NaN, NaN ] * @@ -148,7 +151,7 @@ interface MinMaxN { * * @example * var out = [ 0.0, 0.0 ]; - * var v = minmaxn( out, 1, 0 ); + * var v = minmaxn.assign( out, 1, 0 ); * // returns [ Infinity, -Infinity ] * * var bool = ( v === out ); @@ -167,7 +170,7 @@ interface MinMaxN { * * @example * var out = [ 0.0, 0.0 ]; - * var v = minmaxn( 5.9, out, 1, 0 ); + * var v = minmaxn.assign( 5.9, out, 1, 0 ); * // returns [ 5.9, 5.9 ] * * var bool = ( v === out ); @@ -187,7 +190,7 @@ interface MinMaxN { * * @example * var out = [ 0.0, 0.0 ]; - * var v = minmaxn( 5.9, 3.14, out, 1, 0 ); + * var v = minmaxn.assign( 5.9, 3.14, out, 1, 0 ); * // returns [ 3.14, 5.9 ] * * var bool = ( v === out ); @@ -208,7 +211,7 @@ interface MinMaxN { * * @example * var out = [ 0.0, 0.0 ]; - * var v = minmaxn( 5.9, 3.14, 4.2, out, 1, 0 ); + * var v = minmaxn.assign( 5.9, 3.14, 4.2, out, 1, 0 ); * // returns [ 3.14, 5.9 ] * * var bool = ( v === out ); @@ -230,7 +233,7 @@ interface MinMaxN { * * @example * var out = [ 0.0, 0.0 ]; - * var v = minmaxn( 5.9, 3.14, 4.2, 3.9, out, 1, 0 ); + * var v = minmaxn.assign( 5.9, 3.14, 4.2, 3.9, out, 1, 0 ); * // returns [ 3.14, 5.9 ] * * var bool = ( v === out ); @@ -253,7 +256,7 @@ interface MinMaxN { * * @example * var out = [ 0.0, 0.0 ]; - * var v = minmaxn( 5.9, 3.14, 4.2, 3.9, 3.8, out, 1, 0 ); + * var v = minmaxn.assign( 5.9, 3.14, 4.2, 3.9, 3.8, out, 1, 0 ); * // returns [ 3.14, 5.9 ] * * var bool = ( v === out ); @@ -274,7 +277,7 @@ interface MinMaxN { * * @example * var out = [ 0.0, 0.0 ]; - * var v = minmaxn( 5.9, 3.14, 4.2, 3.9, 3.8, 3.7, out, 1, 0 ); + * var v = minmaxn.assign( 5.9, 3.14, 4.2, 3.9, 3.8, 3.7, out, 1, 0 ); * // returns [ 3.14, 5.9 ] * * var bool = ( v === out ); diff --git a/lib/node_modules/@stdlib/math/base/special/negalucasf/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/negalucasf/docs/types/index.d.ts index b6328720137f..77caf478066f 100644 --- a/lib/node_modules/@stdlib/math/base/special/negalucasf/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/negalucasf/docs/types/index.d.ts @@ -19,7 +19,7 @@ // TypeScript Version: 4.1 /** -* Computes the nth negaLucas number in single-precision floating-point format. +* Computes the nth negaLucas number as a single-precision floating-point number. * * ## Notes * diff --git a/lib/node_modules/@stdlib/math/base/special/round/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/round/docs/types/index.d.ts index 3e186b71107a..c7694f9414e9 100644 --- a/lib/node_modules/@stdlib/math/base/special/round/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/round/docs/types/index.d.ts @@ -26,7 +26,7 @@ * - Ties are rounded toward positive infinity. * * @param x - input value -* @returns function value +* @returns rounded value * * @example * var v = round( -4.2 ); diff --git a/lib/node_modules/@stdlib/math/base/special/sincosd/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/sincosd/docs/types/index.d.ts index 1fa18669cab2..c4f54b90029a 100644 --- a/lib/node_modules/@stdlib/math/base/special/sincosd/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/sincosd/docs/types/index.d.ts @@ -22,7 +22,7 @@ import { NumericArray } from '@stdlib/types/array'; -interface sincosd { +interface SinCosd { /** * Simultaneously computes the sine and cosine of an angle measured in degrees. * @@ -67,7 +67,7 @@ interface sincosd { * var bool = ( v === out ); * // returns true */ - assign( x: number, out: T, stride: number, offset: number ): T ; + assign( x: number, out: T, stride: number, offset: number ): T; } /** @@ -92,7 +92,7 @@ interface sincosd { * var v = sincosd( NaN ); * // returns [ NaN, NaN ] */ -declare var sincosd: sincosd; +declare var sincosd: SinCosd; // EXPORTS // diff --git a/lib/node_modules/@stdlib/math/base/special/sincospi/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/sincospi/docs/types/index.d.ts index b19d77758953..b02dfddffa8f 100644 --- a/lib/node_modules/@stdlib/math/base/special/sincospi/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/sincospi/docs/types/index.d.ts @@ -51,20 +51,20 @@ interface SinCosPi { ( x: number ): Array; /** - * Simultaneously computes the sine and cosine of a number times π. + * Simultaneously computes the sine and cosine of a number times π and assigns the results to a provided output array. * * @param x - input value * @param out - output array * @param stride - output array stride * @param offset - output array index offset - * @returns two-element array containing sin(πx) and cos(πx) + * @returns output array * * @example * var Float64Array = require( '@stdlib/array/float64' ); * * var out = new Float64Array( 2 ); * - * var v = sincospi( 0.0, out, 1, 0 ); + * var v = sincospi.assign( 0.0, out, 1, 0 ); * // returns [ 0.0, 1.0 ] * * var bool = ( v === out ); diff --git a/lib/node_modules/@stdlib/math/base/special/sind/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/sind/docs/types/index.d.ts index cd81932bc6b5..9dc53d06408b 100644 --- a/lib/node_modules/@stdlib/math/base/special/sind/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/sind/docs/types/index.d.ts @@ -33,7 +33,7 @@ * // returns ~0.5 * * @example -* var v = sind( 90.0); +* var v = sind( 90.0 ); * // returns 1.0 * * @example diff --git a/lib/node_modules/@stdlib/math/base/special/tand/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/tand/docs/types/index.d.ts index a4061039c8f2..db2f4a703ce6 100644 --- a/lib/node_modules/@stdlib/math/base/special/tand/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/tand/docs/types/index.d.ts @@ -19,7 +19,7 @@ // TypeScript Version: 4.1 /** -* Computes the tangent of an angle measured in degrees +* Computes the tangent of an angle measured in degrees. * * @param x - input value (in degrees) * @returns tangent diff --git a/lib/node_modules/@stdlib/math/base/special/truncsd/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/truncsd/docs/types/index.d.ts index 5385b26d4655..a2865494da9c 100644 --- a/lib/node_modules/@stdlib/math/base/special/truncsd/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/truncsd/docs/types/index.d.ts @@ -23,7 +23,7 @@ * * @param x - input value * @param n - number of significant figures -* @param b - integer base +* @param b - base * @returns rounded value * * @example