All files / strides/lib main.js

70.66% Statements 53/75
100% Branches 1/1
0% Functions 0/1
70.66% Lines 53/75

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 761x 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) 2023 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 isString = require( '@stdlib/assert/is-string' ).isPrimitive;
var shape2strides = require( '@stdlib/ndarray/base/shape2strides' );
var defaults = require( '@stdlib/ndarray/defaults' );
var copyIndexed = require( '@stdlib/array/base/copy-indexed' );
 
 
// VARIABLES //
 
var DEFAULT_ORDER = defaults.get( 'order' );
 
 
// MAIN //
 
/**
* Returns the strides of a provided ndarray.
*
* @param {ndarrayLike} x - input ndarray
* @param {boolean} copy - boolean indicating whether to explicitly copy the value assigned to the input ndarray's `strides` property
* @returns {IntegerArray} strides
*
* @example
* var zeros = require( '@stdlib/ndarray/zeros' );
*
* var out = strides( zeros( [ 3, 3, 3 ] ), false );
* // returns [ 9, 3, 1 ]
*/
function strides( x, copy ) {
	var ord;
	var sh;
	var st;

	st = x.strides;
	if ( typeof st !== 'object' || st === null ) {
		sh = x.shape;
		if ( sh.length === 0 ) {
			return [ 0 ];
		}
		ord = x.order;
		if ( !isString( ord ) ) {
			ord = DEFAULT_ORDER;
		}
		return shape2strides( sh, ord );
	}
	if ( copy ) {
		return copyIndexed( st );
	}
	return st;
}
 
 
// EXPORTS //
 
module.exports = strides;