Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ The function has the following parameters:
- **M**: number of rows in `A`.
- **N**: number of columns in `A`.
- **A**: input matrix stored as a [`Float64Array`][mdn-float64array].
- **LDA**: stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`).
- **LDA**: stride length for the first dimension of `A` (a.k.a., leading dimension of the matrix `A`).
- **x**: search vector stored as a [`Float64Array`][mdn-float64array].
- **strideX**: stride length of `x`.
- **workspace**: workspace array stored as a [`Uint8Array`][mdn-uint8array] for tracking column match candidates. This parameter is ignored if the function is provided an input matrix stored in column-major order.
Expand Down Expand Up @@ -170,8 +170,8 @@ The function has the following parameters:
- **M**: number of rows in `A`.
- **N**: number of columns in `A`.
- **A**: input matrix stored as a [`Float64Array`][mdn-float64array].
- **strideA1**: stride of the first dimension of `A`.
- **strideA2**: stride of the second dimension of `A`.
- **strideA1**: stride length for the first dimension of `A`.
- **strideA2**: stride length for the second dimension of `A`.
- **offsetA**: starting index for `A`.
- **x**: search vector stored as a [`Float64Array`][mdn-float64array].
- **strideX**: stride length of `x`.
Expand Down Expand Up @@ -299,7 +299,7 @@ The function accepts the following arguments:
- **M**: `[in] CBLAS_INT` number of rows in `A`.
- **N**: `[in] CBLAS_INT` number of columns in `A`.
- **A**: `[in] double*` input matrix.
- **LDA**: `[in] CBLAS_INT` stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`).
- **LDA**: `[in] CBLAS_INT` stride length for the first dimension of `A` (a.k.a., leading dimension of the matrix `A`).
- **X**: `[in] double*` search vector.
- **strideX**: `[in] CBLAS_INT` stride length for `X`.
- **workspace**: `[inout] uint8_t*` workspace array for tracking column match candidates. This parameter is ignored if the function is provided an input matrix stored in column-major order.
Expand Down Expand Up @@ -345,8 +345,8 @@ The function accepts the following arguments:
- **M**: `[in] CBLAS_INT` number of rows in `A`.
- **N**: `[in] CBLAS_INT` number of columns in `A`.
- **A**: `[in] double*` input matrix.
- **strideA1**: `[in] CBLAS_INT` stride of the first dimension of `A`.
- **strideA2**: `[in] CBLAS_INT` stride of the second dimension of `A`.
- **strideA1**: `[in] CBLAS_INT` stride length for the first dimension of `A`.
- **strideA2**: `[in] CBLAS_INT` stride length for the second dimension of `A`.
- **offsetA**: `[in] CBLAS_INT` starting index for `A`.
- **X**: `[in] double*` search vector.
- **strideX**: `[in] CBLAS_INT` stride length for `X`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@
Input matrix `A`.

LDA: integer
Stride of the first dimension of `A` (a.k.a., leading dimension of the
matrix `A`).
Stride length for the first dimension of `A` (a.k.a., leading dimension
of the matrix `A`).

x: Float64Array
Search vector.
Expand Down Expand Up @@ -79,10 +79,10 @@
Input matrix `A`.

sa1: integer
Stride of the first dimension of `A`.
Stride length for the first dimension of `A`.

sa2: integer
Stride of the second dimension of `A`.
Stride length for the second dimension of `A`.

