Skip to content

Commit 2bde17e

Browse files
ShabiShett07ShabiShett07
committed
docs: improve jsdoc and 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: na - task: lint_license_headers status: passed ---
1 parent 98aae2b commit 2bde17e

File tree

6 files changed

+113
-213
lines changed

6 files changed

+113
-213
lines changed

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

Lines changed: 39 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -31,125 +31,85 @@ interface Routine {
3131
* Scales a double-precision complex floating-point vector by a double-precision complex floating-point constant and adds the result to a double-precision complex floating-point vector.
3232
*
3333
* @param N - number of indexed elements
34-
* @param za - scalar constant
35-
* @param zx - first input array
36-
* @param strideX - `zx` stride length
37-
* @param zy - second input array
38-
* @param strideY - `zy` stride length
34+
* @param alpha - scalar constant
35+
* @param x - first input array
36+
* @param strideX - `x` stride length
37+
* @param y - second input array
38+
* @param strideY - `y` stride length
3939
* @returns second input array
4040
*
4141
* @example
4242
* var Complex128Array = require( '@stdlib/array/complex128' );
4343
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
44-
* var real = require( '@stdlib/complex/float64/real' );
45-
* var imag = require( '@stdlib/complex/float64/imag' );
4644
*
47-
* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
48-
* var zy = new Complex128Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
49-
* var za = new Complex128( 2.0, 2.0 );
45+
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
46+
* var y = new Complex128Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
47+
* var alpha = new Complex128( 2.0, 2.0 );
5048
*
51-
* zaxpy( zx.length, za, zx, 1, zy, 1 );
52-
*
53-
* var z = zy.get( 0 );
54-
* // returns <Complex128>
55-
*
56-
* var re = real( z );
57-
* // returns -1.0
58-
*
59-
* var im = imag( z );
60-
* // returns 7.0
49+
* zaxpy( x.length, alpha, x, 1, y, 1 );
50+
* // y => <Complex128Array>[ -1.0, 7.0, -1.0, 15.0, -1.0, 23.0 ]
6151
*/
62-
( N: number, za: Complex128, zx: Complex128Array, strideX: number, zy: Complex128Array, strideY: number ): Complex128Array;
52+
( N: number, alpha: Complex128, x: Complex128Array, strideX: number, y: Complex128Array, strideY: number ): Complex128Array;
6353

6454
/**
6555
* Scales a double-precision complex floating-point vector by a double-precision complex floating-point constant and adds the result to a double-precision complex floating-point vector.
6656
*
6757
* @param N - number of indexed elements
68-
* @param za - scalar constant
69-
* @param zx - first input array
70-
* @param strideX - `zx` stride length
71-
* @param offsetX - starting index for `zx`
72-
* @param zy - second input array
73-
* @param strideY - `zy` stride length
74-
* @param offsetY - starting index for `zy`
58+
* @param alpha - scalar constant
59+
* @param x - first input array
60+
* @param strideX - `x` stride length
61+
* @param offsetX - starting index for `x`
62+
* @param y - second input array
63+
* @param strideY - `y` stride length
64+
* @param offsetY - starting index for `y`
7565
* @returns second input array
7666
*
7767
* @example
7868
* var Complex128Array = require( '@stdlib/array/complex128' );
7969
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
80-
* var real = require( '@stdlib/complex/float64/real' );
81-
* var imag = require( '@stdlib/complex/float64/imag' );
82-
*
83-
* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
84-
* var zy = new Complex128Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
85-
* var za = new Complex128( 2.0, 2.0 );
86-
*
87-
* zaxpy.ndarray( zx.length, za, zx, 1, 0, zy, 1, 0 );
88-
*
89-
* var z = zy.get( 0 );
90-
* // returns <Complex128>
9170
*
92-
* var re = real( z );
93-
* // returns -1.0
71+
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
72+
* var y = new Complex128Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
73+
* var alpha = new Complex128( 2.0, 2.0 );
9474
*
95-
* var im = imag( z );
96-
* // returns 7.0
75+
* zaxpy.ndarray( x.length, alpha, x, 1, 0, y, 1, 0 );
76+
* // y => <Complex128Array>[ -1.0, 7.0, -1.0, 15.0, -1.0, 23.0 ]
9777
*/
98-
ndarray( N: number, za: Complex128, zx: Complex128Array, strideX: number, offsetX: number, zy: Complex128Array, strideY: number, offsetY: number ): Complex128Array;
78+
ndarray( N: number, alpha: Complex128, x: Complex128Array, strideX: number, offsetX: number, y: Complex128Array, strideY: number, offsetY: number ): Complex128Array;
9979
}
10080

