Auto-generated commit

.github/workflows/npm_downloads.yml

@@ -102,8 +102,8 @@ jobs:
 
       # Send data to events server:
       - name: 'Post data'
-        # Pin action to full length commit SHA corresponding to v3.0.3:
-        uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629
+        # Pin action to full length commit SHA
+        uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3
         env:
           webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }}
           webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }}

.github/workflows/test_coverage.yml

@@ -119,8 +119,8 @@ jobs:
 
       # Send data to events server:
       - name: 'Post data'
-        # Pin action to full length commit SHA corresponding to v3.0.3:
-        uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629
+        # Pin action to full length commit SHA
+        uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3
         env:
           webhook_url: ${{ secrets.STDLIB_COVERAGE_URL }}
           webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }}

README.md

@@ -1638,6 +1638,100 @@ var count = context.count;
 // returns 2
 ```
 
+<a name="method-subarray"></a>
+
+#### Complex64Array.prototype.subarray( \[begin\[, end]] )
+
+Creates a new typed array view over the same underlying [`ArrayBuffer`][@stdlib/array/buffer] and with the same underlying data type as the host array.
+
+```javascript
+var realf = require( '@stdlib/complex-realf' );
+var imagf = require( '@stdlib/complex-imagf' );
+
+var arr = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
+
+var subarr = arr.subarray();
+// returns <Complex64Array>
+
+var len = subarr.length;
+// returns 4
+
+var z = subarr.get( 0 );
+// returns <Complex64>
+
+var re = realf( z );
+// returns 1.0
+
+var im = imagf( z );
+// returns 2.0
+
+z = subarr.get( len-1 );
+// returns <Complex64>
+
+re = realf( z );
+// returns 7.0
+
+im = imagf( z );
+// returns 8.0
+```
+
+By default, the method creates a typed array view beginning with the first array element. To specify an alternative array index at which to begin, provide a `begin` index (inclusive).
+
+```javascript
+var imagf = require( '@stdlib/complex-imagf' );
+var realf = require( '@stdlib/complex-realf' );
+
+var arr = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
+
+var subarr = arr.subarray( 1 );
+// returns <Complex64Array>
+
+var len = subarr.length;
+// returns 3
+
+var z = subarr.get( 0 );
+// returns <Complex64>
+
+var re = realf( z );
+// returns 3.0
+
+var im = imagf( z );
+// returns 4.0
+```
+
+By default, the method creates a typed array view which includes all array elements after `begin`. To limit the number of array elements after `begin`, provide an `end` index (exclusive).
+
+```javascript
+var realf = require( '@stdlib/complex-realf' );
+var imagf = require( '@stdlib/complex-imagf' );
+
+var arr = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
+
+var subarr = arr.subarray( 1, -1 );
+// returns <Complex64Array>
+
+var len = subarr.length;
+// returns 2
+
+var z = subarr.get( 0 );
+// returns <Complex64>
+
+var re = realf( z );
+// returns 3.0
+
+var im = imagf( z );
+// returns 4.0
+
+z = subarr.get( len-1 );
+// returns <Complex64>
+
+re = realf( z );
+// returns 5.0
+
+im = imagf( z );
+// returns 6.0
+```
+
 </section>
 
 <!-- /.usage -->

benchmark/benchmark.subarray.js

@@ -0,0 +1,51 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2023 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-harness' );
+var isComplex64Array = require( '@stdlib/assert-is-complex64array' );
+var pkg = require( './../package.json' ).name;
+var Complex64Array = require( './../lib' );
+
+
+// MAIN //
+
+bench( pkg+':subarray', function benchmark( b ) {
+	var out;
+	var arr;
+	var i;
+
+	arr = new Complex64Array( [ 1, 2, 3, 4, 5, 6 ] );
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		out = arr.subarray();
+		if ( typeof out !== 'object' ) {
+			b.fail( 'should return an object' );
+		}
+	}
+	b.toc();
+	if ( !isComplex64Array( out ) ) {
+		b.fail( 'should return a Complex64Array' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

benchmark/benchmark.subarray.length.js

@@ -0,0 +1,103 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2023 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-harness' );
+var isComplex64Array = require( '@stdlib/assert-is-complex64array' );
+var pow = require( '@stdlib/math-base-special-pow' );
+var Complex64 = require( '@stdlib/complex-float32' );
+var pkg = require( './../package.json' ).name;
+var Complex64Array = require( './../lib' );
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+	var arr;
+	var i;
+
+	arr = [];
+	for ( i = 0; i < len; i++ ) {
+		arr.push( new Complex64( i, i ) );
+	}
+	arr = new Complex64Array( arr );
+
+	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 = arr.subarray();
+			if ( typeof out !== 'object' ) {
+				b.fail( 'should return an object' );
+			}
+		}
+		b.toc();
+		if ( !isComplex64Array( out ) ) {
+			b.fail( 'should return a Complex64Array' );
+		}
+		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+':subarray:len='+len, f );
+	}
+}
+
+main();