All files / ndarray/with/lib main.js

97.97% Statements 97/99
88.88% Branches 8/9
100% Functions 1/1
97.97% Lines 97/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 1001x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 29x 29x 29x 29x 29x 29x 29x 29x 10x 10x 29x 10x 10x 9x 9x 9x 9x 9x 9x 9x 29x 27x 27x     27x 27x 9x 9x 9x 9x 9x 29x 1x 1x 1x 1x 1x  
/**
* @license Apache-2.0
*
* Copyright (c) 2025 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 isndarrayLike = require( '@stdlib/assert/is-ndarray-like' );
var isIntegerArray = require( '@stdlib/assert/is-integer-array' );
var getShape = require( '@stdlib/ndarray/shape' );
var emptyLike = require( '@stdlib/ndarray/empty-like' );
var normalizeIndex = require( '@stdlib/ndarray/base/normalize-index' );
var assign = require( '@stdlib/ndarray/base/assign' );
var format = require( '@stdlib/string/format' );
 
 
// MAIN //
 
/**
* Returns an ndarray with element at specified indices replaced by a provided value.
*
* @param {ndarray} x - input ndarray
* @param {IntegerArray} indices - indices of the element to replace
* @param {*} value - value to set
* @throws {TypeError} First argument must be an ndarray
* @throws {TypeError} Second argument must be an array of integers
* @throws {RangeError} Third argument must be an array of valid indices
* @returns {ndarray} output ndarray
*
* @example
* var ndarray = require( '@stdlib/ndarray/ctor' );
*
* 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 = ndarrayWith( x, [ 0, 0 ], 5 );
* // returns <ndarray>
*
* var v = out.get( 0, 0 );
* // returns 5
*/
function ndarrayWith( x, indices, value ) {
	var args;
	var out;
	var idx;
	var sh;
	var i;
 
	if ( !isndarrayLike( x ) ) {
		throw new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) );
	}
	if ( !isIntegerArray( indices ) ) {
		throw new TypeError( format( 'invalid argument. Second argument must be an array of integers. Value: `%s`.', indices ) );
	}
	// Copy the input array:
	sh = getShape( x );
	out = emptyLike( x );
	assign( [ x, out ] );
 
	// Resolve the provided indices:
	args = [];
	for ( i = 0; i < sh.length; i++ ) {
		idx = normalizeIndex( indices[ i ], sh[ i ] );
		if ( idx === -1 ) {
			throw new RangeError( format( 'invalid argument. Second argument must be an array of valid indices. Value: %s`.`', indices ) );
		}
		args.push( idx );
	}
	args.push( value );
 
	// Set the element at the specified indices:
	out.set.apply( out, args );
	return out;
}
 
 
// EXPORTS //
 
module.exports = ndarrayWith;