All files main.js

100% Statements 92/92
100% Branches 12/12
100% Functions 1/1
100% Lines 92/92

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 932x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 37x 37x 37x 37x 37x 13x 13x 37x 14x 37x 10x 10x 37x 4x 4x 37x 8x 8x 37x 12x 12x 12x 20x 37x 2x 2x 2x 2x 2x  
/**
* @license Apache-2.0
*
* Copyright (c) 2026 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
 
'use strict';
 
// MODULES //
 
var isLayout = require( '@stdlib/blas/base/assert/is-layout' );
var isRowMajor = require( '@stdlib/ndarray/base/assert/is-row-major-string' );
var isColumnMajor = require( '@stdlib/ndarray/base/assert/is-column-major-string' );
var stride2offset = require( '@stdlib/strided/base/stride2offset' );
var max = require( '@stdlib/math/base/special/fast/max' );
var format = require( '@stdlib/string/format' );
var ndarray = require( './ndarray.js' );
 
 
// MAIN //
 
/**
* Returns the index of the n-th row in an input matrix which has the same elements as a provided search vector.
*
* ## Notes
*
* -   If the function is provided an empty matrix, if `k` is less than or equal to zero, or if the function is unable to find the n-th matching row, the function returns `-1` (i.e., an invalid index).
* -   The `workspace` array is only applicable when an input matrix is stored in column-major order. When the matrix is stored in row-major order, the workspace array is ignored.
*
* @param {string} order - storage layout
* @param {PositiveInteger} M - number of rows in `A`
* @param {PositiveInteger} N - number of columns in `A`
* @param {PositiveInteger} k - occurrence number
* @param {Collection} A - input matrix
* @param {integer} LDA - stride length for the first dimension of `A` (a.k.a., leading dimension of the matrix `A`)
* @param {Collection} x - search vector
* @param {integer} strideX - stride length for `x`
* @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} sixth argument must be a valid stride
* @returns {integer} row index
*
* @example
* var A = [ 1.0, 2.0, 3.0, 4.0, 3.0, 4.0, 0.0, 0.0 ]; // => [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 3.0, 4.0 ], [ 0.0, 0.0 ] ]
* var x = [ 3.0, 4.0 ];
* var workspace = [ 0, 0, 0, 0 ];
*
* var out = gnthIndexOfRow( 'row-major', 4, 2, 2, A, 2, x, 1, workspace, 1 );
* // returns 2
*/
function gnthIndexOfRow( order, M, N, k, A, LDA, x, strideX, workspace, strideW ) { // eslint-disable-line max-len
	var sa1;
	var sa2;
	var s;
	if ( !isLayout( order ) ) {
		throw new TypeError( format( 'invalid argument. First argument must be a valid order. Value: `%s`.', order ) );
	}
	if ( isRowMajor( order ) ) {
		s = N;
	} else {
		s = M;
	}
	if ( LDA < max( 1, s ) ) {
		throw new RangeError( format( 'invalid argument. Sixth argument must be greater than or equal to max(1,%d). Value: `%d`.', s, LDA ) );
	}
	if ( isColumnMajor( order ) ) {
		sa1 = 1;
		sa2 = LDA;
	} else { // order === 'row-major'
		sa1 = LDA;
		sa2 = 1;
	}
	return ndarray( M, N, k, A, sa1, sa2, 0, x, strideX, stride2offset( N, strideX ), workspace, strideW, stride2offset( M, strideW ) ); // eslint-disable-line max-len
}
 
 
// EXPORTS //
 
module.exports = gnthIndexOfRow;