All files / base/gindex-of-truthy-row/lib ndarray.js

59.64% Statements 68/114
100% Branches 1/1
0% Functions 0/1
59.64% Lines 68/114

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 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 1151x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x                                                                                             1x 1x 1x 1x 1x  
/**
* @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 arraylike2object = require( '@stdlib/array/base/arraylike2object' );
var gany = require( '@stdlib/blas/ext/base/gany' ).ndarray;
var isRowMajor = require( '@stdlib/ndarray/base/assert/is-row-major' );
var accessors = require( './accessors.js' );
 
 
// MAIN //
 
/**
* Returns the index of the first row in an input matrix which contains at least one truthy element.
*
* ## Notes
*
* -   If the function is provided an empty matrix or if the function is unable to find a row with at least one truthy element, the function returns `-1` (i.e., an invalid index).
*
* @param {PositiveInteger} M - number of rows in `A`
* @param {PositiveInteger} N - number of columns in `A`
* @param {Collection} A - input matrix
* @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`
* @returns {integer} row index
*
* @example
* var A = [ 0.0, 0.0, 0.0, 0.0, 1.0, 0.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 0.0, 0.0, 0.0, 0.0 ]; // => [ [ 0.0, 0.0, 0.0, 0.0 ], [ 1.0, 0.0, 1.0, 1.0 ], [ 1.0, 1.0, 1.0, 1.0 ], [ 0.0, 0.0, 0.0, 0.0 ] ]
*
* var out = gindexOfTruthyRow( 4, 4, A, 4, 1, 0 );
* // returns 1
*
* @example
* var A = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]; // => [ [ 0.0, 0.0 ], [ 0.0, 0.0 ], [ 0.0, 0.0 ], [ 0.0, 0.0 ] ]
*
* var out = gindexOfTruthyRow( 4, 2, A, 2, 1, 0 );
* // returns -1
*
* @example
* var A = [ 0.0, 0.0, 0.0, 1.0, 1.0, 1.0, 0.0, 0.0 ]; // => [ [ 0.0, 0.0 ], [ 0.0, 1.0 ], [ 1.0, 1.0 ], [ 0.0, 0.0 ] ]
*
* var out = gindexOfTruthyRow( 4, 2, A, 2, 1, 0 );
* // returns 1
*/
function gindexOfTruthyRow( M, N, A, strideA1, strideA2, offsetA ) {
	var ia;
	var j;
	var i;
	var k;
	var o;

	// Check whether the matrix is an empty matrix...
	if ( M <= 0 || N <= 0 ) {
		return -1;
	}
	// Row-major: iterate across rows
	if ( isRowMajor( [ strideA1, strideA2 ] ) ) {
		ia = offsetA;
		for ( i = 0; i < M; i++ ) {
			if ( gany( N, A, strideA2, ia ) ) {
				return i;
			}
			ia += strideA1;
		}
		return -1;
	}
	// Column-major: iterate down columns
	o = arraylike2object( A );
	if ( o.accessorProtocol ) {
		return accessors( M, N, o, strideA1, strideA2, offsetA );
	}
	i = M;
	for ( j = 0; j < N; j++ ) {
		ia = offsetA + ( j*strideA2 );
		for ( k = 0; k < i; k++ ) {
			if ( A[ ia ] ) {
				i = k;
				break;
			}
			ia += strideA1;
		}
		if ( i === 0 ) {
			return 0;
		}
	}
	if ( i < M ) {
		return i;
	}
	return -1;
}
 
 
// EXPORTS //
 
module.exports = gindexOfTruthyRow;