index.js (1152B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2018 The Stdlib Authors. 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 'use strict'; 20 21 /** 22 * Convert a linear index in an array view to a linear index in an underlying data buffer. 23 * 24 * @module @stdlib/ndarray/base/vind2bind 25 * 26 * @example 27 * var vind2bind = require( '@stdlib/ndarray/base/vind2bind' ); 28 * 29 * var shape = [ 3, 3 ]; 30 * var strides = [ -3, 1 ]; 31 * var offset = 6; 32 * var order = 'row-major'; 33 * var mode = 'throw'; 34 * 35 * var ind = vind2bind( shape, strides, offset, order, 1, mode ); 36 * // returns 7 37 */ 38 39 // MODULES // 40 41 var vind2bind = require( './main.js' ); 42 43 44 // EXPORTS // 45 46 module.exports = vind2bind;