Skip to content

Commit 77efbd7

Browse files
kgrytekgryte
committed
Add strided interface to compute a sum using extended accumulation and returning an extended result
1 parent 381a3bf commit 77efbd7

33 files changed

+3531
-0
lines changed

‎lib/node_modules/@stdlib/blas/ext/base/dssum/README.md

+186
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,186 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2020 The Stdlib Authors.
6+
7+
Licensed under the Apache License, Version 2.0 (the "License");
8+
you may not use this file except in compliance with the License.
9+
You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing, software
14+
distributed under the License is distributed on an "AS IS" BASIS,
15+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
See the License for the specific language governing permissions and
17+
limitations under the License.
18+
19+
-->
20+
21+
# dssum
22+
23+
> Calculate the sum of single-precision floating-point strided array elements using extended accumulation and returning an extended precision result.
24+
25+
<section class="intro>">
26+
27+
</section>
28+
29+
<!-- /.intro -->
30+
31+
<section class="usage">
32+
33+
## Usage
34+
35+
```javascript
36+
var dssum = require( '@stdlib/blas/ext/base/dssum' );
37+
```
38+
39+
#### dssum( N, x, stride )
40+
41+
Computes the sum of single-precision floating-point strided array elements using extended accumulation and returning an extended precision result.
42+
43+
```javascript
44+
var Float32Array = require( '@stdlib/array/float32' );
45+
46+
var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );
47+
var N = x.length;
48+
49+
var v = dssum( N, x, 1 );
50+
// returns 1.0
51+
```
52+
53+
The function accepts the following parameters:
54+
55+
- **N**: number of indexed elements.
56+
- **x**: input [`Float32Array`][@stdlib/array/float32].
57+
- **stride**: index increment for `x`.
58+
59+
The `N` and `stride` parameters determine which elements in `x` are accessed at runtime. For example, to compute the sum of every other element in `x`,
60+
61+
```javascript
62+
var Float32Array = require( '@stdlib/array/float32' );
63+
var floor = require( '@stdlib/math/base/special/floor' );
64+
65+
var x = new Float32Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ] );
66+
var N = floor( x.length / 2 );
67+
68+
var v = dssum( N, x, 2 );
69+
// returns 5.0
70+
```
71+
72+
Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
73+
74+
<!-- eslint-disable stdlib/capitalized-comments -->
75+
76+
```javascript
77+
var Float32Array = require( '@stdlib/array/float32' );
78+
var floor = require( '@stdlib/math/base/special/floor' );
79+
80+
var x0 = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
81+
var x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
82+
83+
var N = floor( x0.length / 2 );
84+
85+
var v = dssum( N, x1, 2 );
86+
// returns 5.0
87+
```
88+
89+
#### dssum.ndarray( N, x, stride, offset )
90+
91+
Computes the sum of single-precision floating-point strided array elements using extended accumulation and alternative indexing semantics and returning an extended precision result.
92+
93+
```javascript
94+
var Float32Array = require( '@stdlib/array/float32' );
95+
96+
var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );
97+
var N = x.length;
98+
99+
var v = dssum.ndarray( N, x, 1, 0 );
100+
// returns 1.0
101+
```
102+
103+
The function accepts the following additional parameters:
104+
105+
- **offset**: starting index for `x`.
106+
107+
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying `buffer`, the `offset` parameter supports indexing semantics based on a starting index. For example, to calculate the sum of every other value in `x` starting from the second value
108+
109+
```javascript
110+
var Float32Array = require( '@stdlib/array/float32' );
111+
var floor = require( '@stdlib/math/base/special/floor' );
112+
113+
var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
114+
var N = floor( x.length / 2 );
115+
116+
var v = dssum.ndarray( N, x, 2, 1 );
117+
// returns 5.0
118+
```
119+
120+
</section>
121+
122+
<!-- /.usage -->
123+
124+
<section class="notes">
125+
126+
## Notes
127+
128+
- If `N <= 0`, both functions return `0.0`.
129+
- Accumulated intermediate values are stored as double-precision floating-point numbers.
130+
131+
</section>
132+
133+
<!-- /.notes -->
134+
135+
<section class="examples">
136+
137+
## Examples
138+
139+
<!-- eslint no-undef: "error" -->
140+
141+
```javascript
142+
var randu = require( '@stdlib/random/base/randu' );
143+
var round = require( '@stdlib/math/base/special/round' );
144+
var Float32Array = require( '@stdlib/array/float32' );
145+
var dssum = require( '@stdlib/blas/ext/base/dssum' );
146+
147+
var x;
148+
var i;
149+
150+
x = new Float32Array( 10 );
151+
for ( i = 0; i < x.length; i++ ) {
152+
x[ i ] = round( randu()*100.0 );
153+
}
154+
console.log( x );
155+
156+
var v = dssum( x.length, x, 1 );
157+
console.log( v );
158+
```
159+
160+
</section>
161+
162+
<!-- /.examples -->
163+
164+
* * *
165+
166+
<section class="references">
167+
168+
## References
169+
170+
- Higham, Nicholas J. 1993. "The Accuracy of Floating Point Summation." _SIAM Journal on Scientific Computing_ 14 (4): 783–99. doi:[10.1137/0914050][@higham:1993a].
171+
172+
</section>
173+
174+
<!-- /.references -->
175+
176+
<section class="links">
177+
178+
[@stdlib/array/float32]: https://github.com/stdlib-js/stdlib
179+
180+
[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
181+
182+
[@higham:1993a]: https://doi.org/10.1137/0914050
183+
184+
</section>
185+
186+
<!-- /.links -->

‎lib/node_modules/@stdlib/blas/ext/base/dssum/benchmark/benchmark.js

+96
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2020 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 randu = require( '@stdlib/random/base/randu' );
25+
var isnan = require( '@stdlib/math/base/assert/is-nan' );
26+
var pow = require( '@stdlib/math/base/special/pow' );
27+
var Float32Array = require( '@stdlib/array/float32' );
28+
var pkg = require( './../package.json' ).name;
29+
var dssum = require( './../lib/dssum.js' );
30+
31+
32+
// FUNCTIONS //
33+
34+
/**
35+
* Creates a benchmark function.
36+
*
37+
* @private
38+
* @param {PositiveInteger} len - array length
39+
* @returns {Function} benchmark function
40+
*/
41+
function createBenchmark( len ) {
42+
var x;
43+
var i;
44+
45+
x = new Float32Array( len );
46+
for ( i = 0; i < x.length; i++ ) {
47+
x[ i ] = ( randu()*10.0 ) - 20.0;
48+
}
49+
return benchmark;
50+
51+
function benchmark( b ) {
52+
var v;
53+
var i;
54+
55+
b.tic();
56+
for ( i = 0; i < b.iterations; i++ ) {
57+
v = dssum( x.length, x, 1 );
58+
if ( isnan( v ) ) {
59+
b.fail( 'should not return NaN' );
60+
}
61+
}
62+
b.toc();
63+
if ( isnan( v ) ) {
64+
b.fail( 'should not return NaN' );
65+
}
66+
b.pass( 'benchmark finished' );
67+
b.end();
68+
}
69+
}
70+
71+
72+
// MAIN //
73+
74+
/**
75+
* Main execution sequence.
76+
*
77+
* @private
78+
*/
79+
function main() {
80+
var len;
81+
var min;
82+
var max;
83+
var f;
84+
var i;
85+
86+
min = 1; // 10^min
87+
max = 6; // 10^max
88+
89+
for ( i = min; i <= max; i++ ) {
90+
len = pow( 10, i );
91+
f = createBenchmark( len );
92+
bench( pkg+':len='+len, f );
93+
}
94+
}
95+
96+
main();

‎lib/node_modules/@stdlib/blas/ext/base/dssum/benchmark/benchmark.native.js

+105
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2020 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 resolve = require( 'path' ).resolve;
24+
var bench = require( '@stdlib/bench' );
25+
var randu = require( '@stdlib/random/base/randu' );
26+
var isnan = require( '@stdlib/math/base/assert/is-nan' );
27+
var pow = require( '@stdlib/math/base/special/pow' );
28+
var Float32Array = require( '@stdlib/array/float32' );
29+
var tryRequire = require( '@stdlib/utils/try-require' );
30+
var pkg = require( './../package.json' ).name;
31+
32+
33+
// VARIABLES //
34+
35+
var dssum = tryRequire( resolve( __dirname, './../lib/dssum.native.js' ) );
36+
var opts = {
37+
'skip': ( dssum instanceof Error )
38+
};
39+
40+
41+
// FUNCTIONS //
42+
43+
/**
44+
* Creates a benchmark function.
45+
*
46+
* @private
47+
* @param {PositiveInteger} len - array length
48+
* @returns {Function} benchmark function
49+
*/
50+
function createBenchmark( len ) {
51+
var x;
52+
var i;
53+
54+
x = new Float32Array( len );
55+
for ( i = 0; i < x.length; i++ ) {
56+
x[ i ] = ( randu()*10.0 ) - 20.0;
57+
}
58+
return benchmark;
59+
60+
function benchmark( b ) {
61+
var v;
62+
var i;
63+
64+
b.tic();
65+
for ( i = 0; i < b.iterations; i++ ) {
66+
v = dssum( x.length, x, 1 );
67+
if ( isnan( v ) ) {
68+
b.fail( 'should not return NaN' );
69+
}
70+
}
71+
b.toc();
72+
if ( isnan( v ) ) {
73+
b.fail( 'should not return NaN' );
74+
}
75+
b.pass( 'benchmark finished' );
76+
b.end();
77+
}
78+
}
79+
80+
81+
// MAIN //
82+
83+
/**
84+
* Main execution sequence.
85+
*
86+
* @private
87+
*/
88+
function main() {
89+
var len;
90+
var min;
91+
var max;
92+
var f;
93+
var i;
94+
95+
min = 1; // 10^min
96+
max = 6; // 10^max
97+
98+
for ( i = min; i <= max; i++ ) {
99+
len = pow( 10, i );
100+
f = createBenchmark( len );
101+
bench( pkg+'::native:len='+len, opts, f );
102+
}
103+
}
104+
105+
main();

0 commit comments

Comments
 (0)