Auto-generated commit

NOTICE

@@ -1 +1 @@
-Copyright (c) 2016-2023 The Stdlib Authors.
+Copyright (c) 2016-2024 The Stdlib Authors.

README.md

@@ -1651,6 +1651,53 @@ var count = context.count;
 // returns 3
 ```
 
+<a name="method-reverse"></a>
+
+#### Complex128Array.prototype.reverse()
+
+Reverses an array in-place.
+
+```javascript
+var real = require( '@stdlib/complex-real' );
+var imag = require( '@stdlib/complex-imag' );
+
+var arr = new Complex128Array( 3 );
+
+arr.set( [ 1.0, 1.0 ], 0 );
+arr.set( [ 2.0, 2.0 ], 1 );
+arr.set( [ 3.0, 3.0 ], 2 );
+
+var out = arr.reverse();
+// returns <Complex128Array>
+
+var z = out.get( 0 );
+// returns <Complex128>
+
+var re = real( z );
+// returns 3.0
+
+var im = imag( z );
+// returns 3.0
+
+z = out.get( 1 );
+// returns <Complex128>
+
+re = real( z );
+// returns 2.0
+
+im = imag( z );
+// returns 2.0
+
+z = out.get( 2 );
+// returns <Complex128>
+
+re = real( z );
+// returns 1.0
+
+im = imag( z );
+// returns 1.0
+```
+
 <a name="method-set"></a>
 
 #### Complex128Array.prototype.set( z\[, i] )

benchmark/benchmark.reverse.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 isComplex128Array = require( '@stdlib/assert-is-complex128array' );
+var pkg = require( './../package.json' ).name;
+var Complex128Array = require( './../lib' );
+
+
+// MAIN //
+
+bench( pkg+':reverse', function benchmark( b ) {
+	var out;
+	var arr;
+	var i;
+
+	arr = new Complex128Array( [ 1, 2, 3, 4, 5, 6 ] );
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		out = arr.reverse();
+		if ( typeof out !== 'object' ) {
+			b.fail( 'should return an object' );
+		}
+	}
+	b.toc();
+	if ( !isComplex128Array( out ) ) {
+		b.fail( 'should return a Complex128Array' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

benchmark/benchmark.reverse.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 isComplex128Array = require( '@stdlib/assert-is-complex128array' );
+var pow = require( '@stdlib/math-base-special-pow' );
+var Complex128 = require( '@stdlib/complex-float64' );
+var pkg = require( './../package.json' ).name;
+var Complex128Array = 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 Complex128( i, i ) );
+	}
+	arr = new Complex128Array( 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.reverse();
+			if ( typeof out !== 'object' ) {
+				b.fail( 'should return an object' );
+			}
+		}
+		b.toc();
+		if ( !isComplex128Array( out ) ) {
+			b.fail( 'should return a Complex128Array' );
+		}
+		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+':reverse:len='+len, f );
+	}
+}
+
+main();

docs/types/index.d.ts

@@ -811,6 +811,53 @@ declare class Complex128Array implements Complex128ArrayInterface {
 	*/
 	map<U = unknown>( fcn: MapFcn<U>, thisArg?: ThisParameterType<MapFcn<U>> ): Complex128Array;
 
+	/**
+	* Reverses an array in-place.
+	*
+	* @returns reversed array
+	*
+	* @example
+	* var real = require( '@stdlib/complex-real' );
+	* var imag = require( '@stdlib/complex-imag' );
+	*
+	* var arr = new Complex128Array( 3 );
+	*
+	* arr.set( [ 1.0, 1.0 ], 0 );
+	* arr.set( [ 2.0, 2.0 ], 1 );
+	* arr.set( [ 3.0, 3.0 ], 2 );
+	*
+	* var out = arr.reverse();
+	* // returns <Complex128Array>
+	*
+	* var z = out.get( 0 );
+	* // returns <Complex128>
+	*
+	* var re = real( z );
+	* // returns 3.0
+	*
+	* var im = imag( z );
+	* // returns 3.0
+	*
+	* z = out.get( 1 );
+	* // returns <Complex128>
+	*
+	* re = real( z );
+	* // returns 2.0
+	*
+	* im = imag( z );
+	* // returns 2.0
+	*
+	* z = out.get( 2 );
+	* // returns <Complex128>
+	*
+	* re = real( z );
+	* // returns 1.0
+	*
+	* im = imag( z );
+	* // returns 1.0
+	*/
+	reverse(): Complex128Array;
+
 	/**
 	* Sets an array element.
 	*

lib/main.js

@@ -41,6 +41,7 @@ var Float64Array = require( '@stdlib/array-float64' );
 var Complex128 = require( '@stdlib/complex-float64' );
 var real = require( '@stdlib/complex-real' );
 var imag = require( '@stdlib/complex-imag' );
+var floor = require( '@stdlib/math-base-special-floor' );
 var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' );
 var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' );
 var getter = require( '@stdlib/array-base-getter' );
@@ -1725,6 +1726,80 @@ setReadOnly( Complex128Array.prototype, 'map', function map( fcn, thisArg ) {
 	return out;
 });
 
+/**
+* Reverses an array in-place.
+*
+* @name reverse
+* @memberof Complex128Array.prototype
+* @type {Function}
+* @throws {TypeError} `this` must be a complex number array
+* @returns {Complex128Array} reversed array
+*
+* @example
+* var real = require( '@stdlib/complex-real' );
+* var imag = require( '@stdlib/complex-imag' );
+*
+* var arr = new Complex128Array( 3 );
+*
+* arr.set( [ 1.0, 1.0 ], 0 );
+* arr.set( [ 2.0, 2.0 ], 1 );
+* arr.set( [ 3.0, 3.0 ], 2 );
+*
+* var out = arr.reverse();
+* // returns <Complex128Array>
+*
+* var z = out.get( 0 );
+* // returns <Complex128>
+*
+* var re = real( z );
+* // returns 3.0
+*
+* var im = imag( z );
+* // returns 3.0
+*
+* z = out.get( 1 );
+* // returns <Complex128>
+*
+* re = real( z );
+* // returns 2.0
+*
+* im = imag( z );
+* // returns 2.0
+*
+* z = out.get( 2 );
+* // returns <Complex128>
+*
+* re = real( z );
+* // returns 1.0
+*
+* im = imag( z );
+* // returns 1.0
+*/
+setReadOnly( Complex128Array.prototype, 'reverse', function reverse() {
+	var buf;
+	var tmp;
+	var len;
+	var N;
+	var i;
+	var j;
+	if ( !isComplexArray( this ) ) {
+		throw new TypeError( 'invalid invocation. `this` is not a complex number array.' );
+	}
+	len = this._length;
+	buf = this._buffer;
+	N = floor( len / 2 );
+	for ( i = 0; i < N; i++ ) {
+		j = len - i - 1;
+		tmp = buf[ (2*i) ];
+		buf[ (2*i) ] = buf[ (2*j) ];
+		buf[ (2*j) ] = tmp;
+		tmp = buf[ (2*i)+1 ];
+		buf[ (2*i)+1 ] = buf[ (2*j)+1 ];
+		buf[ (2*j)+1 ] = tmp;
+	}
+	return this;
+});
+
 /**
 * Sets an array element.
 *

package.json

@@ -55,6 +55,7 @@
     "@stdlib/complex-real": "^0.1.1",
     "@stdlib/math-base-assert-is-even": "^0.1.0",
     "@stdlib/math-base-assert-is-integer": "^0.1.1",
+    "@stdlib/math-base-special-floor": "^0.1.1",
     "@stdlib/strided-base-reinterpret-complex128": "^0.1.1",
     "@stdlib/strided-base-reinterpret-complex64": "^0.1.1",
     "@stdlib/string-format": "^0.1.1",