Skip to content

Commit ceeaabc

Browse files
committed
feat: benchmarks and readme added
1 parent 47598ad commit ceeaabc

File tree

3 files changed

+237
-0
lines changed

3 files changed

+237
-0
lines changed

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

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -577,6 +577,52 @@ var count = context.count;
577577
// returns 3;
578578
```
579579

580+
<a name="method-reduce-right"></a>
581+
582+
#### TypedArray.prototype.reduceRight( reducerFn\[, initialValue] )
583+
584+
Applies a provided callback function to each element of the array, in reverse order, passing in the return value from the calculation on the following element and returning the accumulated result upon completion.
585+
586+
```javascript
587+
function reducer( acc, v ) {
588+
return ( acc && v );
589+
}
590+
591+
var Float64ArrayFE = fixedEndianFactory( 'float64' );
592+
593+
var arr = new Float64ArrayFE( 'little-endian', [ 1.0, 0.0, 1.0 ] );
594+
// returns <Float64ArrayFE>
595+
596+
var out = arr.reduceRight( reducer );
597+
// returns 0.0
598+
```
599+
600+
The reducer function is provided four arguments:
601+
602+
- **acc**: accumulated result.
603+
- **value**: current array element.
604+
- **index**: current array element index.
605+
- **arr**: the array on which this method was called.
606+
607+
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.
608+
609+
```javascript
610+
function reducer( acc, v ) {
611+
if ( v ) {
612+
return acc + 1;
613+
}
614+
return acc;
615+
}
616+
617+
var Float64ArrayFE = fixedEndianFactory( 'float64' );
618+
619+
var arr = new Float64ArrayFE( 'little-endian', [ 1.0, 0.0, 1.0 ] );
620+
// returns <Float64ArrayFE>
621+
622+
var out = arr.reduceRight( reducer, 0 );
623+
// returns 2
624+
```
625+
580626
<a name="method-set"></a>
581627

582628
#### TypedArrayFE.prototype.set( arr\[, offset] )
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+':reduceRight', 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.reduceRight( 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+
});
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( '@stdlib/array/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.reduceRight( 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+':reduceRight:len='+len, f );
113+
}
114+
}
115+
116+
main();

0 commit comments

Comments
 (0)