All files main.js

100% Statements 94/94
100% Branches 9/9
100% Functions 1/1
100% Lines 94/94

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 952x 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 2x 2x 33x 33x 33x 33x 33x 33x 33x 33x 13x 13x 33x 12x 12x 12x 33x 8x 8x 8x 8x 33x 4x 4x 16x 33x 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 isRowMajor = require( '@stdlib/ndarray/base/assert/is-row-major-string' );
var resolveLayout = require( '@stdlib/blas/base/layout-resolve-str' );
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 first column in an input matrix in which all elements are falsy.
*
* ## Notes
*
* -   If the function is provided an empty matrix or if the function is unable to find a column in which all elements are falsy, the function returns `-1` (i.e., an invalid index).
*
* @param {(integer|string)} order - storage layout
* @param {PositiveInteger} M - number of rows in `A`
* @param {PositiveInteger} N - number of columns in `A`
* @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`)
* @throws {TypeError} first argument must be a valid order
* @throws {RangeError} fifth argument must be a valid stride length
* @returns {integer} column index
*
* @example
* var A = [ 1.0, 0.0, 1.0, 1.0, 1.0, 0.0, 1.0, 1.0, 1.0, 0.0, 1.0, 1.0, 1.0, 0.0, 1.0, 1.0 ]; // => [ [ 1.0, 0.0, 1.0, 1.0 ], [ 1.0, 0.0, 1.0, 1.0 ], [ 1.0, 0.0, 1.0, 1.0 ], [ 1.0, 0.0, 1.0, 1.0 ] ]
*
* var out = gindexOfFalsyColumn( 'row-major', 4, 4, A, 4 );
* // returns 1
*
* @example
* var A = [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ]; // => [ [ 1.0, 1.0, 1.0, 1.0 ], [ 1.0, 1.0, 1.0, 1.0 ] ]
*
* var out = gindexOfFalsyColumn( 'row-major', 2, 4, A, 4 );
* // returns -1
*
* @example
* var A = [ 1.0, 0.0, 1.0, 1.0, 1.0, 0.0, 1.0, 1.0 ]; // => [ [ 1.0, 0.0, 1.0, 1.0 ], [ 1.0, 0.0, 1.0, 1.0 ] ]
*
* var out = gindexOfFalsyColumn( 'row-major', 2, 4, A, 4 );
* // returns 1
*/
function gindexOfFalsyColumn( order, M, N, A, LDA ) {
	var sa1;
	var sa2;
	var s;
	var l;
 
	l = resolveLayout( order );
	if ( l === null ) {
		throw new TypeError( format( 'invalid argument. First argument must be a valid order. Value: `%s`.', order ) );
	}
	if ( isRowMajor( l ) ) {
		s = N;
		sa1 = LDA;
		sa2 = 1;
	} else { // order === 'column-major'
		s = M;
		sa1 = 1;
		sa2 = LDA;
	}
	if ( LDA < max( 1, s ) ) {
		throw new RangeError( format( 'invalid argument. Fifth argument must be greater than or equal to max(1,%d). Value: `%d`.', s, LDA ) );
	}
	return ndarray( M, N, A, sa1, sa2, 0 );
}
 
 
// EXPORTS //
 
module.exports = gindexOfFalsyColumn;