Skip to content

Commit d479058

Browse files
committed
docs: update descriptions
--- 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: na - task: lint_repl_help status: passed - 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 c16f303 commit d479058

4 files changed

Lines changed: 15 additions & 15 deletions

File tree

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,12 +55,12 @@ The function has the following parameters:
5555
- **K**: number of columns in the matrix `op(A)` and number of rows in the matrix `op(B)`.
5656
- **α**: scalar constant.
5757
- **A**: first input matrix stored in linear memory as a [`Float64Array`][mdn-float64array].
58-
- **lda**: stride of the first dimension of `A` (leading dimension of `A`).
58+
- **lda**: stride between successive contiguous vectors of the matrix `A` (a.k.a., leading dimension of `A`).
5959
- **B**: second input matrix stored in linear memory as a [`Float64Array`][mdn-float64array].
60-
- **ldb**: stride of the first dimension of `B` (leading dimension of `B`).
60+
- **ldb**: stride between successive contiguous vectors of the matrix `B` (a.k.a., leading dimension of `B`).
6161
- **β**: scalar constant.
6262
- **C**: third input matrix stored in linear memory as a [`Float64Array`][mdn-float64array].
63-
- **ldc**: stride of the first dimension of `C` (leading dimension of `C`).
63+
- **ldc**: stride between successive contiguous vectors of the matrix `C` (a.k.a., leading dimension of `C`).
6464

6565
The stride parameters determine how elements in the input arrays are accessed at runtime. For example, to perform matrix multiplication of two subarrays
6666

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,15 +43,15 @@
4343
First matrix.
4444

4545
lda: integer
46-
Stride of the first dimension of `A` (a.k.a., leading dimension of the
47-
matrix `A`).
46+
Stride between successive contiguous vectors of the matrix `A` (a.k.a.,
47+
leading dimension of the matrix `A`).
4848

4949
B: Float64Array
5050
Second matrix.
5151

5252
ldb: integer
53-
Stride of the first dimension of `B` (a.k.a., leading dimension of the
54-
matrix `B`).
53+
Stride between successive contiguous vectors of the matrix `B` (a.k.a.,
54+
leading dimension of the matrix `B`).
5555

5656
β: number
5757
Scalar constant.
@@ -60,8 +60,8 @@
6060
Third matrix.
6161

6262
ldc: integer
63-
Stride of the first dimension of `C` (a.k.a., leading dimension of the
64-
matrix `C`).
63+
Stride between successive contiguous vectors of the matrix `C` (a.k.a.,
64+
leading dimension of the matrix `C`).
6565

6666
Returns
6767
-------

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,12 @@ interface Routine {
3737
* @param K - number of columns in the matrix `op(A)` and number of rows in the matrix `op(B)`
3838
* @param alpha - scalar constant
3939
* @param A - first matrix
40-
* @param LDA - stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`)
40+
* @param LDA - stride between successive contiguous vectors of the matrix `A` (a.k.a., leading dimension of the matrix `A`)
4141
* @param B - second matrix
42-
* @param LDB - stride of the first dimension of `B` (a.k.a., leading dimension of the matrix `B`)
42+
* @param LDB - stride between successive contiguous vectors of the matrix `B` (a.k.a., leading dimension of the matrix `B`)
4343
* @param beta - scalar constant
4444
* @param C - third matrix
45-
* @param LDC - stride of the first dimension of `C` (a.k.a., leading dimension of the matrix `C`)
45+
* @param LDC - stride between successive contiguous vectors of the matrix `C` (a.k.a., leading dimension of the matrix `C`)
4646
* @returns `C`
4747
*
4848
* @example

lib/node_modules/@stdlib/blas/base/dgemm/lib/dgemm.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,12 @@ var base = require( './base.js' );
4242
* @param {NonNegativeInteger} K - number of columns in the matrix `op(A)` and number of rows in the matrix `op(B)`
4343
* @param {number} alpha - scalar constant
4444
* @param {Float64Array} A - first matrix
45-
* @param {PositiveInteger} LDA - stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`)
45+
* @param {PositiveInteger} LDA - stride between successive contiguous vectors of the matrix `A` (a.k.a., leading dimension of the matrix `A`)
4646
* @param {Float64Array} B - second matrix
47-
* @param {PositiveInteger} LDB - stride of the first dimension of `B` (a.k.a., leading dimension of the matrix `B`)
47+
* @param {PositiveInteger} LDB - stride between successive contiguous vectors of the matrix `B` (a.k.a., leading dimension of the matrix `B`)
4848
* @param {number} beta - scalar constant
4949
* @param {Float64Array} C - third matrix
50-
* @param {PositiveInteger} LDC - stride of the first dimension of `C` (a.k.a., leading dimension of the matrix `C`)
50+
* @param {PositiveInteger} LDC - stride between successive contiguous vectors of the matrix `C` (a.k.a., leading dimension of the matrix `C`)
5151
* @throws {TypeError} first argument must be a valid order
5252
* @throws {TypeError} second argument must be a valid transpose operation
5353
* @throws {TypeError} third argument must be a valid transpose operation

0 commit comments

Comments
 (0)