feat: add blas/ext/base/ndarray/scopy-within

lib/node_modules/@stdlib/blas/ext/base/ndarray/scopy-within/README.md

@@ -0,0 +1,146 @@
+<!--
+
+@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.
+
+-->
+
+# scopyWithin
+
+> Perform an in-place copy of elements within a one-dimensional single-precision floating-point ndarray.
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var scopyWithin = require( '@stdlib/blas/ext/base/ndarray/scopy-within' );
+```
+
+#### scopyWithin( arrays )
+
+Performs an in-place copy of elements within a one-dimensional single-precision floating-point ndarray.
+
+```javascript
+var Float32Vector = require( '@stdlib/ndarray/vector/float32' );
+var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
+var zeros = require( '@stdlib/ndarray/zeros' );
+
+var x = new Float32Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
+var target = scalar2ndarray( 3, {
+    'dtype': 'generic'
+});
+var start = scalar2ndarray( 1, {
+    'dtype': 'generic'
+});
+var end = scalar2ndarray( 4, {
+    'dtype': 'generic'
+});
+
+var w = zeros( [ 6 ], {
+    'dtype': 'float32'
+});
+
+var out = scopyWithin( [ x, target, start, end, w ] );
+// returns <ndarray>[ 1.0, 2.0, 3.0, 2.0, 3.0, 4.0 ]
+```
+
+The function has the following parameters:
+
+-   **arrays**: array-like object containing the following ndarrays:
+
+    -   a one-dimensional input ndarray.
+    -   a zero-dimensional ndarray specifying a target index.
+    -   a zero-dimensional ndarray specifying a source start index (inclusive).
+    -   a zero-dimensional ndarray specifying a source end index (exclusive).
+    -   a one-dimensional workspace ndarray.
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+## Notes
+
+-   The input ndarray is copied **in-place** (i.e., the input ndarray is **mutated**).
+-   If the `start` and `target` index ranges do not overlap, the `workspace` ndarray is unused and thus ignored.
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var discreteUniform = require( '@stdlib/random/discrete-uniform' );
+var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
+var ndarray2array = require( '@stdlib/ndarray/to-array' );
+var zeros = require( '@stdlib/ndarray/zeros' );
+var scopyWithin = require( '@stdlib/blas/ext/base/ndarray/scopy-within' );
+
+var x = discreteUniform( [ 10 ], -100, 100, {
+    'dtype': 'float32'
+});
+console.log( ndarray2array( x ) );
+
+var target = scalar2ndarray( 5, {
+    'dtype': 'generic'
+});
+var start = scalar2ndarray( 0, {
+    'dtype': 'generic'
+});
+var end = scalar2ndarray( 3, {
+    'dtype': 'generic'
+});
+
+var w = zeros( [ 10 ], {
+    'dtype': 'float32'
+});
+
+scopyWithin( [ x, target, start, end, w ] );
+console.log( ndarray2array( x ) );
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/blas/ext/base/ndarray/scopy-within/benchmark/benchmark.js

@@ -0,0 +1,120 @@
+/**
+* @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 bench = require( '@stdlib/bench' );
+var uniform = require( '@stdlib/random/uniform' );
+var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
+var pow = require( '@stdlib/math/base/special/pow' );
+var zeros = require( '@stdlib/ndarray/zeros' );
+var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
+var format = require( '@stdlib/string/format' );
+var pkg = require( './../package.json' ).name;
+var scopyWithin = require( './../lib' );
+
+
+// VARIABLES //
+
+var options = {
+	'dtype': 'float32'
+};
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+	var target;
+	var start;
+	var opts;
+	var end;
+	var x;
+	var w;
+
+	opts = {
+		'dtype': 'generic'
+	};
+	x = uniform( [ len ], 0.0, 100.0, options );
+	w = zeros( [ len ], options );
+	target = scalar2ndarray( 0, opts );
+	start = scalar2ndarray( 0, opts );
+	end = scalar2ndarray( len, opts );
+
+	return benchmark;
+
+	/**
+	* Benchmark function.
+	*
+	* @private
+	* @param {Benchmark} b - benchmark instance
+	*/
+	function benchmark( b ) {
+		var out;
+		var i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			out = scopyWithin( [ x, target, start, end, w ] );
+			if ( typeof out !== 'object' ) {
+				b.fail( 'should return an ndarray' );
+			}
+		}
+		b.toc();
+		if ( isnanf( x.get( i%len ) ) ) {
+			b.fail( 'should not return NaN' );
+		}
+		b.pass( 'benchmark finished' );
+		b.end();
+	}
+}
+
+
+// MAIN //
+
+/**
+* Main execution sequence.
+*
+* @private
+*/
+function main() {
+	var len;
+	var min;
+	var max;
+	var f;
+	var i;
+
+	min = 1; // 10^min
+	max = 6; // 10^max
+
+	for ( i = min; i <= max; i++ ) {
+		len = pow( 10, i );
+		f = createBenchmark( len );
+		bench( format( '%s:len=%d', pkg, len ), f );
+	}
+}
+
+main();

lib/node_modules/@stdlib/blas/ext/base/ndarray/scopy-within/docs/repl.txt

@@ -0,0 +1,41 @@
+
+{{alias}}( arrays )
+    Performs an in-place copy of elements within a one-dimensional single-
+    precision floating-point ndarray.
+
+    The input ndarray is copied *in-place* (i.e., the input ndarray is
+    *mutated*).
+
+    If the `start` and `target` index ranges do not overlap, the `workspace`
+    ndarray is unused and thus ignored.
+
+    Parameters
+    ----------
+    arrays: ArrayLikeObject<ndarray>
+        Array-like object containing the following ndarrays:
+
+        - a one-dimensional input ndarray.
+        - a zero-dimensional ndarray specifying a target index.
+        - a zero-dimensional ndarray specifying a source start index
+        (inclusive).
+        - a zero-dimensional ndarray specifying a source end index
+        (exclusive).
+        - a one-dimensional workspace ndarray.
+
+    Returns
+    -------
+    out: ndarray
+        Input ndarray.
+
+    Examples
+    --------
+    > var x = new {{alias:@stdlib/ndarray/vector/float32}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
+    > var t = {{alias:@stdlib/ndarray/from-scalar}}( 3, { 'dtype': 'generic' } );
+    > var s = {{alias:@stdlib/ndarray/from-scalar}}( 1, { 'dtype': 'generic' } );
+    > var e = {{alias:@stdlib/ndarray/from-scalar}}( 4, { 'dtype': 'generic' } );
+    > var w = {{alias:@stdlib/ndarray/zeros}}( [ 6 ], { 'dtype': 'float32' } );
+    > {{alias}}( [ x, t, s, e, w ] )
+    <ndarray>[ 1.0, 2.0, 3.0, 2.0, 3.0, 4.0 ]
+
+    See Also
+    --------

lib/node_modules/@stdlib/blas/ext/base/ndarray/scopy-within/docs/types/index.d.ts

@@ -0,0 +1,69 @@
+/*
+* @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.
+*/
+
+// TypeScript Version: 4.1
+
+/// <reference types="@stdlib/types"/>
+
+import { typedndarray, float32ndarray } from '@stdlib/types/ndarray';
+
+/**
+* Performs an in-place copy of elements within a one-dimensional single-precision floating-point ndarray.
+*
+* ## Notes
+*
+* -   The function expects the following ndarrays:
+*
+*     -   a one-dimensional input ndarray.
+*     -   a zero-dimensional ndarray specifying a target index.
+*     -   a zero-dimensional ndarray specifying a source start index (inclusive).
+*     -   a zero-dimensional ndarray specifying a source end index (exclusive).
+*     -   a one-dimensional workspace ndarray.
+*
+* @param arrays - array-like object containing ndarrays
+* @returns input ndarray
+*
+* @example
+* var Float32Vector = require( '@stdlib/ndarray/vector/float32' );
+* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
+* var zeros = require( '@stdlib/ndarray/zeros' );
+*
+* var x = new Float32Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
+* var target = scalar2ndarray( 3, {
+*    'dtype': 'generic'
+* });
+* var start = scalar2ndarray( 1, {
+*    'dtype': 'generic'
+* });
+* var end = scalar2ndarray( 4, {
+*    'dtype': 'generic'
+* });
+*
+* var w = zeros( [ 6 ], {
+*    'dtype': 'float32'
+* });
+*
+* var out = scopyWithin( [ x, target, start, end, w ] );
+* // returns <ndarray>[ 1.0, 2.0, 3.0, 2.0, 3.0, 4.0 ]
+*/
+declare function scopyWithin( arrays: [ float32ndarray, typedndarray<number>, typedndarray<number>, typedndarray<number>, float32ndarray ] ): float32ndarray;
+
+
+// EXPORTS //
+
+export = scopyWithin;