feat: add blas/base/zcopy

lib/node_modules/@stdlib/blas/base/zcopy/README.md

@@ -0,0 +1,228 @@
+<!--
+
+@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.
+
+-->
+
+# zcopy
+
+> Copy values from one complex double-precision floating-point vector to another complex double-precision floating-point vector.
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var zcopy = require( '@stdlib/blas/base/zcopy' );
+```
+
+#### zcopy( N, x, strideX, y, strideY )
+
+Copies values from `x` into `y`.
+
+```javascript
+var Complex128Array = require( '@stdlib/array/complex128' );
+var realf = require( '@stdlib/complex/realf' );
+var imagf = require( '@stdlib/complex/imagf' );
+
+var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
+var y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
+
+zcopy( x.length, x, 1, y, 1 );
+
+var z = y.get( 0 );
+// returns <Complex128>
+
+var re = realf( z );
+// returns 1.0
+
+var im = imagf( z );
+// returns 2.0
+```
+
+The function has the following parameters:
+
+-   **N**: number of indexed elements.
+-   **x**: input [`Complex128Array`][@stdlib/array/complex128].
+-   **strideX**: index increment for `x`.
+-   **y**: destination [`Complex128Array`][@stdlib/array/complex128].
+-   **strideY**: index increment for `y`.
+
+The `N` and stride parameters determine how values from `x` are copied into `y`. For example, to copy in reverse order every other value in `x` into the first `N` elements of `y`,
+
+```javascript
+var Complex128Array = require( '@stdlib/array/complex128' );
+var realf = require( '@stdlib/complex/realf' );
+var imagf = require( '@stdlib/complex/imagf' );
+
+var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
+var y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
+
+zcopy( 2, x, -2, y, 1 );
+
+var z = y.get( 0 );
+// returns <Complex128>
+
+var re = realf( z );
+// returns 5.0
+
+var im = imagf( z );
+// returns 6.0
+```
+
+Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
+
+<!-- eslint-disable stdlib/capitalized-comments -->
+
+```javascript
+var Complex128Array = require( '@stdlib/array/complex128' );
+var realf = require( '@stdlib/complex/realf' );
+var imagf = require( '@stdlib/complex/imagf' );
+
+// Initial arrays...
+var x0 = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
+var y0 = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
+
+// Create offset views...
+var x1 = new Complex128Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
+var y1 = new Complex128Array( y0.buffer, y0.BYTES_PER_ELEMENT*2 ); // start at 3rd element
+
+// Copy in reverse order every other value from `x1` into `y1`...
+zcopy( 2, x1, -2, y1, 1 );
+
+var z = y0.get( 2 );
+// returns <Complex128>
+
+var re = realf( z );
+// returns 7.0
+
+var im = imagf( z );
+// returns 8.0
+```
+
+#### zcopy.ndarray( N, x, strideX, offsetX, y, strideY, offsetY )
+
+Copies values from `x` into `y` using alternative indexing semantics.
+
+```javascript
+var Complex128Array = require( '@stdlib/array/complex128' );
+var realf = require( '@stdlib/complex/realf' );
+var imagf = require( '@stdlib/complex/imagf' );
+
+var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
+var y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
+
+zcopy.ndarray( x.length, x, 1, 0, y, 1, 0 );
+
+var z = y.get( 0 );
+// returns <Complex128>
+
+var re = realf( z );
+// returns 1.0
+
+var im = imagf( z );
+// returns 2.0
+```
+
+The function has the following additional parameters:
+
+-   **offsetX**: starting index for `x`.
+-   **offsetY**: starting index for `y`.
+
+While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example, to copy every other value in `x` starting from the second value into the last `N` elements in `y` where `x[i] = y[n]`, `x[i+2] = y[n-1]`,...,
+
+```javascript
+var Complex128Array = require( '@stdlib/array/complex128' );
+var realf = require( '@stdlib/complex/realf' );
+var imagf = require( '@stdlib/complex/imagf' );
+
+var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
+var y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
+
+zcopy.ndarray( 2, x, 2, 1, y, -1, y.length-1 );
+
+var z = y.get( y.length-1 );
+// returns <Complex128>
+
+var re = realf( z );
+// returns 3.0
+
+var im = imagf( z );
+// returns 4.0
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+## Notes
+
+-   If `N <= 0`, both functions return `y` unchanged.
+-   `zcopy()` corresponds to the [BLAS][blas] level 1 function [`zcopy`][zcopy].
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
+var filledarrayBy = require( '@stdlib/array/filled-by' );
+var Complex128 = require( '@stdlib/complex/float64' );
+var zcopy = require( '@stdlib/blas/base/zcopy' );
+
+function rand() {
+    return new Complex128( discreteUniform( 0, 10 ), discreteUniform( -5, 5 ) );
+}
+
+var x = filledarrayBy( 10, 'complex128', rand );
+console.log( x.get( 0 ).toString() );
+
+var y = filledarrayBy( 10, 'complex128', rand );
+console.log( y.get( 0 ).toString() );
+
+// Copy elements from `x` into `y` starting from the end of `y`:
+zcopy( x.length, x, 1, y, -1 );
+console.log( y.get( y.length-1 ).toString() );
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+[blas]: http://www.netlib.org/blas
+
+[zcopy]: https://www.netlib.org/lapack/explore-html/d5/d2b/group__copy_gaca1a115319081adeb0a9b80ec37ce626.html#gaca1a115319081adeb0a9b80ec37ce626
+
+[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
+
+[@stdlib/array/complex128]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/complex128
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/blas/base/zcopy/benchmark/benchmark.js

@@ -0,0 +1,115 @@
+/**
+* @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 bench = require( '@stdlib/bench' );
+var uniform = require( '@stdlib/random/array/uniform' );
+var isnan = require( '@stdlib/math/base/assert/is-nan' );
+var pow = require( '@stdlib/math/base/special/pow' );
+var Complex128Array = require( '@stdlib/array/complex128' );
+var reinterpret = require( '@stdlib/strided/base/reinterpret-complex128' );
+var pkg = require( './../package.json' ).name;
+var zcopy = require( './../lib/zcopy.js' );
+
+
+// VARIABLES //
+
+var options = {
+	'dtype': 'float64'
+};
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+	var viewY;
+	var x;
+	var y;
+
+	x = uniform( len*2, -100.0, 100.0, options );
+	x = new Complex128Array( x.buffer );
+
+	y = new Complex128Array( len );
+	viewY = reinterpret( y, 0 );
+
+	return benchmark;
+
+	/**
+	* Benchmark function.
+	*
+	* @private
+	* @param {Benchmark} b - benchmark instance
+	*/
+	function benchmark( b ) {
+		var i;
+
+		for ( i = 0; i < len*2; i++ ) {
+			viewY[ i ] = 0.0;
+		}
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			zcopy( x.length, x, 1, y, 1 );
+			if ( isnan( viewY[ i%(len*2) ] ) ) {
+				b.fail( 'should not return NaN' );
+			}
+		}
+		b.toc();
+		if ( isnan( viewY[ i%(len*2) ] ) ) {
+			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( pkg+':len='+len, f );
+	}
+}
+
+main();