feat: logic and tests added

aayush0325 · aayush0325 · commit 47598add01ec · 2024-11-30T08:57:13.000+05:30
diff --git a/lib/node_modules/@stdlib/array/fixed-endian-factory/lib/main.js b/lib/node_modules/@stdlib/array/fixed-endian-factory/lib/main.js
@@ -724,6 +724,48 @@ function factory( dtype ) { // eslint-disable-line max-lines-per-function, stdli
 		return out;
 	});
 
+	/**
+	* Applies a provided callback function to each element of the array, in reverse order, passing in the return value from the calculation on the preceding element and returning the accumulated result upon completion.
+	*
+	* @name reduceRight
+	* @memberof TypedArray.prototype
+	* @type {Function}
+	* @param {Function} reducer - callback function
+	* @param {*} [initialValue] - initial value
+	* @throws {TypeError} `this` must be a typed array
+	* @throws {Error} if not provided an initial value, the array must have at least one element
+	* @returns {*} accumulated result
+	*/
+	setReadOnly( TypedArray.prototype, 'reduceRight', function reduceRight( reducer, initialValue ) {
+		var buf;
+		var len;
+		var acc;
+		var i;
+
+		if ( !isTypedArray( this ) ) {
+			throw new TypeError( format( 'invalid invocation. `this` is not %s %s.', CHAR2ARTICLE[ dtype[0] ], CTOR_NAME ) );
+		}
+		if ( !isFunction( reducer ) ) {
+			throw new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', reducer ) );
+		}
+		buf = this._buffer;
+		len = this._length;
+		if ( arguments.length > 1 ) {
+			acc = initialValue;
+			i = len - 1;
+		} else {
+			if ( len === 0 ) {
+				throw new Error( 'invalid operation. If not provided an initial value, an array must contain at least one element.' );
+			}
+			acc = buf[ GETTER ]( ( len - 1 ) * BYTES_PER_ELEMENT, this._isLE );
+			i = len - 2;
+		}
+		for ( ; i >= 0; i-- ) {
+			acc = reducer( acc, buf[ GETTER ]( i * BYTES_PER_ELEMENT, this._isLE ), i, this );
+		}
+		return acc;
+	});
+
 	/**
 	* Sets an array element.
 	*
diff --git a/lib/node_modules/@stdlib/array/fixed-endian-factory/test/test.reduce_right.js b/lib/node_modules/@stdlib/array/fixed-endian-factory/test/test.reduce_right.js
@@ -0,0 +1,222 @@
+/**
+* @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 `reduceRight` method', function test( t ) {
+	var ctor = factory( 'float64' );
+	t.strictEqual( hasOwnProp( ctor.prototype, 'reduceRight' ), true, 'returns expected value' );
+	t.strictEqual( isFunction( ctor.prototype.reduceRight ), 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', [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
+
+	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.reduceRight.call( value, reducer );
+		};
+	}
+
+	function reducer( acc, value ) {
+		if ( value ) {
+			return acc + 1;
+		}
+		return acc;
+	}
+});
+
+tape( 'the method throws an error if provided a first argument which is not a function', function test( t ) {
+	var values;
+	var ctor;
+	var arr;
+	var i;
+
+	ctor = factory( 'float64' );
+	arr = new ctor( 'little-endian', [ 1.0, 2.0, 3.0, 4.0 ] );
+
+	values = [
+		'5',
+		3.14,
+		NaN,
+		true,
+		false,
+		null,
+		void 0,
+		{},
+		[]
+	];
+	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.reduceRight( value );
+		};
+	}
+});
+
+tape( 'the method throws an error if not provided an initial value when operating on an empty array', function test( t ) {
+	var ctor;
+	var arr;
+
+	ctor = factory( 'float64' );
+	arr = new ctor( 'little-endian' );
+	t.throws( foo, Error, 'throws an error' );
+	t.end();
+
+	function foo() {
+		arr.reduceRight( reducer );
+	}
+
+	function reducer( acc, value ) {
+		if ( value ) {
+			return acc + 1;
+		}
+		return acc;
+	}
+});
+
+tape( 'the method uses the first element of the array as the initial value when an initial value is not provided', function test( t ) {
+	var valueArray;
+	var accArray;
+	var expected;
+	var actual;
+	var ctor;
+	var arr;
+	var ind;
+	var len;
+
+	ctor = factory( 'float64' );
+	arr = new ctor( 'little-endian', [ 1.0, 0.0, 1.0, 0.0 ] );
+	len = arr.length;
+	accArray = [ 0.0, 0.0, 0.0 ];
+	valueArray = [ 1.0, 0.0, 1.0 ];
+	expected = 0.0;
+	actual = arr.reduceRight( reducer );
+
+	t.strictEqual( actual, expected, 'returns expected value' );
+
+	t.end();
+
+	function reducer( acc, value, index ) {
+		ind = ( len - index - 2 );
+		t.strictEqual( acc, accArray[ ind ], 'returns expected value' );
+		t.strictEqual( value, valueArray[ ind ], 'returns expected value' );
+		return ( acc && value );
+	}
+});
+
+tape( 'the method supports providing an initial value as the second argument', function test( t ) {
+	var valueArray;
+	var accArray;
+	var expected;
+	var actual;
+	var ctor;
+	var arr;
+	var ind;
+	var len;
+
+	ctor = factory( 'float64' );
+	arr = new ctor( 'little-endian', [ 1.0, 0.0, 0.0, 1.0 ] );
+	len = arr.length;
+	accArray = [ 0.0, 1.0, 1.0, 1.0 ];
+	valueArray = [ 1.0, 0.0, 0.0, 1.0 ];
+	expected = 2;
+	actual = arr.reduceRight( reducer, 0 );
+
+	t.strictEqual( actual, expected, 'returns expected value' );
+	t.end();
+
+	function reducer( acc, value, index ) {
+		ind = ( len - index - 1 );
+		t.strictEqual( acc, accArray[ ind ], 'returns expected value' );
+		t.strictEqual( value, valueArray[ ind ], 'returns expected value' );
+		if ( value ) {
+			return acc + 1;
+		}
+		return acc;
+	}
+});
+
+tape( 'the method returns the accumulated result', function test( t ) {
+	var expected;
+	var actual;
+	var ctor;
+	var arr;
+
+	ctor = factory( 'float64' );
+	arr = new ctor( 'little-endian', [ 1.0, 0.0, 1.0, 1.0 ] );
+	expected = 0.0;
+	actual = arr.reduceRight( reducer );
+
+	t.strictEqual( actual, expected, 'returns expected value' );
+	t.end();
+
+	function reducer( acc, value ) {
+		return ( acc && value );
+	}
+});
