Skip to content

Commit a8b2c12

Browse files
committed
chore: clean-up
--- 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: passed - task: lint_package_json status: passed - 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: passed - 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 00af2a0 commit a8b2c12

File tree

6 files changed

+14
-14
lines changed

6 files changed

+14
-14
lines changed

lib/node_modules/@stdlib/blas/base/ggemv/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ limitations under the License.
2020

2121
# ggemv
2222

23-
> Perform one of the matrix-vector operations `y = α*A*x + β*y` or `y = α*A**T*x + β*y`.
23+
> Perform one of the matrix-vector operations `y = α*A*x + β*y` or `y = α*A^T*x + β*y`.
2424
2525
<section class="usage">
2626

@@ -32,7 +32,7 @@ var ggemv = require( '@stdlib/blas/base/ggemv' );
3232

3333
#### ggemv( order, trans, M, N, α, A, LDA, x, sx, β, y, sy )
3434

35-
Performs one of the matrix-vector operations `y = α*A*x + β*y` or `y = α*A**T*x + β*y`, where `α` and `β` are scalars, `x` and `y` are vectors, and `A` is an `M` by `N` matrix.
35+
Performs one of the matrix-vector operations `y = α*A*x + β*y` or `y = α*A^T*x + β*y`, where `α` and `β` are scalars, `x` and `y` are vectors, and `A` is an `M` by `N` matrix.
3636

3737
```javascript
3838
var A = [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ];
@@ -51,7 +51,7 @@ The function has the following parameters:
5151
- **N**: number of columns in the matrix `A`.
5252
- **α**: scalar constant.
5353
- **A**: input matrix stored in linear memory.
54-
- **lda**: stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`).
54+
- **LDA**: stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`).
5555
- **x**: an `M` element input array.
5656
- **sx**: stride length for `x`.
5757
- **β**: scalar constant.
@@ -91,7 +91,7 @@ ggemv( 'row-major', 'no-transpose', 2, 2, 1.0, A, 2, x1, -1, 1.0, y1, -1 );
9191

9292
#### ggemv.ndarray( trans, M, N, α, A, sa1, sa2, oa, x, sx, ox, β, y, sy, oy )
9393

94-
Performs one of the matrix-vector operations `y = α*A*x + β*y` or `y = α*A**T*x + β*y`, using alternative indexing semantics and where `α` and `β` are scalars, `x` and `y` are vectors, and `A` is an `M` by `N` matrix.
94+
Performs one of the matrix-vector operations `y = α*A*x + β*y` or `y = α*A^T*x + β*y`, using alternative indexing semantics and where `α` and `β` are scalars, `x` and `y` are vectors, and `A` is an `M` by `N` matrix.
9595

9696
```javascript
9797
var A = [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ];
@@ -131,7 +131,7 @@ ggemv.ndarray( 'no-transpose', 2, 3, 1.0, A, 3, 1, 0, x, 1, 1, 1.0, y, -2, 2 );
131131

132132
## Notes
133133

134-
- `ggemv()` corresponds to the [BLAS][blas] level 2 function [`ggemv`][ggemv] with the exception that this implementation works with any array type, not just Float64Arrays. Depending on the environment, the typed versions ([`ggemv`][@stdlib/blas/base/ggemv], [`sgemv`][@stdlib/blas/base/sgemv], etc.) are likely to be significantly more performant.
134+
- `ggemv()` corresponds to the [BLAS][blas] level 2 function [`dgemv`][dgemv] with the exception that this implementation works with any array type, not just Float64Arrays. Depending on the environment, the typed versions ([`dgemv`][@stdlib/blas/base/dgemv], [`sgemv`][@stdlib/blas/base/sgemv], etc.) are likely to be significantly more performant.
135135
- Both functions support array-like objects having getter and setter accessors for array element access (e.g., [`@stdlib/array/base/accessor`][@stdlib/array/base/accessor]).
136136

137137
</section>
@@ -184,11 +184,11 @@ console.log( y );
184184

185185
[blas]: http://www.netlib.org/blas
186186

187-
[ggemv]: https://netlib.org/lapack/explore-html-3.6.1/d7/d15/group__double__blas__level2_gadd421a107a488d524859b4a64c1901a9.html
187+
[dgemv]: https://netlib.org/lapack/explore-html-3.6.1/d7/d15/group__double__blas__level2_gadd421a107a488d524859b4a64c1901a9.html
188188

