index.js (1577B)
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 to an array of subscripts. 23 * 24 * @module @stdlib/ndarray/base/ind2sub 25 * 26 * @example 27 * var ind2sub = require( '@stdlib/ndarray/base/ind2sub' ); 28 * 29 * var shape = [ 3, 3, 3 ]; 30 * var strides = [ 9, 6, 1 ]; 31 * var offset = 0; 32 * 33 * var s = ind2sub( shape, strides, offset, 'row-major', 17, 'throw' ); 34 * // returns [ 1, 2, 2 ] 35 * 36 * @example 37 * var ind2sub = require( '@stdlib/ndarray/base/ind2sub' ); 38 * 39 * var shape = [ 3, 3, 3 ]; 40 * var strides = [ 9, 6, 1 ]; 41 * var offset = 0; 42 * 43 * var s = [ 0, 0, 0 ]; 44 * var out = ind2sub.assign( shape, strides, offset, 'row-major', 17, 'throw', s ); 45 * // returns [ 1, 2, 2 ] 46 * 47 * var bool = ( out === s ); 48 * // returns true 49 */ 50 51 // MODULES // 52 53 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); 54 var main = require( './main.js' ); 55 var assign = require( './assign.js' ); 56 57 58 // MAIN // 59 60 setReadOnly( main, 'assign', assign ); 61 62 63 // EXPORTS // 64 65 module.exports = main;