All files / ndarray/ctor/lib iget.js

100% Statements 65/65
100% Branches 6/6
100% Functions 1/1
100% Lines 65/65

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 6633x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 1777x 1777x 1772x 50x 50x 1722x 1722x 1722x 5x 1777x 33x 33x 33x 33x 33x  
/**
* @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.
*/
 
/* eslint-disable no-invalid-this */
 
'use strict';
 
// MODULES //
 
var isInteger = require( '@stdlib/assert/is-integer' ).isPrimitive;
var getIndex = require( '@stdlib/ndarray/base/ind' );
var parent = require( '@stdlib/ndarray/base/ctor' ); // eslint-disable-line stdlib/no-redeclare
var format = require( '@stdlib/string/format' );
 
 
// VARIABLES //
 
var base = parent.prototype.iget;
 
 
// MAIN //
 
/**
* Returns an array element located at a specified linear index.
*
* ## Notes
*
* -   For zero-dimensional arrays, the input argument is ignored and, for clarity, should not be provided.
*
* @private
* @param {integer} [idx] - linear view index
* @throws {TypeError} index must be an integer
* @throws {RangeError} index exceeds array dimensions
* @returns {*} array element
*/
function iget( idx ) {
	if ( this._ndims > 0 ) {
		if ( !isInteger( idx ) ) {
			throw new TypeError( format( 'invalid argument. Index must be an integer. Value: `%s`.', idx ) );
		}
		idx = getIndex( idx, this._length-1, this._mode );
		return base.call( this, idx );
	}
	return base.call( this );
}
 
 
// EXPORTS //
 
module.exports = iget;