All files main.js

100% Statements 156/156
100% Branches 36/36
100% Functions 1/1
100% Lines 156/156

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 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 1572x 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 2x 2x 2x 2x 2x 73x 73x 73x 73x 73x 73x 73x 73x 73x 73x 73x 73x 73x 73x 73x 73x 8x 8x 65x 73x 8x 8x 57x 73x 8x 8x 73x 6x 6x 73x 6x 6x 37x 37x 37x 73x 12x 73x 29x 73x 8x 8x 37x 73x 12x 73x 29x 73x 8x 8x 73x 4x 4x 73x 4x 4x 73x 21x 73x 8x 8x 73x 4x 4x 73x 8x 8x 8x 8x 8x 8x 73x 17x 17x 17x 17x 17x 17x 17x 25x 73x 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.
*/
 
/* eslint-disable max-len, max-params */
 
'use strict';
 
// MODULES //
 
var max = require( '@stdlib/math/base/special/fast/max' );
var isLayout = require( '@stdlib/blas/base/assert/is-layout' );
var resolveStr = require( '@stdlib/blas/base/transpose-operation-resolve-str' );
var isRowMajor = require( '@stdlib/ndarray/base/assert/is-row-major-string' );
var isColumnMajor = require( '@stdlib/ndarray/base/assert/is-column-major-string' );
var format = require( '@stdlib/string/format' );
var base = require( './base.js' );
 
 
// MAIN //
 
/**
* Takes rows from one of two input matrices depending on a condition.
*
* @param {string} order - storage layout
* @param {(integer|string)} transA - specifies whether `A` should be transposed or not transposed
* @param {(integer|string)} transB - specifies whether `B` should be transposed or not transposed
* @param {NonNegativeInteger} M - number of indexed elements in `condition` and number of rows in `op(A)`, `op(B)`, and `out`
* @param {NonNegativeInteger} N - number of columns in `op(A)`, `op(B)` and `out`
* @param {Collection} condition - condition array
* @param {integer} strideC - stride length for `condition`
* @param {Collection} A - first input matrix
* @param {PositiveInteger} LDA - stride length for the first dimension of `A` (a.k.a., leading dimension of the matrix `A`)
* @param {Collection} B - second input matrix
* @param {PositiveInteger} LDB - stride length for the first dimension of `B` (a.k.a., leading dimension of the matrix `B`)
* @param {Collection} out - output matrix
* @param {PositiveInteger} LDO - stride length for the first dimension of `out` (a.k.a., leading dimension of the output matrix)
* @throws {TypeError} first argument must be a valid order
* @throws {TypeError} second argument must be a valid transpose operation
* @throws {TypeError} third argument must be a valid transpose operation
* @throws {RangeError} fourth argument must be a nonnegative integer
* @throws {RangeError} fifth argument must be a nonnegative integer
* @throws {RangeError} ninth argument must be greater than or equal to max(1,M) when `A` is not transposed and max(1,N) otherwise
* @throws {RangeError} eleventh argument must be greater than or equal to max(1,M) when `B` is not transposed and max(1,N) otherwise
* @throws {RangeError} thirteenth argument must be greater than or equal to max(1,N)
* @returns {Collection} output matrix
*
* @example
* var A = [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ];
* var B = [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ];
* var condition = [ 1, 0 ];
* var out = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];
*
* gwhereRows( 'row-major', 'no-transpose', 'no-transpose', 2, 3, condition, 1, A, 3, B, 3, out, 3 );
* // out => [ 1.0, 2.0, 3.0, 10.0, 11.0, 12.0 ]
*/
function gwhereRows( order, transA, transB, M, N, condition, strideC, A, LDA, B, LDB, out, LDO ) {
	var nrowsa;
	var nrowsb;
	var valout;
	var isrm;
	var iscm;
	var sa1;
	var sa2;
	var sb1;
	var sb2;
	var so1;
	var so2;
	var ta;
	var tb;
 
	if ( !isLayout( order ) ) {
		throw new TypeError( format( 'invalid argument. First argument must be a valid order. Value: `%s`.', order ) );
	}
	ta = resolveStr( transA );
	if ( ta === null ) {
		throw new TypeError( format( 'invalid argument. Second argument must be a valid transpose operation. Value: `%s`.', transA ) );
	}
	tb = resolveStr( transB );
	if ( tb === null ) {
		throw new TypeError( format( 'invalid argument. Third argument must be a valid transpose operation. Value: `%s`.', transB ) );
	}
	if ( M < 0 ) {
		throw new RangeError( format( 'invalid argument. Fourth argument must be a nonnegative integer. Value: `%d`.', M ) );
	}
	if ( N < 0 ) {
		throw new RangeError( format( 'invalid argument. Fifth argument must be a nonnegative integer. Value: `%d`.', N ) );
	}
	isrm = isRowMajor( order );
	iscm = isColumnMajor( order );
	if (
		( isrm && transA === 'no-transpose' ) ||
		( iscm && transA === 'transpose' )
	) {
		nrowsa = N;
	} else {
		nrowsa = M;
	}
	if (
		( isrm && transB === 'no-transpose' ) ||
		( iscm && transB === 'transpose' )
	) {
		nrowsb = N;
	} else {
		nrowsb = M;
	}
	if ( LDA < max( 1, nrowsa ) ) {
		throw new RangeError( format( 'invalid argument. Ninth argument must be greater than or equal to max(1,%d). Value: `%d`.', nrowsa, LDA ) );
	}
	if ( LDB < max( 1, nrowsb ) ) {
		throw new RangeError( format( 'invalid argument. Eleventh argument must be greater than or equal to max(1,%d). Value: `%d`.', nrowsb, LDB ) );
	}
	if ( isrm ) {
		valout = N;
	} else {
		valout = M;
	}
	if ( LDO < max( 1, valout ) ) {
		throw new RangeError( format( 'invalid argument. Thirteenth argument must be greater than or equal to max(1,%d). Value: `%d`.', valout, LDO ) );
	}
	if ( iscm ) {
		sa1 = 1;
		sa2 = LDA;
		sb1 = 1;
		sb2 = LDB;
		so1 = 1;
		so2 = LDO;
	} else { // order === 'row-major'
		sa1 = LDA;
		sa2 = 1;
		sb1 = LDB;
		sb2 = 1;
		so1 = LDO;
		so2 = 1;
	}
	return base( ta, tb, M, N, condition, strideC, 0, A, sa1, sa2, 0, B, sb1, sb2, 0, out, so1, so2, 0 );
}
 
 
// EXPORTS //
 
module.exports = gwhereRows;