Skip to content

Commit afa917a

Browse files
committed
docs: improve jsdoc and change variable naming
--- 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: 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 ---
1 parent b0cc290 commit afa917a

File tree

5 files changed

+208
-272
lines changed

5 files changed

+208
-272
lines changed

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

Lines changed: 34 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -28,109 +28,77 @@ import { Complex128 } from '@stdlib/types/complex';
2828
*/
2929
interface Routine {
3030
/**
31-
* Calculates the dot product of vectors `zx` and `zy`.
31+
* Calculates the dot product of vectors `x` and `y`.
3232
*
3333
* @param N - number of indexed elements
34-
* @param zx - first input array
35-
* @param strideX - `zx` stride length
36-
* @param zy - second input array
37-
* @param strideY - `zy` stride length
34+
* @param x - first input array
35+
* @param strideX - `x` stride length
36+
* @param y - second input array
37+
* @param strideY - `y` stride length
3838
* @returns dot product
3939
*
4040
* @example
4141
* var Complex128Array = require( '@stdlib/array/complex128' );
42-
* var real = require( '@stdlib/complex/float64/real' );
43-
* var imag = require( '@stdlib/complex/float64/imag' );
4442
*
45-
* var zx = new Complex128Array( [ 4.0, 2.0, -3.0, 5.0, -1.0, 7.0 ] );
46-
* var zy = new Complex128Array( [ 2.0, 6.0, -1.0, -4.0, 8.0, 9.0 ] );
43+
* var x = new Complex128Array( [ 4.0, 2.0, -3.0, 5.0, -1.0, 7.0 ] );
44+
* var y = new Complex128Array( [ 2.0, 6.0, -1.0, -4.0, 8.0, 9.0 ] );
4745
*
48-
* var z = zdotu( 3, zx, 1, zy, 1 );
49-
* // returns <Complex128>
50-
*
51-
* var re = real( z );
52-
* // returns -52.0
53-
*
54-
* var im = imag( z );
55-
* // returns 82.0
46+
* var z = zdotu( 3, x, 1, y, 1 );
47+
* // returns <Complex128>[ -52.0, 82.0 ]
5648
*/
57-
( N: number, zx: Complex128Array, strideX: number, zy: Complex128Array, strideY: number ): Complex128;
49+
( N: number, x: Complex128Array, strideX: number, y: Complex128Array, strideY: number ): Complex128;
5850

5951
/**
60-
* Calculates the dot product of vectors `zx` and `zy` using alternative indexing semantics.
52+
* Calculates the dot product of vectors `x` and `y` using alternative indexing semantics.
6153
*
6254
* @param N - number of indexed elements
63-
* @param zx - first input array
64-
* @param strideX - `zx` stride length
65-
* @param offsetX - starting index for `zx`
66-
* @param zy - second input array
67-
* @param strideY - `zy` stride length
68-
* @param offsetY - starting index for `zy`
55+
* @param x - first input array
56+
* @param strideX - `x` stride length
57+
* @param offsetX - starting index for `x`
58+
* @param y - second input array
59+
* @param strideY - `y` stride length
60+
* @param offsetY - starting index for `y`
6961
* @returns dot product
7062
*
7163
* @example
7264
* var Complex128Array = require( '@stdlib/array/complex128' );
73-
* var real = require( '@stdlib/complex/float64/real' );
74-
* var imag = require( '@stdlib/complex/float64/imag' );
75-
*
76-
* var zx = new Complex128Array( [ 4.0, 2.0, -3.0, 5.0, -1.0, 7.0 ] );
77-
* var zy = new Complex128Array( [ 2.0, 6.0, -1.0, -4.0, 8.0, 9.0 ] );
78-
*
79-
* var z = zdotu.ndarray( zx.length, zx, 1, 0, zy, 1, 0 );
80-
* // returns <Complex128>
8165
*
82-
* var re = real( z );
83-
* // returns -52.0
66+
* var x = new Complex128Array( [ 4.0, 2.0, -3.0, 5.0, -1.0, 7.0 ] );
67+
* var y = new Complex128Array( [ 2.0, 6.0, -1.0, -4.0, 8.0, 9.0 ] );
8468
*
85-
* var im = imag( z );
86-
* // returns 82.0
69+
* var z = zdotu.ndarray( x.length, x, 1, 0, y, 1, 0 );
70+
* // returns <Complex128>[ -52.0, 82.0 ]
8771
*/
88-
ndarray( N: number, zx: Complex128Array, strideX: number, offsetX: number, zy: Complex128Array, strideY: number, offsetY: number ): Complex128;
72+
ndarray( N: number, x: Complex128Array, strideX: number, offsetX: number, y: Complex128Array, strideY: number, offsetY: number ): Complex128;
8973
}
9074

