All files base.js

100% Statements 99/99
100% Branches 8/8
100% Functions 1/1
100% Lines 99/99

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 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 1003x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 16x 16x 16x 16x 16x 16x 16x 16x 16x 16x 16x 16x 16x 16x 16x 34x 34x 3x 3x 31x 34x 7x 7x 24x 24x 6x 6x 6x 6x 6x 6x 6x 6x 16x 3x 3x 3x 3x 3x  
/**
* @license Apache-2.0
*
* Copyright (c) 2026 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.
*/
 
'use strict';
 
// MODULES //
 
var isInteger = require( '@stdlib/assert/is-integer' ).isPrimitive;
var getShape = require( '@stdlib/ndarray/shape' );
var normalizeIndex = require( '@stdlib/ndarray/base/normalize-index' );
var assign = require( '@stdlib/ndarray/base/assign' );
var resolveGetter = require( '@stdlib/array/base/resolve-getter' );
var join = require( '@stdlib/array/base/join' );
var format = require( '@stdlib/string/format' );
 
 
// MAIN //
 
/**
* Copies elements from an input ndarray to an output ndarray and replaces the element at a specified index with a provided value.
*
* @private
* @param {ndarray} x - input ndarray
* @param {IntegerArray} indices - indices of the element to replace
* @param {*} value - value to set
* @param {ndarray} out - output ndarray
* @throws {TypeError} second argument must be an array of integers
* @throws {RangeError} second argument must be an array of valid indices
* @returns {ndarray} output ndarray
*
* @example
* var ndarray = require( '@stdlib/ndarray/ctor' );
* var emptyLike = require( '@stdlib/ndarray/empty-like' );
*
* var buffer = [ 1, 2, 3, 4 ];
* var shape = [ 2, 2 ];
* var order = 'row-major';
* var strides = [ 2, 1 ];
* var offset = 0;
*
* var x = ndarray( 'generic', buffer, shape, strides, offset, order );
*
* var out = base( x, [ 0, 0 ], 5, emptyLike( x ) );
* // returns <ndarray>[ [ 5, 2 ], [ 3, 4 ] ]
*/
function base( x, indices, value, out ) {
	var args;
	var idx;
	var get;
	var sh;
	var i;
 
	sh = getShape( x );
 
	// Resolve an element accessor for retrieving indices:
	get = resolveGetter( indices );
 
	// Normalize the provided indices...
	args = [];
	for ( i = 0; i < sh.length; i++ ) {
		idx = get( indices, i );
		if ( !isInteger( idx ) ) {
			throw new TypeError( format( 'invalid argument. Second argument must be an array of integers. Value: `%s`.', indices ) );
		}
		idx = normalizeIndex( idx, sh[ i ]-1 );
		if ( idx === -1 ) {
			throw new RangeError( format( 'invalid argument. Second argument contains an out-of-bounds index. Array shape: (%s). Value: `[%s]`.', join( sh, ',' ), join( indices, ',' ) ) );
		}
		args.push( idx );
	}
	args.push( value );
 
	// Copy the input array:
	assign( [ x, out ] );
 
	// Set the element at the specified indices:
	out.set.apply( out, args );
	return out;
}
 
 
// EXPORTS //
 
module.exports = base;