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 | 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 3x 3x 3x 3x 3x 3x 3x 3x 51x 51x 51x 51x 10x 10x 51x 9x 9x 51x 10x 10x 22x 51x 8x 8x 51x 5x 5x 9x 51x 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 isndarrayLike = require( '@stdlib/assert/is-ndarray-like' );
var isCollection = require( '@stdlib/assert/is-collection' );
var hasEqualShape = require( '@stdlib/ndarray/base/assert/has-equal-shape' );
var getShape = require( '@stdlib/ndarray/shape' );
var join = require( '@stdlib/array/base/join' );
var format = require( '@stdlib/string/format' );
var base = require( './base.js' );
// MAIN //
/**
* Copies elements from an input ndarray to an output ndarray and replaces the element at a specified index with a provided value.
*
* @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} first argument must be an ndarray
* @throws {TypeError} second argument must be an array of integers
* @throws {RangeError} second argument must be an array of valid indices
* @throws {RangeError} number of indices must equal the number of input ndarray dimensions
* @throws {TypeError} fourth argument must be an ndarray
* @throws {Error} fourth argument must have the same shape as the first argument
* @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 y = emptyLike( x );
*
* var out = assign( x, [ 0, 0 ], 5, y );
* // returns <ndarray>[ [ 5, 2 ], [ 3, 4 ] ]
*
* var bool = ( out === y );
* // returns true
*/
function assign( x, indices, value, out ) {
var sh;
if ( !isndarrayLike( x ) ) {
throw new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) );
}
if ( !isCollection( indices ) ) {
throw new TypeError( format( 'invalid argument. Second argument must be an array of integers. Value: `%s`.', indices ) );
}
if ( !isndarrayLike( out ) ) {
throw new TypeError( format( 'invalid argument. Fourth argument must be an ndarray. Value: `%s`.', out ) );
}
sh = getShape( x );
if ( indices.length !== sh.length ) {
throw new RangeError( format( 'invalid argument. Number of indices does not match the number of array dimensions. Array shape: (%s). Number of indices: %u.', join( sh, ',' ), indices.length ) );
}
if ( !hasEqualShape( x, out ) ) {
throw new Error( format( 'invalid argument. Fourth argument must have the same shape as the first argument. First argument shape: (%s). Fourth argument shape: (%s).', join( sh, ',' ), join( getShape( out ), ',' ) ) );
}
return base( x, indices, value, out );
}
// EXPORTS //
module.exports = assign;
|