oa: integer
Starting index for `A`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ interface Routine {
* @param M - number of rows in `A`
* @param N - number of columns in `A`
* @param A - input matrix
* @param LDA - stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`)
* @param LDA - stride length for the first dimension of `A` (a.k.a., leading dimension of the matrix `A`)
* @param x - search vector
* @param strideX - stride length for `x`
* @param workspace - workspace array for tracking column match candidates
Expand Down Expand Up @@ -69,8 +69,8 @@ interface Routine {
* @param M - number of rows in `A`
* @param N - number of columns in `A`
* @param A - input matrix
* @param strideA1 - stride of the first dimension of `A`
* @param strideA2 - stride of the second dimension of `A`
* @param strideA1 - stride length for the first dimension of `A`
* @param strideA2 - stride length for the second dimension of `A`
* @param offsetA - starting index for `A`
* @param x - search vector
* @param strideX - stride length for `x`
Expand Down Expand Up @@ -106,7 +106,7 @@ interface Routine {
* @param M - number of rows in `A`
* @param N - number of columns in `A`
* @param A - input matrix
* @param LDA - stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`)
* @param LDA - stride length for the first dimension of `A` (a.k.a., leading dimension of the matrix `A`)
* @param x - search vector
* @param strideX - stride length for `x`
* @param workspace - workspace array for tracking column match candidates
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ var ndarray = require( './ndarray.js' );
* @param {PositiveInteger} M - number of rows in `A`
* @param {PositiveInteger} N - number of columns in `A`
* @param {Float64Array} A - input matrix
* @param {integer} LDA - stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`)
* @param {integer} LDA - stride length for the first dimension of `A` (a.k.a., leading dimension of the matrix `A`)
* @param {Float64Array} x - search vector
* @param {integer} strideX - stride length for `x`
* @param {Uint8Array} workspace - workspace array for tracking column match candidates
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ var addon = require( './../src/addon.node' );
* @param {PositiveInteger} M - number of rows in `A`
* @param {PositiveInteger} N - number of columns in `A`
* @param {Float64Array} A - input matrix
* @param {integer} LDA - stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`)
* @param {integer} LDA - stride length for the first dimension of `A` (a.k.a., leading dimension of the matrix `A`)
* @param {Float64Array} x - search vector
* @param {integer} strideX - stride length for `x`
* @param {Uint8Array} workspace - workspace array for tracking column match candidates
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ var isColumnMajor = require( '@stdlib/ndarray/base/assert/is-column-major' );
* @param {PositiveInteger} M - number of rows in `A`
* @param {PositiveInteger} N - number of columns in `A`
* @param {Float64Array} A - input matrix
* @param {integer} strideA1 - stride of the first dimension of `A`
* @param {integer} strideA2 - stride of the second dimension of `A`
* @param {integer} strideA1 - stride length for the first dimension of `A`
* @param {integer} strideA2 - stride length for the second dimension of `A`
* @param {NonNegativeInteger} offsetA - starting index for `A`
* @param {Float64Array} x - search vector
* @param {integer} strideX - stride length for `x`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ var addon = require( './../src/addon.node' );
* @param {PositiveInteger} M - number of rows in `A`
* @param {PositiveInteger} N - number of columns in `A`
* @param {Float64Array} A - input matrix
* @param {integer} strideA1 - stride of the first dimension of `A`
* @param {integer} strideA2 - stride of the second dimension of `A`
* @param {integer} strideA1 - stride length for the first dimension of `A`
* @param {integer} strideA2 - stride length for the second dimension of `A`
* @param {NonNegativeInteger} offsetA - starting index for `A`
* @param {Float64Array} x - search vector
* @param {integer} strideX - stride length for `x`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
* @param M number of rows in `A`
* @param N number of columns in `A`
* @param A input matrix
* @param LDA stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`)
* @param LDA stride length for the first dimension of `A` (a.k.a., leading dimension of the matrix `A`)
* @param X search vector
* @param strideX stride length for `X`
* @param workspace workspace array for tracking column match candidates
Expand Down Expand Up @@ -59,8 +59,8 @@ CBLAS_INT API_SUFFIX(stdlib_strided_dindex_of_column)( const CBLAS_LAYOUT order,
* @param M number of rows in `A`
* @param N number of columns in `A`
* @param A input matrix
* @param strideA1 stride of the first dimension of `A`
* @param strideA2 stride of the second dimension of `A`
* @param strideA1 stride length for the first dimension of `A`
* @param strideA2 stride length for the second dimension of `A`
* @param offsetA starting index for `A`
* @param X search vector
* @param strideX stride length for `X`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ var ndarray = require( './ndarray.js' );
* @param {Collection} workspace - workspace array for tracking row match candidates
* @param {integer} strideW - stride length for `workspace`
* @throws {TypeError} first argument must be a valid order
* @throws {RangeError} fifth argument must be a valid stride
* @throws {RangeError} fifth argument must be greater than or equal to max(1,N)
* @returns {integer} row index
*
* @example
Expand All @@ -73,7 +73,7 @@ function glastIndexOfRow( order, M, N, A, LDA, x, strideX, workspace, strideW )
s = M;
}
if ( LDA < max( 1, s ) ) {
throw new RangeError( format( 'invalid argument. Fifth argument must be a valid stride. Value: `%d`.', LDA ) );
throw new RangeError( format( 'invalid argument. Fifth argument must be greater than or equal to max(1,%d). Value: `%d`.', s, LDA ) );
}
if ( isColumnMajor( order ) ) {
sa1 = 1;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ var ndarray = require( './ndarray.js' );
* @param {Uint8Array} workspace - workspace array for tracking row match candidates
* @param {integer} strideW - stride length for `workspace`
* @throws {TypeError} first argument must be a valid order
* @throws {RangeError} fifth argument must be a valid stride
* @throws {RangeError} fifth argument must be greater than or equal to max(1,N)
* @returns {integer} row index
*
* @example
Expand All @@ -76,7 +76,7 @@ function slastIndexOfRow( order, M, N, A, LDA, x, strideX, workspace, strideW )
s = M;
}
if ( LDA < max( 1, s ) ) {
throw new RangeError( format( 'invalid argument. Fifth argument must be a valid stride. Value: `%d`.', LDA ) );
throw new RangeError( format( 'invalid argument. Fifth argument must be greater than or equal to max(1,%d). Value: `%d`.', s, LDA ) );
}
if ( isColumnMajor( order ) ) {
sa1 = 1;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ var addon = require( './../src/addon.node' );
* @param {Uint8Array} workspace - workspace array for tracking row match candidates
* @param {integer} strideW - stride length for `workspace`
* @throws {TypeError} first argument must be a valid order
* @throws {RangeError} fifth argument must be a valid stride
* @throws {RangeError} fifth argument must be greater than or equal to max(1,N)
* @returns {integer} row index
*
* @example
Expand All @@ -68,7 +68,7 @@ function slastIndexOfRow( order, M, N, A, LDA, x, strideX, workspace, strideW )
s = M;
}
if ( LDA < max( 1, s ) ) {
throw new RangeError( format( 'invalid argument. Fifth argument must be a valid stride. Value: `%d`.', LDA ) );
throw new RangeError( format( 'invalid argument. Fifth argument must be greater than or equal to max(1,%d). Value: `%d`.', s, LDA ) );
}
return addon( resolveOrder( order ), M, N, A, LDA, x, strideX, workspace, strideW ); // eslint-disable-line max-len
}
Expand Down
Loading