All files / base/gtriu2tril/lib main.js

61.68% Statements 66/107
100% Branches 1/1
0% Functions 0/1
61.68% Lines 66/107

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 1081x 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 resolveLayout = require( '@stdlib/blas/base/layout-resolve-str' );
var isRowMajor = require( '@stdlib/ndarray/base/assert/is-row-major-string' );
var max = require( '@stdlib/math/base/special/fast/max' );
var format = require( '@stdlib/string/format' );
var base = require( './base.js' );
 
 
// MAIN //
 
/**
* Reflects the upper triangular part of a matrix `A` into the lower triangular part of another matrix `B`.
*
* @param {(integer|string)} order - storage layout of `A` and `B`
* @param {NonNegativeInteger} M - number of rows in matrix `A`
* @param {NonNegativeInteger} N - number of columns in matrix `A`
* @param {integer} k - diagonal below which to ignore
* @param {Collection} A - input matrix
* @param {PositiveInteger} LDA - stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`)
* @param {Collection} B - output matrix
* @param {PositiveInteger} LDB - stride of the first dimension of `B` (a.k.a., leading dimension of the matrix `B`)
* @throws {TypeError} first argument must be a valid order
* @throws {RangeError} sixth argument must be a valid stride
* @throws {RangeError} eighth argument must be a valid stride
* @returns {Collection} `B`
*
* @example
* var A = [ 1.0, 2.0, 3.0, 4.0 ];
* var B = [ 0.0, 0.0, 0.0, 0.0 ];
*
* gtriu2tril( 'row-major', 2, 2, 0, A, 2, B, 2 );
* // B => [ 1.0, 0.0, 2.0, 4.0 ]
*
* @example
* var A = [ 1.0, 2.0, 3.0, 4.0 ];
* var B = [ 0.0, 0.0, 0.0, 0.0 ];
*
* gtriu2tril( 'row-major', 2, 2, 1, A, 2, B, 2 );
* // B => [ 0.0, 0.0, 2.0, 0.0 ]
*/
function gtriu2tril( order, M, N, k, A, LDA, B, LDB ) {
	var isrm;
	var sa1;
	var sa2;
	var sb1;
	var sb2;
	var sa;
	var sb;
	var l;

	l = resolveLayout( order );
	if ( l === null ) {
		throw new TypeError( format( 'invalid argument. First argument must be a valid order. Value: `%s`.', order ) );
	}
	isrm = isRowMajor( l );
	if ( isrm ) {
		sa = N; // A (M x N) has N columns
		sb = M; // B (N x M) has M columns
	} else {
		sa = M; // A (M x N) has M rows
		sb = N; // B (N x M) has N rows
	}
	if ( LDA < max( 1, sa ) ) {
		throw new RangeError( format( 'invalid argument. Sixth argument must be greater than or equal to max(1,%d). Value: `%d`.', sa, LDA ) );
	}
	if ( LDB < max( 1, sb ) ) {
		throw new RangeError( format( 'invalid argument. Eighth argument must be greater than or equal to max(1,%d). Value: `%d`.', sb, LDB ) );
	}
	if ( isrm ) {
		sa1 = LDA;
		sa2 = 1;
		sb1 = LDB;
		sb2 = 1;
	} else { // order === 'column-major'
		sa1 = 1;
		sa2 = LDA;
		sb1 = 1;
		sb2 = LDB;
	}
	return base( M, N, k, A, sa1, sa2, 0, B, sb1, sb2, 0 );
}
 
 
// EXPORTS //
 
module.exports = gtriu2tril;