feat: add reverse method to array/fixed-endian-factory

lib/node_modules/@stdlib/array/fixed-endian-factory/README.md

@@ -515,6 +515,32 @@ var idx = arr.indexOf( 5.0 );
 // returns -1
 ```
 
+<a name="method-reverse"></a>
+
+#### TypedArrayFE.prototype.reverse()
+
+Reverses an array in-place.
+
+```javascript
+var Float64ArrayFE = fixedEndianFactory( 'float64' );
+
+var arr = new Float64ArrayFE( 'little-endian', [ 1.0, 2.0, 3.0 ] );
+// returns <Float64ArrayFE>
+
+var out=arr.reverse();
+// returns <Float64ArrayFE>
+
+var v=out.get(0);
+// returns 3.0
+
+v=out.get(1);
+// returns 2.0
+
+v=out.get(2);
+// returns 1.0
+
+```
+
 <a name="method-map"></a>
 
 #### TypedArray.prototype.map( callbackFn\[, thisArg] )

lib/node_modules/@stdlib/array/fixed-endian-factory/benchmark/benchmark.reverse.js

@@ -0,0 +1,56 @@
+/**
+* @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 isTypedArray= require( '@stdlib/assert/is-typed-array' );
+var factory = require( './../lib' );
+var pkg = require( './../package.json' ).name;
+
+
+// VARIABLES //
+
+var Float64ArrayFE = factory( 'float64' );
+
+
+// MAIN //
+
+bench( pkg+':reverse', function benchmark( b ) {
+	var out;
+	var arr;
+	var i;
+
+	arr = new Float64ArrayFE( 'little-endian', [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0 ] );
+
+	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 ( !isTypedArray( out ) ) {
+		b.fail( 'should return a typed array' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

lib/node_modules/@stdlib/array/fixed-endian-factory/benchmark/benchmark.reverse.length.js

@@ -0,0 +1,100 @@
+/**
+* @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 pow = require( '@stdlib/math/base/special/pow' );
+var zeroTo = require( '@stdlib/array/zero-to' );
+var isTypedArray = require( '@stdlib/assert/is-typed-array' );
+var factory = require( './../lib' );
+var pkg = require( './../package.json' ).name;
+
+
+// VARIABLES //
+
+var Float64ArrayFE = factory( 'float64' );
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+	var arr = new Float64ArrayFE( 'little-endian', zeroTo( len ) );
+	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 ( !isTypedArray( out ) ) {
+			b.fail( 'should return a typed array' );
+		}
+		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();

lib/node_modules/@stdlib/array/fixed-endian-factory/lib/main.js

@@ -44,6 +44,7 @@ var contains = require( '@stdlib/array/base/assert/contains' ).factory;
 var bytesPerElement = require( '@stdlib/ndarray/base/bytes-per-element' );
 var capitalize = require( '@stdlib/string/base/capitalize' );
 var format = require( '@stdlib/string/format' );
+var floor = require( '@stdlib/math/base/special/floor' );
 var fromIterator = require( './from_iterator.js' );
 var fromIteratorMap = require( './from_iterator_map.js' );
 
@@ -676,6 +677,39 @@ function factory( dtype ) { // eslint-disable-line max-lines-per-function, stdli
 		return -1;
 	});
 
+	/**
+	* Reverse an array in-place.
+	*
+	* @private
+	* @name reverse
+	* @memberof TypedArray.prototype
+	* @type {Function}
+	* @throws {TypeError} `this` must be a typed array
+	* @returns {TypedArray} reversed array
+	*/
+	setReadOnly( TypedArray.prototype, 'reverse', function reverse( ) {
+		var buf;
+		var tmp;
+		var len;
+		var N;
+		var i;
+		var j;
+
+		if ( !isTypedArray( this ) ) {
+			throw new TypeError( format( 'invalid invocation. `this` is not %s %s.', CHAR2ARTICLE[ dtype[0] ], CTOR_NAME ) );
+		}
+		buf = this._buffer;
+		len = this._length;
+		N = floor(len / 2);
+		for ( i = 0; i < N; i++ ) {
+			j=len-i-1;
+			tmp=buf[ GETTER ]( i*BYTES_PER_ELEMENT, this._isLE );
+			buf[ SETTER ]( i*BYTES_PER_ELEMENT, buf[ GETTER ]( j*BYTES_PER_ELEMENT, this._isLE ), this._isLE );
+			buf[ SETTER ]( j*BYTES_PER_ELEMENT, tmp, this._isLE );
+		}
+		return this;
+	});
+
 	/**
 	* Number of array elements.
 	*

lib/node_modules/@stdlib/array/fixed-endian-factory/test/test.reverse.js

@@ -0,0 +1,134 @@
+/**
+* @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 tape = require( 'tape' );
+var hasOwnProp = require( '@stdlib/assert/has-own-property' );
+var isFunction = require( '@stdlib/assert/is-function' );
+var factory = require( './../lib' );
+
+
+// TESTS //
+
+tape( 'main export is a function', function test( t ) {
+	t.ok( true, __filename );
+	t.strictEqual( typeof factory, 'function', 'main export is a function' );
+	t.end();
+});
+
+tape( 'the function returns a function', function test( t ) {
+	var ctor = factory( 'float64' );
+	t.strictEqual( isFunction( ctor ), true, 'returns expected value' );
+	t.end();
+});
+
+tape( 'attached to the prototype of the returned function is a `reverse` method', function test( t ) {
+	var ctor = factory( 'float64' );
+	t.strictEqual( hasOwnProp( ctor.prototype, 'reverse' ), true, 'returns expected value' );
+	t.strictEqual( isFunction( ctor.prototype.reverse ), true, 'returns expected value' );
+	t.end();
+});
+
+tape( 'the method throws an error if invoked with a `this` context which is not a typed array instance', function test( t ) {
+	var values;
+	var ctor;
+	var arr;
+	var i;
+
+	ctor = factory( 'float64' );
+	arr = new ctor( 'little-endian', 5 );
+
+	values = [
+		'5',
+		5,
+		NaN,
+		true,
+		false,
+		null,
+		void 0,
+		{},
+		[],
+		function noop() {}
+	];
+	for ( i = 0; i < values.length; i++ ) {
+		t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] );
+	}
+	t.end();
+
+	function badValue( value ) {
+		return function badValue() {
+			return arr.reverse.call( value, 0 );
+		};
+	}
+});
+
+tape( 'the method returns an empty array if operating on an empty typed array', function test( t ) {
+	var ctor;
+	var arr;
+	var out;
+
+	ctor = factory( 'float64' );
+	arr = new ctor('little-endian');
+	out = arr.reverse();
+	t.strictEqual( out.buffer, arr.buffer, 'returns expected value' );
+	t.strictEqual( out.length, 0, 'returns expected value' );
+	t.end();
+});
+
+tape( 'the method reverses elements of a typed array in-place', function test( t ) {
+	var expected;
+	var values;
+	var ctor;
+	var arr;
+	var out;
+	var i;
+
+	ctor = factory( 'float64' );
+	arr = new ctor( 'little-endian', [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
+	expected = [ 5.0, 4.0, 3.0, 2.0, 1.0 ];
+	out = arr.reverse();
+	values = [];
+	fcn();
+	t.strictEqual( out instanceof ctor, true, 'returns expected value' );
+	t.strictEqual( out, arr, 'returns expected value' );
+	t.strictEqual( arr.length, expected.length, 'returns expected value' );
+	t.deepEqual( values, expected, 'returns expected value' );
+
+	function fcn() {
+		for ( i = 0; i < 5; i++) {
+			values.push(arr.at(i));
+		}
+	}
+	t.end();
+});
+
+tape( 'the method does not change the array length', function test( t ) {
+	var ctor;
+	var arr;
+	var out;
+
+	ctor = factory( 'float64' );
+	arr = new ctor( 'little-endian', [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
+	out = arr.reverse();
+
+	t.strictEqual( out.length, 5, 'returns expected value' );
+	t.end();
+});