189189
[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
190190

191-
[@stdlib/blas/base/ggemv]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ggemv
191+
[@stdlib/blas/base/dgemv]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/dgemv
192192

193193
[@stdlib/blas/base/sgemv]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/sgemv
194194

lib/node_modules/@stdlib/blas/base/ggemv/benchmark/benchmark.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ var ggemv = require( './../lib' );
3232
// VARIABLES //
3333

3434
var options = {
35-
'dtype': 'float64'
35+
'dtype': 'generic'
3636
};
3737

3838

lib/node_modules/@stdlib/blas/base/ggemv/benchmark/benchmark.ndarray.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ var ggemv = require( './../lib' ).ndarray;
3232
// VARIABLES //
3333

3434
var options = {
35-
'dtype': 'float64'
35+
'dtype': 'generic'
3636
};
3737

3838

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ interface Routine {
5757
* ggemv( 'row-major', 'no-transpose', 2, 3, 1.0, A, 3, x, 1, 1.0, y, 1 );
5858
* // y => [ 7.0, 16.0 ]
5959
*/
60-
<T extends InputArray = InputArray>( order: Layout, trans: TransposeOperation, M: number, N: number, alpha: number, A: InputArray, LDA: number, x: InputArray, strideX: number, beta: number, y: InputArray, strideY: number ): T;
60+
<T extends InputArray = InputArray>( order: Layout, trans: TransposeOperation, M: number, N: number, alpha: number, A: InputArray, LDA: number, x: InputArray, strideX: number, beta: number, y: T, strideY: number ): T;
6161

6262
/**
6363
* Performs one of the matrix-vector operations `y = α*A*x + β*y` or `y = α*A^T*x + β*y`, using alternative indexing semantics and where `α` and `β` are scalars, `x` and `y` are vectors, and `A` is an `M` by `N` matrix.
@@ -87,7 +87,7 @@ interface Routine {
8787
* ggemv.ndarray( 'no-transpose', 2, 3, 1.0, A, 3, 1, 0, x, 1, 0, 1.0, y, 1, 0 );
8888
* // y => [ 7.0, 16.0 ]
8989
*/
90-
ndarray<T extends InputArray = InputArray>( trans: TransposeOperation, M: number, N: number, alpha: number, A: InputArray, strideA1: number, strideA2: number, offsetA: number, x: InputArray, strideX: number, offsetX: number, beta: number, y: InputArray, strideY: number, offsetY: number ): T;
90+
ndarray<T extends InputArray = InputArray>( trans: TransposeOperation, M: number, N: number, alpha: number, A: InputArray, strideA1: number, strideA2: number, offsetA: number, x: InputArray, strideX: number, offsetX: number, beta: number, y: T, strideY: number, offsetY: number ): T;
9191
}
9292

9393
/**

lib/node_modules/@stdlib/blas/base/ggemv/lib/accessors.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ function isTransposed( str ) { // TODO: consider moving to a separate helper uti
6262
* @param {NonNegativeInteger} N - number of columns in the matrix `A`
6363
* @param {number} alpha - scalar constant
6464
* @param {Object} A - output matrix object
65-
* @param {Collection} A.data - output matrix data
65+
* @param {Collection} A.data - input matrix data
6666
* @param {Array<Function>} A.accessors - array element accessors
6767
* @param {integer} strideA1 - stride of the first dimension of `A`
6868
* @param {integer} strideA2 - stride of the second dimension of `A`
@@ -78,7 +78,7 @@ function isTransposed( str ) { // TODO: consider moving to a separate helper uti
7878
* @param {Array<Function>} y.accessors - array element accessors
7979
* @param {integer} strideY - `y` stride length
8080
* @param {NonNegativeInteger} offsetY - starting index for `y`
81-
* @returns {Object} output array object
81+
* @returns {Object} second input vector object
8282
*
8383
* @example
8484
* var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' );

lib/node_modules/@stdlib/blas/base/ggemv/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@stdlib/blas/base/ggemv",
33
"version": "0.0.0",
4-
"description": "Perform one of the matrix-vector operations `y = α*A*x + β*y` or `y = α*A**T*x + β*y`.",
4+
"description": "Perform one of the matrix-vector operations `y = α*A*x + β*y` or `y = α*A^T*x + β*y`.",
55
"license": "Apache-2.0",
66
"author": {
77
"name": "The Stdlib Authors",

0 commit comments

Comments
 (0)