Skip to content

Commit 6afc64f

Browse files
stdlib-botstdlib-bot
committed
Auto-generated commit
1 parent a937d83 commit 6afc64f

File tree

6 files changed

+502
-5
lines changed

6 files changed

+502
-5
lines changed

‎CHANGELOG.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<section class="release" id="unreleased">
66

7-
## Unreleased (2024-11-30)
7+
## Unreleased (2024-12-01)
88

99
<section class="packages">
1010

@@ -481,6 +481,7 @@ This release closes the following issue:
481481

482482
##### Features
483483

484+
- [`b679536`](https://github.com/stdlib-js/stdlib/commit/b679536e73bb91b1f9194bb6897232a3aa5cf2f2) - add `reduce` method to `array/fixed-endian-factory` [(#3296)](https://github.com/stdlib-js/stdlib/pull/3296)
484485
- [`6ddda90`](https://github.com/stdlib-js/stdlib/commit/6ddda90477b17bb06353e539d6d6dbf9207e6b8f) - add `join` method to `array/fixed-endian-factory` [(#3287)](https://github.com/stdlib-js/stdlib/pull/3287)
485486
- [`c8143c4`](https://github.com/stdlib-js/stdlib/commit/c8143c4f1f5254c67916bb1548aa5443d282e263) - add `lastIndexOf` method to `array/fixed-endian-factory` [(#3281)](https://github.com/stdlib-js/stdlib/pull/3281)
486487
- [`9db1815`](https://github.com/stdlib-js/stdlib/commit/9db181520dc74f28aab70a73aac64202cf7560ce) - add `indexOf` method to `array/fixed-endian-factory` [(#3279)](https://github.com/stdlib-js/stdlib/pull/3279)
@@ -498,9 +499,9 @@ This release closes the following issue:
498499

499500
##### Closed Issues
500501

501-
A total of 7 issues were closed in this release:
502+
A total of 8 issues were closed in this release:
502503

503-
[#3135](https://github.com/stdlib-js/stdlib/issues/3135), [#3138](https://github.com/stdlib-js/stdlib/issues/3138), [#3146](https://github.com/stdlib-js/stdlib/issues/3146), [#3147](https://github.com/stdlib-js/stdlib/issues/3147), [#3149](https://github.com/stdlib-js/stdlib/issues/3149), [#3150](https://github.com/stdlib-js/stdlib/issues/3150), [#3155](https://github.com/stdlib-js/stdlib/issues/3155)
504+
[#3135](https://github.com/stdlib-js/stdlib/issues/3135), [#3138](https://github.com/stdlib-js/stdlib/issues/3138), [#3146](https://github.com/stdlib-js/stdlib/issues/3146), [#3147](https://github.com/stdlib-js/stdlib/issues/3147), [#3149](https://github.com/stdlib-js/stdlib/issues/3149), [#3150](https://github.com/stdlib-js/stdlib/issues/3150), [#3151](https://github.com/stdlib-js/stdlib/issues/3151), [#3155](https://github.com/stdlib-js/stdlib/issues/3155)
504505

505506
</section>
506507

@@ -554,9 +555,9 @@ A total of 7 issues were closed in this release:
554555

555556
### Closed Issues
556557

557-
A total of 14 issues were closed in this release:
558+
A total of 15 issues were closed in this release:
558559

559-
[#3135](https://github.com/stdlib-js/stdlib/issues/3135), [#3138](https://github.com/stdlib-js/stdlib/issues/3138), [#3146](https://github.com/stdlib-js/stdlib/issues/3146), [#3147](https://github.com/stdlib-js/stdlib/issues/3147), [#3149](https://github.com/stdlib-js/stdlib/issues/3149), [#3150](https://github.com/stdlib-js/stdlib/issues/3150), [#3155](https://github.com/stdlib-js/stdlib/issues/3155), [#3164](https://github.com/stdlib-js/stdlib/issues/3164), [#3165](https://github.com/stdlib-js/stdlib/issues/3165), [#3176](https://github.com/stdlib-js/stdlib/issues/3176), [#3177](https://github.com/stdlib-js/stdlib/issues/3177), [#3178](https://github.com/stdlib-js/stdlib/issues/3178), [#3179](https://github.com/stdlib-js/stdlib/issues/3179), [#3180](https://github.com/stdlib-js/stdlib/issues/3180)
560+
[#3135](https://github.com/stdlib-js/stdlib/issues/3135), [#3138](https://github.com/stdlib-js/stdlib/issues/3138), [#3146](https://github.com/stdlib-js/stdlib/issues/3146), [#3147](https://github.com/stdlib-js/stdlib/issues/3147), [#3149](https://github.com/stdlib-js/stdlib/issues/3149), [#3150](https://github.com/stdlib-js/stdlib/issues/3150), [#3151](https://github.com/stdlib-js/stdlib/issues/3151), [#3155](https://github.com/stdlib-js/stdlib/issues/3155), [#3164](https://github.com/stdlib-js/stdlib/issues/3164), [#3165](https://github.com/stdlib-js/stdlib/issues/3165), [#3176](https://github.com/stdlib-js/stdlib/issues/3176), [#3177](https://github.com/stdlib-js/stdlib/issues/3177), [#3178](https://github.com/stdlib-js/stdlib/issues/3178), [#3179](https://github.com/stdlib-js/stdlib/issues/3179), [#3180](https://github.com/stdlib-js/stdlib/issues/3180)
560561

561562
</section>
562563

@@ -587,6 +588,7 @@ A total of 8 people contributed to this release. Thank you to the following cont
587588

588589
<details>
589590

591+
- [`b679536`](https://github.com/stdlib-js/stdlib/commit/b679536e73bb91b1f9194bb6897232a3aa5cf2f2) - **feat:** add `reduce` method to `array/fixed-endian-factory` [(#3296)](https://github.com/stdlib-js/stdlib/pull/3296) _(by Aayush Khanna)_
590592
- [`6ddda90`](https://github.com/stdlib-js/stdlib/commit/6ddda90477b17bb06353e539d6d6dbf9207e6b8f) - **feat:** add `join` method to `array/fixed-endian-factory` [(#3287)](https://github.com/stdlib-js/stdlib/pull/3287) _(by Aditya Sapra, Philipp Burckhardt)_
591593
- [`c8143c4`](https://github.com/stdlib-js/stdlib/commit/c8143c4f1f5254c67916bb1548aa5443d282e263) - **feat:** add `lastIndexOf` method to `array/fixed-endian-factory` [(#3281)](https://github.com/stdlib-js/stdlib/pull/3281) _(by Aditya Sapra, Philipp Burckhardt)_
592594
- [`9818fa6`](https://github.com/stdlib-js/stdlib/commit/9818fa6dd8c90e045a147bfd1ba83cb1f693d17b) - **feat:** update namespace TypeScript declarations [(#3259)](https://github.com/stdlib-js/stdlib/pull/3259) _(by stdlib-bot, Philipp Burckhardt)_

‎fixed-endian-factory/README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -609,6 +609,52 @@ var count = context.count;
609609
// returns 3;
610610
```
611611

612+
<a name="method-reduce"></a>
613+
614+
#### TypedArray.prototype.reduce( reducerFn\[, initialValue] )
615+
616+
Applies a provided callback function to each element of the array, in order, passing in the return value from the calculation on the preceding element and returning the accumulated result upon completion.
617+
618+
```javascript
619+
function reducer( acc, v ) {
620+
return ( acc && v );
621+
}
622+
623+
var Float64ArrayFE = fixedEndianFactory( 'float64' );
624+
625+
var arr = new Float64ArrayFE( 'little-endian', [ 1.0, 0.0, 1.0 ] );
626+
// returns <Float64ArrayFE>
627+
628+
var out = arr.reduce( reducer );
629+
// returns 0.0
630+
```
631+
632+
The reducer function is provided four arguments:
633+
634+
- **acc**: accumulated result.
635+
- **value**: current array element.
636+
- **index**: current array element index.
637+
- **arr**: the array on which this method was called.
638+
639+
By default, the function initializes the accumulated result to the first element in the array and passes the second array element as `value` during the first invocation of the provided callback. To begin accumulation from a different starting value and pass in the first array element as `value` during the first invocation of the provided callback, provide an `initialValue` argument.
640+
641+
```javascript
642+
function reducer( acc, v ) {
643+
if ( v ) {
644+
return acc + 1;
645+
}
646+
return acc;
647+
}
648+
649+
var Float64ArrayFE = fixedEndianFactory( 'float64' );
650+
651+
var arr = new Float64ArrayFE( 'little-endian', [ 1.0, 0.0, 1.0 ] );
652+
// returns <Float64ArrayFE>
653+
654+
var out = arr.reduce( reducer, 0 );
655+
// returns 2
656+
```
657+
612658
<a name="method-set"></a>
613659

614660
#### TypedArrayFE.prototype.set( arr\[, offset] )

‎fixed-endian-factory/benchmark/benchmark.reduce.js

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2024 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
// MODULES //
22+
23+
var bench = require( '@stdlib/bench' );
24+
var isInteger = require( '@stdlib/assert/is-integer' ).isPrimitive;
25+
var pkg = require( './../package.json' ).name;
26+
var factory = require( './../lib' );
27+
28+
29+
// VARIABLES //
30+
31+
var Float64ArrayFE = factory( 'float64' );
32+
33+
34+
// FUNCTIONS //
35+
36+
/**
37+
* Reducer function.
38+
*
39+
* @private
40+
* @param {integer} acc - accumulated value
41+
* @param {number} value - current array element
42+
* @param {integer} index - current array index
43+
* @returns {integer} accumulated value
44+
*/
45+
function reducer( acc, value ) {
46+
if ( value ) {
47+
return acc + 1;
48+
}
49+
return acc;
50+
}
51+
52+
53+
// MAIN //
54+
55+
bench( pkg+':reduce', function benchmark( b ) {
56+
var out;
57+
var arr;
58+
var i;
59+
60+
arr = new Float64ArrayFE( 'little-endian', [ 1.0, 0.0, 0.0, 1.0 ] );
61+
62+
b.tic();
63+
for ( i = 0; i < b.iterations; i++ ) {
64+
out = arr.reduce( reducer, 0 );
65+
if ( typeof out !== 'number' ) {
66+
b.fail( 'should return a number' );
67+
}
68+
}
69+
b.toc();
70+
if ( !isInteger( out ) ) {
71+
b.fail( 'should return an integer' );
72+
}
73+
b.pass( 'benchmark finished' );
74+
b.end();
75+
});

‎fixed-endian-factory/benchmark/benchmark.reduce.length.js

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2024 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
// MODULES //
22+
23+
var bench = require( '@stdlib/bench' );
24+
var pow = require( '@stdlib/math/base/special/pow' );
25+
var zeroTo = require( './../../zero-to' );
26+
var isInteger = require( '@stdlib/assert/is-integer' ).isPrimitive;
27+
var pkg = require( './../package.json' ).name;
28+
var factory = require( './../lib' );
29+
30+
31+
// VARIABLES //
32+
33+
var Float64ArrayFE = factory( 'float64' );
34+
35+
36+
// FUNCTIONS //
37+
38+
/**
39+
* Reducer function.
40+
*
41+
* @private
42+
* @param {integer} acc - accumulated value
43+
* @param {number} value - current array element
44+
* @param {integer} index - current array index
45+
* @returns {integer} accumulated value
46+
*/
47+
function reducer( acc, value ) {
48+
if ( value ) {
49+
return acc + 1;
50+
}
51+
return acc;
52+
}
53+
54+
/**
55+
* Creates a benchmark function.
56+
*
57+
* @private
58+
* @param {PositiveInteger} len - array length
59+
* @returns {Function} benchmark function
60+
*/
61+
function createBenchmark( len ) {
62+
var arr = new Float64ArrayFE( 'little-endian', zeroTo( len ) );
63+
return benchmark;
64+
65+
/**
66+
* Benchmark function.
67+
*
68+
* @private
69+
* @param {Benchmark} b - benchmark instance
70+
*/
71+
function benchmark( b ) {
72+
var out;
73+
var i;
74+
75+
b.tic();
76+
for ( i = 0; i < b.iterations; i++ ) {
77+
out = arr.reduce( reducer );
78+
if ( typeof out !== 'number' ) {
79+
b.fail( 'should return a number' );
80+
}
81+
}
82+
b.toc();
83+
if ( !isInteger( out ) ) {
84+
b.fail( 'should return an integer' );
85+
}
86+
b.pass( 'benchmark finished' );
87+
b.end();
88+
}
89+
}
90+
91+
92+
// MAIN //
93+
94+
/**
95+
* Main execution sequence.
96+
*
97+
* @private
98+
*/
99+
function main() {
100+
var len;
101+
var min;
102+
var max;
103+
var f;
104+
var i;
105+
106+
min = 1; // 10^min
107+
max = 6; // 10^max
108+
109+
for ( i = min; i <= max; i++ ) {
110+
len = pow( 10, i );
111+
f = createBenchmark( len );
112+
bench( pkg+':reduce:len='+len, f );
113+
}
114+
}
115+
116+
main();

‎fixed-endian-factory/lib/main.js

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -769,6 +769,48 @@ function factory( dtype ) { // eslint-disable-line max-lines-per-function, stdli
769769
return out;
770770
});
771771

772+
/**
773+
* Applies a provided callback function to each element of the array, in order, passing in the return value from the calculation on the preceding element and returning the accumulated result upon completion.
774+
*
775+
* @name reduce
776+
* @memberof TypedArray.prototype
777+
* @type {Function}
778+
* @param {Function} reducer - callback function
779+
* @param {*} [initialValue] - initial value
780+
* @throws {TypeError} `this` must be a typed array
781+
* @throws {Error} if not provided an initial value, the array must have at least one element
782+
* @returns {*} accumulated result
783+
*/
784+
setReadOnly( TypedArray.prototype, 'reduce', function reduce( reducer, initialValue ) {
785+
var buf;
786+
var len;
787+
var acc;
788+
var i;
789+
790+
if ( !isTypedArray( this ) ) {
791+
throw new TypeError( format( 'invalid invocation. `this` is not %s %s.', CHAR2ARTICLE[ dtype[0] ], CTOR_NAME ) );
792+
}
793+
if ( !isFunction( reducer ) ) {
794+
throw new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', reducer ) );
795+
}
796+
buf = this._buffer;
797+
len = this._length;
798+
if ( arguments.length > 1 ) {
799+
acc = initialValue;
800+
i = 0;
801+
} else {
802+
if ( len === 0 ) {
803+
throw new Error( 'invalid operation. If not provided an initial value, an array must contain at least one element.' );
804+
}
805+
acc = buf[ GETTER ]( 0 * BYTES_PER_ELEMENT, this._isLE );
806+
i = 1;
807+
}
808+
for ( ; i < len; i++ ) {
809+
acc = reducer( acc, buf[ GETTER ]( i * BYTES_PER_ELEMENT, this._isLE ), i, this );
810+
}
811+
return acc;
812+
});
813+
772814
/**
773815
* Sets an array element.
774816
*

0 commit comments

Comments
 (0)