9175
/**
9276
* Computes the dot product of two double-precision complex floating-point vectors.
9377
*
9478
* @param N - number of indexed elements
95-
* @param zx - first input array
96-
* @param strideX - `zx` stride length
97-
* @param zy - second input array
98-
* @param strideY - `zy` stride length
79+
* @param x - first input array
80+
* @param strideX - `x` stride length
81+
* @param y - second input array
82+
* @param strideY - `y` stride length
9983
* @returns dot product
10084
*
10185
* @example
10286
* var Complex128Array = require( '@stdlib/array/complex128' );
103-
* var real = require( '@stdlib/complex/float64/real' );
104-
* var imag = require( '@stdlib/complex/float64/imag' );
10587
*
106-
* var zx = new Complex128Array( [ 4.0, 2.0, -3.0, 5.0, -1.0, 7.0 ] );
107-
* var zy = new Complex128Array( [ 2.0, 6.0, -1.0, -4.0, 8.0, 9.0 ] );
88+
* var x = new Complex128Array( [ 4.0, 2.0, -3.0, 5.0, -1.0, 7.0 ] );
89+
* var y = new Complex128Array( [ 2.0, 6.0, -1.0, -4.0, 8.0, 9.0 ] );
10890
*
109-
* var z = zdotu( 3, zx, 1, zy, 1 );
110-
* // returns <Complex128>
111-
*
112-
* var re = real( z );
113-
* // returns -52.0
114-
*
115-
* var im = imag( z );
116-
* // returns 82.0
91+
* var z = zdotu( 3, x, 1, y, 1 );
92+
* // returns <Complex128>[ -52.0, 82.0 ]
11793
*
11894
* @example
11995
* var Complex128Array = require( '@stdlib/array/complex128' );
120-
* var real = require( '@stdlib/complex/float64/real' );
121-
* var imag = require( '@stdlib/complex/float64/imag' );
122-
*
123-
* var zx = new Complex128Array( [ 4.0, 2.0, -3.0, 5.0, -1.0, 7.0 ] );
124-
* var zy = new Complex128Array( [ 2.0, 6.0, -1.0, -4.0, 8.0, 9.0 ] );
125-
*
126-
* var z = zdotu.ndarray( zx.length, zx, 1, 0, zy, 1, 0 );
127-
* // returns <Complex128>
12896
*
129-
* var re = real( z );
130-
* // returns -52.0
97+
* var x = new Complex128Array( [ 4.0, 2.0, -3.0, 5.0, -1.0, 7.0 ] );
98+
* var y = new Complex128Array( [ 2.0, 6.0, -1.0, -4.0, 8.0, 9.0 ] );
13199
*
132-
* var im = imag( z );
133-
* // returns 82.0
100+
* var z = zdotu.ndarray( x.length, x, 1, 0, y, 1, 0 );
101+
* // returns <Complex128>[ -52.0, 82.0 ]
134102
*/
135103
declare var zdotu: Routine;
136104

0 commit comments

Comments
 (0)