get.js (2078B)
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 /* eslint-disable no-invalid-this */ 20 21 'use strict'; 22 23 // MODULES // 24 25 var isInteger = require( '@stdlib/assert/is-integer' ).isPrimitive; 26 var getIndex = require( './../../base/ind' ); 27 28 29 // MAIN // 30 31 /** 32 * Returns an array element. 33 * 34 * ## Notes 35 * 36 * - The number of indices should **equal** the number of dimensions. Accordingly, for zero-dimensional arrays, no indices should be provided. 37 * 38 * @private 39 * @param {...integer} [idx] - indices 40 * @throws {TypeError} provided indices must be integer valued 41 * @throws {RangeError} index exceeds array dimensions 42 * @throws {RangeError} number of indices must equal the number of dimensions 43 * @returns {*} array element 44 */ 45 function get() { 46 var idx; 47 var ind; 48 var M; 49 var i; 50 51 if ( arguments.length !== this._ndims ) { 52 throw new RangeError( 'invalid arguments. Number of indices must match the number of dimensions. ndims: '+this._ndims+'. nargs: '+arguments.length+'.' ); 53 } 54 idx = this._offset; 55 M = this._submode.length; 56 for ( i = 0; i < arguments.length; i++ ) { 57 if ( !isInteger( arguments[ i ] ) ) { 58 throw new TypeError( 'invalid argument. Indices must be integer valued. Argument: '+i+'. Value: `'+arguments[ i ]+'`.' ); 59 } 60 ind = getIndex( arguments[ i ], this._shape[ i ]-1, this._submode[ i%M ] ); // eslint-disable-line max-len 61 idx += this._strides[ i ] * ind; 62 } 63 if ( this._accessors ) { 64 return this._buffer.get( idx ); 65 } 66 return this._buffer[ idx ]; 67 } 68 69 70 // EXPORTS // 71 72 module.exports = get;