Skip to content

Commit 7bf9b6e

Browse files
committed
docs(types): fix ndarray example to use cgemv.ndarray signature
--- 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: 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: passed - task: lint_license_headers status: passed ---
1 parent 9347813 commit 7bf9b6e

File tree

2 files changed

+7
-8
lines changed

2 files changed

+7
-8
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ interface Routine {
9090
* var alpha = new Complex64( 0.5, 0.5 );
9191
* var beta = new Complex64( 0.5, -0.5 );
9292
*
93-
* cgemv( 'no-transpose', 4, 2, alpha, A, 1, 4, 0, x, 1, 0, beta, y, 1, 0 );
93+
* cgemv.ndarray( 'no-transpose', 4, 2, alpha, A, 1, 4, 0, x, 1, 0, beta, y, 1, 0 );
9494
* // y => <Complex64Array>[ -10.0, 11.0, -12.0, 14.0, -14.0, 17.0, -16.0, 20.0 ]
9595
*/
9696
ndarray( trans: TransposeOperation, M: number, N: number, alpha: Complex64, A: Complex64Array, strideA1: number, strideA2: number, offsetA: number, x: Complex64Array, strideX: number, offsetX: number, beta: Complex64, y: Complex64Array, strideY: number, offsetY: number ): Complex64Array;
@@ -136,7 +136,7 @@ interface Routine {
136136
* var alpha = new Complex64( 0.5, 0.5 );
137137
* var beta = new Complex64( 0.5, -0.5 );
138138
*
139-
* cgemv( 'no-transpose', 4, 2, alpha, A, 1, 4, 0, x, 1, 0, beta, y, 1, 0 );
139+
* cgemv.ndarray( 'no-transpose', 4, 2, alpha, A, 1, 4, 0, x, 1, 0, beta, y, 1, 0 );
140140
* // y => <Complex64Array>[ -10.0, 11.0, -12.0, 14.0, -14.0, 17.0, -16.0, 20.0 ]
141141
*/
142142
declare var cgemv: Routine;

lib/node_modules/@stdlib/blas/base/cgemv/docs/types/test.ts

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ import cgemv = require( './index' );
4949
cgemv( undefined, 'no-transpose', 10, 10, alpha, A, 10, x, 1, beta, y, 1 ); // $ExpectError
5050
cgemv( [], 'no-transpose', 10, 10, alpha, A, 10, x, 1, beta, y, 1 ); // $ExpectError
5151
cgemv( {}, 'no-transpose', 10, 10, alpha, A, 10, x, 1, beta, y, 1 ); // $ExpectError
52-
cgemv( (x: number): number => x, 'no-transpose', 10, 10, alpha, A, 10, x, 1, beta, y, 1 ); // $ExpectError
52+
cgemv( ( x: number ): number => x, 'no-transpose', 10, 10, alpha, A, 10, x, 1, beta, y, 1 ); // $ExpectError
5353
}
5454

5555
// The compiler throws an error if the function is provided a second argument which is not a string...
@@ -67,7 +67,7 @@ import cgemv = require( './index' );
6767
cgemv( 'row-major', undefined, 10, 10, alpha, A, 10, x, 1, beta, y, 1 ); // $ExpectError
6868
cgemv( 'row-major', [], 10, 10, alpha, A, 10, x, 1, beta, y, 1 ); // $ExpectError
6969
cgemv( 'row-major', {}, 10, 10, alpha, A, 10, x, 1, beta, y, 1 ); // $ExpectError
70-
cgemv( 'row-major', (x: number): number => x, 10, 10, alpha, A, 10, x, 1, beta, y, 1 ); // $ExpectError
70+
cgemv( 'row-major', ( x: number ): number => x, 10, 10, alpha, A, 10, x, 1, beta, y, 1 ); // $ExpectError
7171
}
7272

7373
// The compiler throws an error if the function is provided a third argument which is not a number...
@@ -85,7 +85,7 @@ import cgemv = require( './index' );
8585
cgemv( 'row-major', 'no-transpose', undefined, 10, alpha, A, 10, x, 1, beta, y, 1 ); // $ExpectError
8686
cgemv( 'row-major', 'no-transpose', [], 10, alpha, A, 10, x, 1, beta, y, 1 ); // $ExpectError
8787
cgemv( 'row-major', 'no-transpose', {}, 10, alpha, A, 10, x, 1, beta, y, 1 ); // $ExpectError
88-
cgemv( 'row-major', 'no-transpose', (x: number): number => x, 10, alpha, A, 10, x, 1, beta, y, 1 ); // $ExpectError
88+
cgemv( 'row-major', 'no-transpose', ( x: number ): number => x, 10, alpha, A, 10, x, 1, beta, y, 1 ); // $ExpectError
8989
}
9090

9191
// The compiler throws an error if the function is provided a fourth argument which is not a number...
@@ -103,7 +103,7 @@ import cgemv = require( './index' );
103103
cgemv( 'row-major', 'no-transpose', 10, undefined, alpha, A, 10, x, 1, beta, y, 1 ); // $ExpectError
104104
cgemv( 'row-major', 'no-transpose', 10, [], alpha, A, 10, x, 1, beta, y, 1 ); // $ExpectError
105105
cgemv( 'row-major', 'no-transpose', 10, {}, alpha, A, 10, x, 1, beta, y, 1 ); // $ExpectError
106-
cgemv( 'row-major', 'no-transpose', 10, (x: number): number => x, alpha, A, 10, x, 1, beta, y, 1 ); // $ExpectError
106+
cgemv( 'row-major', 'no-transpose', 10, ( x: number ): number => x, alpha, A, 10, x, 1, beta, y, 1 ); // $ExpectError
107107
}
108108

109109
// The compiler throws an error if the function is provided a fifth argument which is not a Complex64...
@@ -120,7 +120,7 @@ import cgemv = require( './index' );
120120
cgemv( 'row-major', 'no-transpose', 10, 10, undefined, A, 10, x, 1, beta, y, 1 ); // $ExpectError
121121
cgemv( 'row-major', 'no-transpose', 10, 10, [], A, 10, x, 1, beta, y, 1 ); // $ExpectError
122122
cgemv( 'row-major', 'no-transpose', 10, 10, {}, A, 10, x, 1, beta, y, 1 ); // $ExpectError
123-
cgemv( 'row-major', 'no-transpose', 10, 10, (x: number): number => x, A, 10, x, 1, beta, y, 1 ); // $ExpectError
123+
cgemv( 'row-major', 'no-transpose', 10, 10, ( x: number ): number => x, A, 10, x, 1, beta, y, 1 ); // $ExpectError
124124
}
125125

126126
// The compiler throws an error if the function is provided a sixth argument which is not a Complex64Array...
@@ -344,7 +344,6 @@ import cgemv = require( './index' );
344344
const x = new Complex64Array( 10 );
345345
const y = new Complex64Array( 10 );
346346
const A = new Complex64Array( 20 );
347-
const alpha = new Complex64( 0.5, 0.5 );
348347
const beta = new Complex64( 0.5, -0.5 );
349348

350349
cgemv.ndarray( 'no-transpose', 10, 10, '10', A, 10, 1, 0, x, 1, 0, beta, y, 1, 0 ); // $ExpectError

0 commit comments

Comments
 (0)