feat: add blas/ext/base/dcopy-within

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

@@ -0,0 +1,302 @@
+<!--
+
+@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.
+
+-->
+
+# dcopy-within
+
+> Perform an in-place copy of elements within a double-precision floating-point array.
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var dcopyWithin = require( '@stdlib/blas/ext/base/dcopy-within' );
+```
+
+#### dcopyWithin( N, target, start, end, x, strideX )
+
+Performs an in-place copy of elements within a double-precision floating-point array.
+
+```javascript
+var Float64Array = require( '@stdlib/array/float64' );
+
+var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
+
+dcopyWithin( 3, 2, 1, 2, x, 1 );
+// x => <Float64Array>[ 1.0, 2.0, 2.0, 4.0, 5.0, 6.0 ]
+```
+
+The function has the following parameters:
+
+-   **N**: number of indexed elements.
+-   **target**: target index.
+-   **start**: source start index.
+-   **end**: source end index.
+-   **x**: input [`Float64Array`][@stdlib/array/float64].
+-   **strideX**: stride length.
+
+The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to copy every other element:
+
+```javascript
+var Float64Array = require( '@stdlib/array/float64' );
+
+var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
+
+dcopyWithin( 3, 0, 1, 6, x, 2 );
+// x => <Float64Array>[ 3.0, 2.0, 5.0, 4.0, 7.0, 6.0, 7.0, 8.0 ]
+```
+
+Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
+
+```javascript
+var Float64Array = require( '@stdlib/array/float64' );
+
+// Initial array...
+var x0 = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
+
+// Create an offset view...
+var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
+
+// Copy within the view...
+dcopyWithin( 2, 0, 2, 5, x1, 1 );
+// x0 => <Float64Array>[ 1.0, 4.0, 5.0, 4.0, 5.0, 6.0 ]
+```
+
+#### dcopyWithin.ndarray( N, target, start, end, x, strideX, offsetX )
+
+Performs an in-place copy of elements within a double-precision floating-point array using alternative indexing semantics.
+
+```javascript
+var Float64Array = require( '@stdlib/array/float64' );
+
+var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
+
+dcopyWithin.ndarray( 2, 2, 0, 5, x, 1, 1 );
+// x => <Float64Array>[ 1.0, 2.0, 3.0, 2.0, 3.0, 6.0 ]
+```
+
+The function has the following additional parameters:
+
+-   **offsetX**: starting index for `x`.
+
+While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameter supports indexing semantics based on a starting index. For example, to copy elements starting from the second element:
+
+```javascript
+var Float64Array = require( '@stdlib/array/float64' );
+
+var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
+
+dcopyWithin.ndarray( 2, 2, 0, 2, x, 1, 2 );
+// x => <Float64Array>[ 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+## Notes
+
+-   If `N <= 0`, both functions return the strided array unchanged.
+-   Both functions **mutate** the provided input strided array.
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
+var dcopyWithin = require( '@stdlib/blas/ext/base/dcopy-within' );
+
+var x = discreteUniform( 10, 0, 500, {
+    'dtype': 'float64'
+});
+console.log( x );
+
+// Copy the first 3 elements to positions 5, 6, 7:
+dcopyWithin( 3, 5, 0, 3, x, 1 );
+console.log( x );
+
+// Copy every other element starting from the second element:
+dcopyWithin( 5, 0, 1, 9, x, 1 );
+console.log( x );
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- C interface documentation. -->
+
+* * *
+
+<section class="c">
+
+## C APIs
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<!-- C usage documentation. -->
+
+<section class="usage">
+
+### Usage
+
+```c
+#include "stdlib/blas/ext/base/dcopy_within.h"
+```
+
+#### stdlib_strided_dcopy_within( N, target, start, end, \*x, strideX )
+
+Performs an in-place copy of elements within a double-precision floating-point array.
+
+```c
+const double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 };
+
+stdlib_strided_dcopy_within( 3, 3, 1, 4, x, 1 );
+```
+
+The function accepts the following arguments:
+
+-   **N**: `[in] CBLAS_INT` number of indexed elements.
+-   **target**: `[in] CBLAS_INT` target index.
+-   **start**: `[in] CBLAS_INT` source start index.
+-   **end**: `[in] CBLAS_INT` source end index.
+-   **x**: `[inout] double*` input array.
+-   **strideX**: `[in] CBLAS_INT` stride length.
+
+```c
+void stdlib_strided_dcopy_within( const CBLAS_INT N, const CBLAS_INT target, const CBLAS_INT start, const CBLAS_INT end, double *x, const CBLAS_INT strideX );
+```
+
+<!-- lint disable maximum-heading-length -->
+
+### stdlib_strided_dcopy_within_ndarray( N, target, start, end, \*x, strideX, offsetX )
+
+<!-- lint enable maximum-heading-length -->
+
+Performs an in-place copy of elements within a double-precision floating-point array using alternative indexing semantics.
+
+```c
+double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 };
+
+stdlib_strided_dcopy_within_ndarray( 2, 2, 0, 2, x, 1, 1 );
+```
+
+The function accepts the following arguments:
+
+-   **N**: `[in] CBLAS_INT` number of indexed elements.
+-   **target**: `[in] CBLAS_INT` target index.
+-   **start**: `[in] CBLAS_INT` source start index.
+-   **end**: `[in] CBLAS_INT` source end index.
+-   **x**: `[inout] double*` input array.
+-   **strideX**: `[in] CBLAS_INT` stride length.
+-   **offsetX**: `[in] CBLAS_INT` starting index.
+
+```c
+void stdlib_strided_dcopy_within_ndarray( const CBLAS_INT N, const CBLAS_INT target, const CBLAS_INT start, const CBLAS_INT end, double *x, const CBLAS_INT strideX, const CBLAS_INT offsetX );
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<!-- C API usage examples. -->
+
+<section class="examples">
+
+### Examples
+
+```c
+#include "stdlib/blas/ext/base/dcopy_within.h"
+#include <stdio.h>
+
+int main( void ) {
+    // Create a strided array:
+    double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 };
+
+    // Specify the number of elements to copy:
+    const int N = 3;
+
+    // Specify a stride:
+    const int strideX = 1;
+
+    // Copy elements starting from index 1 to index 4:
+    stdlib_strided_dcopy_within( N, 4, 1, 4, x, strideX );
+
+    // Print the result:
+    for ( int i = 0; i < 8; i++ ) {
+        printf( "x[ %i ] = %lf\n", i, x[ i ] );
+    }
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+</section>
+
+<!-- /.c -->
+
+<!-- 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">
+
+[@stdlib/array/float64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/float64
+
+[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
+
+<!-- <related-links> -->
+
+<!-- </related-links> -->
+
+</section>
+
+<!-- /.links -->