All files / shape2strides/lib main.js

63.72% Statements 65/102
100% Branches 1/1
0% Functions 0/3
63.72% Lines 65/102

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 1031x 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) 2018 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 isColumnMajor = require( '@stdlib/ndarray/base/assert/is-column-major-string' );
 
 
// FUNCTIONS //
 
/**
* Generates a stride array from an array shape (row-major).
*
* @private
* @param {NonNegativeIntegerArray} shape - array shape
* @returns {Array} array strides
*/
function rowmajor( shape ) {
	var ndims;
	var out;
	var s;
	var i;

	ndims = shape.length;
	out = [];
	for ( i = 0; i < ndims; i++ ) {
		out.push( 0 );
	}
	s = 1;
	for ( i = ndims-1; i >= 0; i-- ) {
		out[ i ] = s;
		s *= shape[ i ];
	}
	return out;
}
 
/**
* Generates a stride array from an array shape (column-major).
*
* @private
* @param {NonNegativeIntegerArray} shape - array shape
* @returns {Array} array strides
*/
function columnmajor( shape ) {
	var out;
	var s;
	var i;

	out = [];
	s = 1;
	for ( i = 0; i < shape.length; i++ ) {
		out.push( s );
		s *= shape[ i ];
	}
	return out;
}
 
 
// MAIN //
 
/**
* Generates a stride array from an array shape.
*
* @param {NonNegativeIntegerArray} shape - array shape
* @param {string} order - specifies whether an array is row-major (C-style) or column-major (Fortran-style)
* @returns {Array} array strides
*
* @example
* var s = shape2strides( [ 3, 2 ], 'row-major' );
* // returns [ 2, 1 ]
*
* s = shape2strides( [ 3, 2 ], 'column-major' );
* // returns [ 1, 3 ]
*/
function shape2strides( shape, order ) {
	if ( isColumnMajor( order ) ) {
		return columnmajor( shape );
	}
	return rowmajor( shape );
}
 
 
// EXPORTS //
 
module.exports = shape2strides;