Skip to content

Commit 22a3dcf

Browse files
stdlib-botPlaneshifter
stdlib-bot
and
Planeshifter
authored
docs: update namespace TypeScript declaration comments
PR-URL: #4794 Co-authored-by: Philipp Burckhardt <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]> Signed-off-by: stdlib-bot <[email protected]>
1 parent 05f1fc1 commit 22a3dcf

File tree

4 files changed

+58
-20
lines changed

4 files changed

+58
-20
lines changed

‎lib/node_modules/@stdlib/blas/ext/base/docs/types/index.d.ts

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2334,12 +2334,12 @@ interface Namespace {
23342334
sapxsumkbn: typeof sapxsumkbn;
23352335

23362336
/**
2337-
* Adds a constant to each single-precision floating-point strided array element and computes the sum using a second-order iterative Kahan–Babuška algorithm.
2337+
* Adds a scalar constant to each single-precision floating-point strided array element and computes the sum using a second-order iterative Kahan–Babuška algorithm.
23382338
*
23392339
* @param N - number of indexed elements
2340-
* @param alpha - constant
2340+
* @param alpha - scalar constant
23412341
* @param x - input array
2342-
* @param stride - stride length
2342+
* @param strideX - stride length
23432343
* @returns sum
23442344
*
23452345
* @example
@@ -2388,12 +2388,12 @@ interface Namespace {
23882388
sapxsumors: typeof sapxsumors;
23892389

23902390
/**
2391-
* Adds a constant to each single-precision floating-point strided array element and computes the sum using pairwise summation.
2391+
* Adds a scalar constant to each single-precision floating-point strided array element and computes the sum using pairwise summation.
23922392
*
23932393
* @param N - number of indexed elements
2394-
* @param alpha - constant
2394+
* @param alpha - scalar constant
23952395
* @param x - input array
2396-
* @param stride - stride length
2396+
* @param strideX - stride length
23972397
* @returns sum
23982398
*
23992399
* @example
@@ -2419,7 +2419,7 @@ interface Namespace {
24192419
*
24202420
* @param N - number of indexed elements
24212421
* @param x - input array
2422-
* @param stride - stride length
2422+
* @param strideX - stride length
24232423
* @returns sum
24242424
*
24252425
* @example
@@ -2477,9 +2477,9 @@ interface Namespace {
24772477
* @param N - number of indexed elements
24782478
* @param sum - initial sum
24792479
* @param x - input array
2480-
* @param strideX - `x` stride length
2480+
* @param strideX - stride length for `x`
24812481
* @param y - output array
2482-
* @param strideY - `y` stride length
2482+
* @param strideY - stride length for `y`
24832483
* @returns output array
24842484
*
24852485
* @example
@@ -2508,9 +2508,9 @@ interface Namespace {
25082508
* @param N - number of indexed elements
25092509
* @param sum - initial sum
25102510
* @param x - input array
2511-
* @param strideX - `x` stride length
2511+
* @param strideX - stride length for `x`
25122512
* @param y - output array
2513-
* @param strideY - `y` stride length
2513+
* @param strideY - stride length for `y`
25142514
* @returns output array
25152515
*
25162516
* @example

‎lib/node_modules/@stdlib/complex/float64/base/docs/types/index.d.ts

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,25 @@ interface Namespace {
8585
*
8686
* var im = imag( out );
8787
* // returns -1.0
88+
*
89+
* @example
90+
* var Float64Array = require( '@stdlib/array/float64' );
91+
*
92+
* var out = new Float64Array( 2 );
93+
* var v = ns.mul.assign( 5.0, 3.0, -2.0, 1.0, out, 1, 0 );
94+
* // returns <Float64Array>[ -13.0, -1.0 ]
95+
*
96+
* var bool = ( out === v );
97+
* // returns true
98+
*
99+
* @example
100+
* var Float64Array = require( '@stdlib/array/float64' );
101+
*
102+
* var z1 = new Float64Array( [ 5.0, 3.0 ] );
103+
* var z2 = new Float64Array( [ -2.0, 1.0 ] );
104+
*
105+
* var out = ns.mul.strided( z1, 1, 0, z2, 1, 0, new Float64Array( 2 ), 1, 0 );
106+
* // returns <Float64Array>[ -13.0, -1.0 ]
88107
*/
89108
mul: typeof mul;
90109
}

