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 | 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 130x 130x 130x 130x 130x 130x 130x 130x 130x 130x 276x 276x 130x 20x 8x 20x 8x 8x 130x 36x 20x 20x 12x 12x 8x 8x 12x 36x 12x 12x 4x 4x 12x 110x 74x 8x 8x 74x 6x 6x 74x 124x 124x 130x 64x 136x 136x 136x 136x 136x 64x 64x 60x 130x 128x 128x 128x 128x 128x 60x 130x 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' );
var format = require( '@stdlib/string/format' );
// MAIN //
/**
* Converts a linear index in an array view to a linear index in an underlying data buffer.
*
* @param {NonNegativeIntegerArray} shape - array shape
* @param {IntegerArray} strides - stride array
* @param {NonNegativeInteger} offset - location of the first indexed value **based** on the stride array
* @param {string} order - specifies whether an array is row-major (C-style) or column-major (Fortran-style)
* @param {integer} idx - linear index in an array view
* @param {string} mode - specifies how to handle a linear index which exceeds array dimensions
* @throws {RangeError} linear index must not exceed array dimensions
* @returns {NonNegativeInteger} linear index in an underlying data buffer
*
* @example
* var shape = [ 3, 3 ];
* var strides = [ -3, 1 ];
* var offset = 6;
* var order = 'row-major';
* var mode = 'throw';
*
* var ind = vind2bind( shape, strides, offset, order, 1, mode );
* // returns 7
*/
function vind2bind( shape, strides, offset, order, idx, mode ) {
var ndims;
var len;
var ind;
var s;
var i;
ndims = shape.length;
len = 1;
for ( i = 0; i < ndims; i++ ) {
len *= shape[ i ];
}
if ( mode === 'clamp' ) {
if ( idx < 0 ) {
idx = 0;
} else if ( idx >= len ) {
idx = len - 1;
}
} else if ( mode === 'wrap' ) {
if ( idx < 0 ) {
idx += len; // slight optimization to avoid modulo arithmetic when |idx| <= len
if ( idx < 0 ) {
idx %= len;
if ( idx !== 0 ) {
idx += len;
}
}
} else if ( idx >= len ) {
idx -= len; // slight optimization to avoid modulo arithmetic when len < idx <= 2*len
if ( idx >= len ) {
idx %= len;
}
}
} else {
if ( mode === 'normalize' && idx < 0 ) {
idx += len;
}
if ( idx < 0 || idx >= len ) {
throw new RangeError( format( 'invalid argument. Linear index must not exceed array dimensions. Number of array elements: `%u`. Value: `%d`.', len, idx ) );
}
}
// The approach which follows is to resolve a view index to its subscripts and then plug the subscripts into the standard formula for computing the linear index in the underlying data buffer...
ind = offset;
if ( isColumnMajor( order ) ) {
for ( i = 0; i < ndims; i++ ) {
s = idx % shape[ i ];
idx -= s;
idx /= shape[ i ];
ind += s * strides[ i ];
}
return ind;
}
// Case: row-major
for ( i = ndims-1; i >= 0; i-- ) {
s = idx % shape[ i ];
idx -= s;
idx /= shape[ i ];
ind += s * strides[ i ];
}
return ind;
}
// EXPORTS //
module.exports = vind2bind;
|