10181
/**
10282
* Scales a double-precision complex floating-point vector by a double-precision complex floating-point constant and adds the result to a double-precision complex floating-point vector.
10383
*
10484
* @param N - number of indexed elements
105-
* @param za - scalar constant
106-
* @param zx - first input array
107-
* @param strideX - `zx` stride length
108-
* @param zy - second input array
109-
* @param strideY - `zy` stride length
85+
* @param alpha - scalar constant
86+
* @param x - first input array
87+
* @param strideX - `x` stride length
88+
* @param y - second input array
89+
* @param strideY - `y` stride length
11090
* @returns second input array
11191
*
11292
* @example
11393
* var Complex128Array = require( '@stdlib/array/complex128' );
11494
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
115-
* var real = require( '@stdlib/complex/float64/real' );
116-
* var imag = require( '@stdlib/complex/float64/imag' );
11795
*
118-
* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
119-
* var zy = new Complex128Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
120-
* var za = new Complex128( 2.0, 2.0 );
96+
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
97+
* var y = new Complex128Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
98+
* var alpha = new Complex128( 2.0, 2.0 );
12199
*
122-
* zaxpy( 2, za, zx, 2, zy, 2 );
123-
*
124-
* var z = zy.get( 0 );
125-
* // returns <Complex128>
126-
*
127-
* var re = real( z );
128-
* // returns -1.0
129-
*
130-
* var im = imag( z );
131-
* // returns 7.0
100+
* zaxpy( 2, alpha, x, 2, y, 2 );
101+
* // y => <Complex128Array>[ -1.0, 7.0, -1.0, 15.0, -1.0, 23.0 ]
132102
*
133103
* @example
134104
* var Complex128Array = require( '@stdlib/array/complex128' );
135105
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
136-
* var real = require( '@stdlib/complex/float64/real' );
137-
* var imag = require( '@stdlib/complex/float64/imag' );
138-
*
139-
* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
140-
* var zy = new Complex128Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
141-
* var za = new Complex128( 2.0, 2.0 );
142-
*
143-
* zaxpy.ndarray( 3, za, zx, 1, 1, zy, 1, 1 );
144-
*
145-
* var z = zy.get( 3 );
146-
* // returns <Complex128>
147106
*
148-
* var re = real( z );
149-
* // returns -1.0
107+
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
108+
* var y = new Complex128Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
109+
* var alpha = new Complex128( 2.0, 2.0 );
150110
*
151-
* var im = imag( z );
152-
* // returns 31.0
111+
* zaxpy.ndarray( 3, alpha, x, 1, 1, y, 1, 1 );
112+
* // y => <Complex128Array>[ -1.0, 7.0, -1.0, 15.0, -1.0, 23.0 ]
153113
*/
154114
declare var zaxpy: Routine;
155115

‎lib/node_modules/@stdlib/blas/base/zaxpy/lib/index.js‎

