Skip to content

Commit 9860165

Browse files
committed
docs: update variable naming and jsdoc
--- 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: passed - 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 114b390 commit 9860165

File tree

2 files changed

+26
-25
lines changed

2 files changed

+26
-25
lines changed

lib/node_modules/@stdlib/blas/base/dzasum/docs/repl.txt

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11

2-
{{alias}}( N, x, stride )
3-
Compute the sum of the absolute values of each element in a
4-
double-precision complex floating-point vector
2+
{{alias}}( N, x, strideX )
3+
Computes the sum of the absolute values of each element in a
4+
double-precision complex floating-point vector.
55

6-
The `N` and `stride` parameters determine which elements in `x` are used
6+
The `N` and `strideX` parameters determine which elements in `x` are used
77
to compute the sum.
88

99
Indexing is relative to the first index. To introduce an offset, use typed
@@ -19,7 +19,7 @@
1919
x: Complex128Array
2020
Input array.
2121

22-
stride: integer
22+
strideX: integer
2323
Index increment.
2424

2525
Returns
@@ -30,28 +30,29 @@
3030
Examples
3131
--------
3232
// Standard usage:
33-
> var x = new {{alias:@stdlib/array/complex128}}( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0 ] );
33+
> var x = new {{alias:@stdlib/array/complex128}}( [ -2.0, 1.0, 3.0, -5.0 ]);
3434
> var s = {{alias}}( x.length, x, 1 )
35-
15.0
35+
11.0
3636

37-
// Sum every other value:
37+
// Advanced indexing:
38+
> var x = new {{alias:@stdlib/array/complex128}}( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0 ] );
3839
> s = {{alias}}( 2, x, 2 )
3940
7.0
4041

41-
// Use view offset; e.g., starting at 2nd element:
42-
> var x0 = new {{alias:@stdlib/array/complex128}}( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0, 7.0, -8.0 ] );
42+
// Using typed array views:
43+
> var x0 = new {{alias:@stdlib/array/complex128}}( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );
4344
> var x1 = new {{alias:@stdlib/array/complex128}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
44-
> s = {{alias}}( 2, x1, 2 )
45-
22.0
45+
> s = {{alias}}( 2, x1, 1 )
46+
18.0
4647

4748

48-
{{alias}}.ndarray( N, x, stride, offset )
49-
Compute the sum of the absolute values of each element in a
49+
{{alias}}.ndarray( N, x, strideX, offsetX )
50+
Computes the sum of the absolute values of each element in a
5051
double-precision complex floating-point vector using alternative indexing
5152
semantics.
5253

5354
While typed array views mandate a view offset based on the underlying
54-
buffer, the `offset` parameter supports indexing semantics based on a
55+
buffer, the `offsetX` parameter supports indexing semantics based on a
5556
starting index.
5657

5758
Parameters
@@ -62,10 +63,10 @@
6263
x: Complex128Array
6364
Input array.
6465

65-
stride: integer
66+
strideX: integer
6667
Index increment.
6768

68-
offset: integer
69+
offsetX: integer
6970
Starting index.
7071

7172
Returns
@@ -76,11 +77,11 @@
7677
Examples
7778
--------
7879
// Standard usage:
79-
> var x = new {{alias:@stdlib/array/complex128}}( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ] );
80+
> var x = new {{alias:@stdlib/array/complex128}}( [ -2.0, 1.0, 3.0, -5.0 ] );
8081
> var s = {{alias}}.ndarray( x.length, x, 1, 0 )
81-
19.0
82+
11.0
8283

83-
// Sum the last three elements:
84+
// Advanced indexing:
8485
> x = new {{alias:@stdlib/array/complex128}}( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0, 7.0, -8.0 ] );
8586
> s = {{alias}}.ndarray( 3, x, -1, x.length-1 )
8687
33.0

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ import { Complex128Array } from '@stdlib/types/array';
2727
*/
2828
interface Routine {
2929
/**
30-
* Compute the sum of the absolute values of each element in a double-precision complex floating-point vector.
30+
* Computes the sum of the absolute values of each element in a double-precision complex floating-point vector.
3131
*
3232
* @param N - number of indexed elements
3333
* @param x - input array
@@ -45,12 +45,12 @@ interface Routine {
4545
( N: number, x: Complex128Array, stride: number ): number;
4646

4747
/**
48-
* Computes the sum of the absolute values using alternative indexing semantics.
48+
* Computes the sum of the absolute values of each element in a double-precision complex floating-point vector using alternative indexing semantics.
4949
*
5050
* @param N - number of indexed elements
5151
* @param x - input array
5252
* @param stride - stride length
53-
* @param offset - starting index
53+
* @param offsetX - starting index
5454
* @returns sum of absolute values
5555
*
5656
* @example
@@ -61,11 +61,11 @@ interface Routine {
6161
* var z = dzasum.ndarray( x.length, x, 1, 0 );
6262
* // returns 19.0
6363
*/
64-
ndarray( N: number, x: Complex128Array, stride: number, offset: number ): number;
64+
ndarray( N: number, x: Complex128Array, stride: number, offsetX: number ): number;
6565
}
6666

6767
/**
68-
* Compute the sum of the absolute values of each element in a double-precision complex floating-point vector.
68+
* Computes the sum of the absolute values of each element in a double-precision complex floating-point vector.
6969
*
7070
* @param N - number of indexed elements
7171
* @param x - input array

0 commit comments

Comments
 (0)