‎lib/node_modules/@stdlib/math/base/ops/docs/types/index.d.ts

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,25 @@ interface Namespace {
156156
*
157157
* var im = imag( out );
158158
* // returns -1.0
159+
*
160+
* @example
161+
* var Float64Array = require( '@stdlib/array/float64' );
162+
*
163+
* var out = new Float64Array( 2 );
164+
* var v = ns.cmul.assign( 5.0, 3.0, -2.0, 1.0, out, 1, 0 );
165+
* // returns <Float64Array>[ -13.0, -1.0 ]
166+
*
167+
* var bool = ( out === v );
168+
* // returns true
169+
*
170+
* @example
171+
* var Float64Array = require( '@stdlib/array/float64' );
172+
*
173+
* var z1 = new Float64Array( [ 5.0, 3.0 ] );
174+
* var z2 = new Float64Array( [ -2.0, 1.0 ] );
175+
*
176+
* var out = ns.cmul.strided( z1, 1, 0, z2, 1, 0, new Float64Array( 2 ), 1, 0 );
177+
* // returns <Float64Array>[ -13.0, -1.0 ]
159178
*/
160179
cmul: typeof cmul;
161180

‎lib/node_modules/@stdlib/stats/base/docs/types/index.d.ts

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -607,7 +607,7 @@ interface Namespace {
607607
*
608608
* @param N - number of indexed elements
609609
* @param x - input array
610-
* @param stride - stride length
610+
* @param strideX - stride length
611611
* @returns arithmetic mean
612612
*
613613
* @example
@@ -659,7 +659,7 @@ interface Namespace {
659659
*
660660
* @param N - number of indexed elements
661661
* @param x - input array
662-
* @param stride - stride length
662+
* @param strideX - stride length
663663
* @returns arithmetic mean
664664
*
665665
* @example
@@ -711,7 +711,7 @@ interface Namespace {
711711
*
712712
* @param N - number of indexed elements
713713
* @param x - input array
714-
* @param stride - stride length
714+
* @param strideX - stride length
715715
* @returns arithmetic mean
716716
*
717717
* @example
@@ -763,7 +763,7 @@ interface Namespace {
763763
*
764764
* @param N - number of indexed elements
765765
* @param x - input array
766-
* @param stride - stride length
766+
* @param strideX - stride length
767767
* @returns arithmetic mean
768768
*
769769
* @example
@@ -1899,7 +1899,7 @@ interface Namespace {
18991899
* @param N - number of indexed elements
19001900
* @param correction - degrees of freedom adjustment
19011901
* @param x - input array
1902-
* @param stride - stride length
1902+
* @param strideX - stride length
19031903
* @returns standard error of the mean
19041904
*
19051905
* @example
@@ -1953,7 +1953,7 @@ interface Namespace {
19531953
* @param N - number of indexed elements
19541954
* @param correction - degrees of freedom adjustment
19551955
* @param x - input array
1956-
* @param stride - stride length
1956+
* @param strideX - stride length
19571957
* @returns standard error of the mean
19581958
*
19591959
* @example
@@ -2007,7 +2007,7 @@ interface Namespace {
20072007
* @param N - number of indexed elements
20082008
* @param correction - degrees of freedom adjustment
20092009
* @param x - input array
2010-
* @param stride - stride length
2010+
* @param strideX - stride length
20112011
* @returns standard error of the mean
20122012
*
20132013
* @example
@@ -4105,7 +4105,7 @@ interface Namespace {
41054105
*
41064106
* @param N - number of indexed elements
41074107
* @param x - input array
4108-
* @param stride - stride length
4108+
* @param strideX - stride length
41094109
* @returns arithmetic mean
41104110
*
41114111
* @example
@@ -5863,7 +5863,7 @@ interface Namespace {
58635863
* @param N - number of indexed elements
58645864
* @param correction - degrees of freedom adjustment
58655865
* @param x - input array
5866-
* @param stride - stride length
5866+
* @param strideX - stride length
58675867
* @returns variance
58685868
*
58695869
* @example

0 commit comments

Comments
 (0)