feat: add array/base/to-inserted-at

---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: na
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: na
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---

Author: ShabiShett07

lib/node_modules/@stdlib/array/base/to-inserted-at/lib/assign.js

@@ -0,0 +1,234 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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 isComplexDataType = require( '@stdlib/array/base/assert/is-complex-floating-point-data-type' );
+var isBooleanDataType = require( '@stdlib/array/base/assert/is-boolean-data-type' );
+var isComplexLike = require( '@stdlib/assert/is-complex-like' );
+var Boolean = require( '@stdlib/boolean/ctor' );
+var arraylike2object = require( '@stdlib/array/base/arraylike2object' );
+var reinterpret = require( '@stdlib/strided/base/reinterpret-complex' );
+var reinterpretBoolean = require( '@stdlib/strided/base/reinterpret-boolean' );
+var normalizeIndex = require( '@stdlib/ndarray/base/normalize-index' );
+var real = require( '@stdlib/complex/float64/real' );
+var imag = require( '@stdlib/complex/float64/imag' );
+var format = require( '@stdlib/string/format' );
+
+
+// FUNCTIONS //
+
+/**
+* Copies elements from one array to another array and inserts the element at the specified index to a provided value.
+*
+* @private
+* @param {Collection} x - input array
+* @param {integer} index - element index
+* @param {*} value - inserting value
+* @param {Collection} out - output array
+* @param {integer} stride - output array stride
+* @param {NonNegativeInteger} offset - output array offset
+* @returns {Collection} output array
+*
+* @example
+* var x = [ 1, 2, 3, 4 ];
+*
+* var out = [ 0, 0, 0, 0, 0 ];
+* var arr = indexed( x, 0, 5, out, 1, 0 );
+* // returns [ 5, 1, 2, 3, 4 ]
+*
+* var bool = ( arr === out );
+* // returns true
+*/
+function indexed( x, index, value, out, stride, offset ) {
+	var io;
+	var i;
+
+	io = offset;
+	for ( i = 0; i < x.length; i++ ) {
+		out[ io ] = x[ i ];
+		io += stride;
+	}
+	for ( i = x.length - 1; i >= index; i-- ) {
+		out[ offset + ((i + 1) * stride) ] = out[ offset + (i * stride) ];
+	}
+	out[ offset + (index * stride) ] = value;
+
+	return out;
+}
+
+/**
+* Copies elements from one accessor array to another accessor array and inserts the element at the specified index to a provided value.
+*
+* @private
+* @param {Object} x - input array object
+* @param {integer} index - element index
+* @param {*} value - inserting value
+* @param {Object} out - output array object
+* @param {integer} stride - output array stride
+* @param {NonNegativeInteger} offset - output array offset
+* @returns {Collection} output array
+*
+* @example
+* var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' );
+* var arraylike2object = require( '@stdlib/array/base/arraylike2object' );
+*
+* var x = toAccessorArray( [ 1, 2, 3, 4 ] );
+*
+* var out = toAccessorArray( [ 0, 0, 0, 0, 0 ] );
+* var arr = accessors( arraylike2object( x ), 0, 5, arraylike2object( out ), 1, 0 );
+*
+* var v = arr.get( 0 );
+* // returns 5
+*/
+function accessors( x, index, value, out, stride, offset ) {
+	var xdata;
+	var odata;
+	var xget;
+	var oset;
+	var io;
+	var i;
+
+	xdata = x.data;
+	odata = out.data;
+
+	xget = x.accessors[ 0 ];
+	oset = out.accessors[ 1 ];
+
+	io = offset;
+	for ( i = 0; i < xdata.length; i++ ) {
+		oset( odata, io, xget( xdata, i ) );
+		io += stride;
+	}
+	for ( i = xdata.length - 1; i >= index; i-- ) {
+		oset( odata, offset + ((i + 1) * stride), xget( odata, offset + (i * stride) ) );
+	}
+
+	oset( odata, offset + (index * stride), value );
+	return odata;
+}
+
+/**
+* Copies elements from one complex array to another complex array and inserts the element at the specified index to a provided value.
+*
+* @private
+* @param {Collection} x - real-valued floating-point input array view
+* @param {integer} index - element index
+* @param {ComplexLike} value - inserting value
+* @param {Collection} out - real-valued floating-point output array view
+* @param {integer} stride - output array stride
+* @param {NonNegativeInteger} offset - output array offset
+* @returns {Collection} output array view
+*
+* @example
+* var Complex128 = require( '@stdlib/complex/float64/ctor' );
+* var Float64Array = require( '@stdlib/array/float64' );
+* var arraylike2object = require( '@stdlib/array/base/arraylike2object' );
+*
+* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] );
+*
+* var out = new Float64Array( 6 );
+* var arr = complex( x, 0, new Complex128( 5.0, 6.0 ), out, 1, 0 );
+* // returns <Float64Array>[ 5.0, 6.0, 1.0, 2.0, 3.0, 4.0 ]
+*/
+function complex( x, index, value, out, stride, offset ) {
+	var so;
+	var io;
+	var i;
+
+	so = stride * 2; // multiply by 2, as real-valued array consists of interleaved real and imaginary components
+	io = offset * 2;
+	for ( i = 0; i < x.length/2; i++ ) {
+		out[ io + ( i * so ) ] = x[ 2 * i ];
+		out[ io + ( i * so ) + 1 ] = x[ ( 2 * i ) + 1 ];
+	}
+	for ( i = ( x.length/2 ) - 1; i >= index; i-- ) {
+		out[ io + ( ( i + 1 ) * so ) ] = out[ io + ( i * so ) ];
+		out[ ( io + ( ( i + 1 ) * so ) ) + 1] = out[ io + ( i * so ) + 1];
+	}
+	out[ io + ( index * so ) ] = real( value );
+	out[ io + ( index * so ) + 1] = imag( value );
+
+	return out;
+}
+
+
+// MAIN //
+
+/**
+* Copies elements from one array to another array and inserts the element at the specified index to a provided value.
+*
+* @param {Collection} x - input array
+* @param {integer} index - element index
+* @param {*} value - inserting value
+* @param {Collection} out - output array
+* @param {integer} stride - output array stride
+* @param {NonNegativeInteger} offset - output array offset
+* @throws {RangeError} second argument must not exceed array bounds
+* @returns {Collection} output array
+*
+* @example
+* var x = [ 1, 2, 3, 4 ];
+*
+* var out = [ 0, 0, 0, 0, 0 ];
+* var arr = assign( x, 0, 5, out, 1, 0 );
+* // returns [ 5, 1, 2, 3, 4 ]
+*
+* var bool = ( arr === out );
+* // returns true
+*/
+function assign( x, index, value, out, stride, offset ) {
+	var xo;
+	var oo;
+
+	index = normalizeIndex( index, x.length-1 );
+	if ( index < 0 ) {
+		throw new RangeError( format( 'invalid argument. Index argument is out-of-bounds. Value: `%d`.', index ) );
+	}
+	xo = arraylike2object( x );
+	oo = arraylike2object( out );
+	if ( xo.accessorProtocol || oo.accessorProtocol ) {
+		// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...
+		if (
+			isComplexDataType( xo.dtype ) &&
+			isComplexDataType( oo.dtype ) &&
+			isComplexLike( value )
+		) {
+			complex( reinterpret( x, 0 ), index, value, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len
+			return out;
+		}
+		if (
+			isBooleanDataType( xo.dtype ) &&
+			isBooleanDataType( oo.dtype )
+		) {
+			indexed( reinterpretBoolean( x, 0 ), index, Boolean( value ), reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len
+			return out;
+		}
+		accessors( xo, index, value, oo, stride, offset );
+		return out;
+	}
+	indexed( x, index, value, out, stride, offset );
+	return out;
+}
+
+
+// EXPORTS //
+
+module.exports = assign;