time-to-botec/js/node_modules/@stdlib/ndarray/ctor/lib/iset.js
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

68 lines
1.7 KiB
JavaScript

/**
* @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';
// METHODS //
var isInteger = require( '@stdlib/assert/is-integer' ).isPrimitive;
var getIndex = require( './../../base/ind' );
var parent = require( './../../base/ctor' ); // eslint-disable-line stdlib/no-redeclare
// VARIABLES //
var base = parent.prototype.iset;
// MAIN //
/**
* Sets an array element located at a specified linear index.
*
* ## Notes
*
* - For zero-dimensional arrays, the first, and only, argument should be the value to set.
*
* @private
* @param {integer} [idx] - linear view index
* @param {*} v - value to set
* @throws {TypeError} index must be an integer value
* @throws {RangeError} index exceeds array dimensions
* @returns {ndarray} ndarray instance
*/
function iset( idx, v ) {
if ( this._ndims > 0 ) {
if ( !isInteger( idx ) ) {
throw new TypeError( 'invalid argument. Index must be an integer value. Value: `'+idx+'`.' );
}
idx = getIndex( idx, this._length-1, this._mode );
base.call( this, idx, v );
} else {
base.call( this, idx );
}
return this;
}
// EXPORTS //
module.exports = iset;