index.js (1369B)
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/ind2sub 25 * 26 * @example 27 * var ind2sub = require( '@stdlib/ndarray/ind2sub' ); 28 * 29 * var s = ind2sub( [ 3, 3, 3 ], 17 ); 30 * // returns [ 1, 2, 2 ] 31 * 32 * @example 33 * var ind2sub = require( '@stdlib/ndarray/ind2sub' ); 34 * 35 * var shape = [ 3, 3, 3 ]; 36 * var out = [ 0, 0, 0 ]; 37 * 38 * var s = ind2sub.assign( shape, 17, out ); 39 * // returns [ 1, 2, 2 ] 40 * 41 * var bool = ( s === out ); 42 * // returns true 43 */ 44 45 // MODULES // 46 47 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); 48 var main = require( './main.js' ); 49 var assign = require( './assign.js' ); 50 51 52 // MAIN // 53 54 setReadOnly( main, 'assign', assign ); 55 56 57 // EXPORTS // 58 59 module.exports = main;