Lines changed: 10 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -26,46 +26,26 @@
2626
* @example
2727
* var Complex128Array = require( '@stdlib/array/complex128' );
2828
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
29-
* var real = require( '@stdlib/complex/float64/real' );
30-
* var imag = require( '@stdlib/complex/float64/imag' );
3129
* var zaxpy = require( '@stdlib/blas/base/zaxpy' );
3230
*
33-
* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
34-
* var zy = new Complex128Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
35-
* var za = new Complex128( 2.0, 2.0 );
31+
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
32+
* var y = new Complex128Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
33+
* var alpha = new Complex128( 2.0, 2.0 );
3634
*
37-
* zaxpy( 3, za, zx, 1, zy, 1 );
38-
*
39-
* var z = zy.get( 0 );
40-
* // returns <Complex128>
41-
*
42-
* var re = real( z );
43-
* // returns -1.0
44-
*
45-
* var im = imag( z );
46-
* // returns 7.0
35+
* zaxpy( 3, alpha, x, 1, y, 1 );
36+
* // y => <Complex128Array>[ -1.0, 7.0, -1.0, 15.0, -1.0, 23.0 ]
4737
*
4838
* @example
4939
* var Complex128Array = require( '@stdlib/array/complex128' );
5040
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
51-
* var real = require( '@stdlib/complex/float64/real' );
52-
* var imag = require( '@stdlib/complex/float64/imag' );
5341
* var zaxpy = require( '@stdlib/blas/base/zaxpy' );
5442
*
55-
* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
56-
* var zy = new Complex128Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
57-
* var za = new Complex128( 2.0, 2.0 );
58-
*
59-
* zaxpy.ndarray( 3, za, zx, 1, 0, zy, 1, 0 );
60-
*
61-
* var z = zy.get( 0 );
62-
* // returns <Complex128>
63-
*
64-
* var re = real( z );
65-
* // returns -1.0
43+
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
44+
* var y = new Complex128Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
45+
* var alpha = new Complex128( 2.0, 2.0 );
6646
*
67-
* var im = imag( z );
68-
* // returns 7.0
47+
* zaxpy.ndarray( 3, alpha, x, 1, 0, y, 1, 0 );
48+
* // y => <Complex128Array>[ -1.0, 7.0, -1.0, 15.0, -1.0, 23.0 ]
6949
*/
7050

7151
// MODULES //

‎lib/node_modules/@stdlib/blas/base/zaxpy/lib/ndarray.js‎

