All files / striu/lib main.js

78.16% Statements 68/87
100% Branches 1/1
0% Functions 0/1
78.16% Lines 68/87

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 881x 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 ndarraylike2scalar = require( '@stdlib/ndarray/base/ndarraylike2scalar' );
var getShape = require( '@stdlib/ndarray/base/shape' );
var getStrides = require( '@stdlib/ndarray/base/strides' );
var getOffset = require( '@stdlib/ndarray/base/offset' );
var getData = require( '@stdlib/ndarray/base/data-buffer' );
var strided = require( '@stdlib/blas/ext/base/striu' ).ndarray;
 
 
// MAIN //
 
/**
* Copies the upper triangular part of a single-precision floating-point matrix `A` to another matrix `B`.
*
* ## Notes
*
* -   The function expects the following ndarrays:
*
*     -   a two-dimensional input ndarray corresponding to `A`.
*     -   a two-dimensional output ndarray corresponding to `B`.
*     -   a zero-dimensional ndarray specifying the diagonal below which to ignore.
*
* @param {ArrayLikeObject<Object>} arrays - array-like object containing ndarrays
* @returns {Object} output ndarray
*
* @example
* var Float32Matrix = require( '@stdlib/ndarray/matrix/float32' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
*
* var A = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] );
* var B = new Float32Matrix( [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] );
*
* var k = scalar2ndarray( 0, {
*     'dtype': 'generic'
* });
*
* var out = striu( [ A, B, k ] );
* // returns <ndarray>[ [ 1.0, 2.0 ], [ 0.0, 4.0 ] ]
*
* var bool = ( out === B );
* // returns true
*/
function striu( arrays ) {
	var sh;
	var sa;
	var sb;
	var A;
	var B;
	var k;

	A = arrays[ 0 ];
	B = arrays[ 1 ];
	k = ndarraylike2scalar( arrays[ 2 ] );

	sh = getShape( A, false );
	sa = getStrides( A, false );
	sb = getStrides( B, false );

	strided( sh[ 0 ], sh[ 1 ], k, getData( A ), sa[ 0 ], sa[ 1 ], getOffset( A ), getData( B ), sb[ 0 ], sb[ 1 ], getOffset( B ) ); // eslint-disable-line max-len
	return B;
}
 
 
// EXPORTS //
 
module.exports = striu;