Lines changed: 18 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -31,55 +31,45 @@ var cadd = require( '@stdlib/complex/float64/base/add' );
3131
* Scales a double-precision complex floating-point vector by a double-precision complex floating-point constant and adds the result to a double-precision complex floating-point vector.
3232
*
3333
* @param {PositiveInteger} N - number of indexed elements
34-
* @param {Complex128} za - scalar constant
35-
* @param {Complex128Array} zx - first input array
36-
* @param {integer} strideX - `zx` stride length
37-
* @param {integer} offsetX - starting index for `zx`
38-
* @param {Complex128Array} zy - second input array
39-
* @param {integer} strideY - `zy` stride length
40-
* @param {integer} offsetY - starting index for `zy`
34+
* @param {Complex128} alpha - scalar constant
35+
* @param {Complex128Array} x - first input array
36+
* @param {integer} strideX - `x` stride length
37+
* @param {integer} offsetX - starting index for `x`
38+
* @param {Complex128Array} y - second input array
39+
* @param {integer} strideY - `y` stride length
40+
* @param {integer} offsetY - starting index for `y`
4141
* @returns {Complex128Array} second input array
4242
*
4343
* @example
4444
* var Complex128Array = require( '@stdlib/array/complex128' );
4545
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
46-
* var real = require( '@stdlib/complex/float64/real' );
47-
* var imag = require( '@stdlib/complex/float64/imag' );
4846
*
49-
* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
50-
* var zy = new Complex128Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
51-
* var za = new Complex128( 2.0, 2.0 );
47+
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
48+
* var y = new Complex128Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
49+
* var alpha = new Complex128( 2.0, 2.0 );
5250
*
53-
* zaxpy( 3, za, zx, 1, 0, zy, 1, 0 );
54-
*
55-
* var z = zy.get( 0 );
56-
* // returns <Complex128>
57-
*
58-
* var re = real( z );
59-
* // returns -1.0
60-
*
61-
* var im = imag( z );
62-
* // returns 7.0
51+
* zaxpy( 3, alpha, x, 1, 0, y, 1, 0 );
52+
* // y => <Complex128Array>[ -1.0, 7.0, -1.0, 15.0, -1.0, 23.0 ]
6353
*/
64-
function zaxpy( N, za, zx, strideX, offsetX, zy, strideY, offsetY ) {
54+
function zaxpy( N, alpha, x, strideX, offsetX, y, strideY, offsetY ) {
6555
var ix;
6656
var iy;
6757
var i;
6858

6959
if ( N <= 0 ) {
70-
return zy;
60+
return y;
7161
}
72-
if ( dcabs1( za ) === 0.0 ) {
73-
return zy;
62+
if ( dcabs1( alpha ) === 0.0 ) {
63+
return y;
7464
}
7565
ix = offsetX;
7666
iy = offsetY;
7767
for ( i = 0; i < N; i++ ) {
78-
zy.set( cadd( cmul( za, zx.get( ix ) ), zy.get( iy ) ), iy );
68+
y.set( cadd( cmul( alpha, x.get( ix ) ), y.get( iy ) ), iy );
7969
ix += strideX;
8070
iy += strideY;
8171
}
82-
return zy;
72+
return y;
8373
}
8474

8575

‎lib/node_modules/@stdlib/blas/base/zaxpy/lib/ndarray.native.js‎

Lines changed: 19 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -31,45 +31,35 @@ var addon = require( './../src/addon.node' );
3131
* Scales a double-precision complex floating-point vector by a double-precision complex floating-point constant and adds the result to a double-precision complex floating-point vector.
3232
*
3333
* @param {PositiveInteger} N - number of indexed elements
34-
* @param {Complex128} za - scalar constant
35-
* @param {Complex128Array} zx - first input array
36-
* @param {integer} strideX - `zx` stride length
37-
* @param {NonNegativeInteger} offsetX - starting `zx` index
38-
* @param {Complex128Array} zy - second input array
39-
* @param {integer} strideY - `zy` stride length
40-
* @param {NonNegativeInteger} offsetY - starting `zy` index
34+
* @param {Complex128} alpha - scalar constant
35+
* @param {Complex128Array} x - first input array
36+
* @param {integer} strideX - `x` stride length
37+
* @param {NonNegativeInteger} offsetX - starting `x` index
38+
* @param {Complex128Array} y - second input array
39+
* @param {integer} strideY - `y` stride length
40+
* @param {NonNegativeInteger} offsetY - starting `y` index
4141
* @returns {Complex128Array} second input array
4242
*
4343
* @example
4444
* var Complex128Array = require( '@stdlib/array/complex128' );
4545
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
46-
* var real = require( '@stdlib/complex/float64/real' );
47-
* var imag = require( '@stdlib/complex/float64/imag' );
4846
*
49-
* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
50-
* var zy = new Complex128Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
51-
* var za = new Complex128( 2.0, 2.0 );
47+
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
48+
* var y = new Complex128Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
49+
* var alpha = new Complex128( 2.0, 2.0 );
5250
*
53-
* zaxpy( 3, za, zx, 1, 0, zy, 1, 0 );
54-
*
55-
* var z = zy.get( 0 );
56-
* // returns <Complex128>
57-
*
58-
* var re = real( z );
59-
* // returns -1.0
60-
*
61-
* var im = imag( z );
62-
* // returns 7.0
51+
* zaxpy( 3, alpha, x, 1, 0, y, 1, 0 );
52+
* // y => <Complex128Array>[ -1.0, 7.0, -1.0, 15.0, -1.0, 23.0 ]
6353
*/
64-
function zaxpy( N, za, zx, strideX, offsetX, zy, strideY, offsetY ) {
65-
var viewZX;
66-
var viewZY;
54+
function zaxpy( N, alpha, x, strideX, offsetX, y, strideY, offsetY ) {
55+
var viewX;
56+
var viewY;
6757
offsetX = minViewBufferIndex( N, strideX, offsetX );
6858
offsetY = minViewBufferIndex( N, strideY, offsetY );
69-
viewZX = reinterpret( zx, offsetX );
70-
viewZY = reinterpret( zy, offsetY );
71-
addon( N, za, viewZX, strideX, viewZY, strideY );
72-
return zy;
59+
viewX = reinterpret( x, offsetX );
60+
viewY = reinterpret( y, offsetY );
61+
addon( N, alpha, viewX, strideX, viewY, strideY );
62+
return y;
7363
}
7464

7565

0 commit comments

Comments
 (0)