@stdlib/stats-iter-cusum 0.0.2 → 0.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/NOTICE +1 -1
- package/README.md +48 -4
- package/lib/main.js +9 -11
- package/package.json +2 -3
- package/CHANGELOG.md +0 -5
package/NOTICE
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
Copyright (c) 2016-
|
|
1
|
+
Copyright (c) 2016-2022 The Stdlib Authors.
|
package/README.md
CHANGED
|
@@ -20,7 +20,7 @@ limitations under the License.
|
|
|
20
20
|
|
|
21
21
|
# itercusum
|
|
22
22
|
|
|
23
|
-
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] [![dependencies][dependencies-image]][dependencies-url]
|
|
23
|
+
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
|
|
24
24
|
|
|
25
25
|
> Create an [iterator][mdn-iterator-protocol] which iteratively computes a cumulative sum.
|
|
26
26
|
|
|
@@ -31,7 +31,7 @@ The cumulative sum is defined as
|
|
|
31
31
|
<!-- <equation class="equation" label="eq:cumulative_sum" align="center" raw="\begin{align*} s_0 &= x_0 \\ s_1 &= x_1 + s_0 \\ s_2 &= x_2 + s_1 \\ s_n &= x_n + s_{n-1} = x_n + \sum_{i=0}^{n-1} x_i \end{align*}" alt="Equation for the cumulative sum."> -->
|
|
32
32
|
|
|
33
33
|
<div class="equation" align="center" data-raw-text="\begin{align*} s_0 &= x_0 \\ s_1 &= x_1 + s_0 \\ s_2 &= x_2 + s_1 \\ s_n &= x_n + s_{n-1} = x_n + \sum_{i=0}^{n-1} x_i \end{align*}" data-equation="eq:cumulative_sum">
|
|
34
|
-
<img src="https://cdn.
|
|
34
|
+
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@755a26b39bb6429f6d0b6dd8d13bd0bd1ec5ba35/lib/node_modules/@stdlib/stats/iter/cusum/docs/img/equation_cumulative_sum.svg" alt="Equation for the cumulative sum.">
|
|
35
35
|
<br>
|
|
36
36
|
</div>
|
|
37
37
|
|
|
@@ -149,6 +149,22 @@ while ( true ) {
|
|
|
149
149
|
|
|
150
150
|
<!-- /.references -->
|
|
151
151
|
|
|
152
|
+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
|
|
153
|
+
|
|
154
|
+
<section class="related">
|
|
155
|
+
|
|
156
|
+
* * *
|
|
157
|
+
|
|
158
|
+
## See Also
|
|
159
|
+
|
|
160
|
+
- <span class="package-name">[`@stdlib/stats/iter/cumean`][@stdlib/stats/iter/cumean]</span><span class="delimiter">: </span><span class="description">create an iterator which iteratively computes a cumulative arithmetic mean.</span>
|
|
161
|
+
- <span class="package-name">[`@stdlib/stats/iter/sum`][@stdlib/stats/iter/sum]</span><span class="delimiter">: </span><span class="description">compute the sum of all iterated values.</span>
|
|
162
|
+
- <span class="package-name">[`@stdlib/stats/iter/cuprod`][@stdlib/stats/iter/cuprod]</span><span class="delimiter">: </span><span class="description">create an iterator which iteratively computes a cumulative product.</span>
|
|
163
|
+
|
|
164
|
+
</section>
|
|
165
|
+
|
|
166
|
+
<!-- /.related -->
|
|
167
|
+
|
|
152
168
|
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
|
|
153
169
|
|
|
154
170
|
|
|
@@ -162,6 +178,10 @@ This package is part of [stdlib][stdlib], a standard library for JavaScript and
|
|
|
162
178
|
|
|
163
179
|
For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].
|
|
164
180
|
|
|
181
|
+
#### Community
|
|
182
|
+
|
|
183
|
+
[![Chat][chat-image]][chat-url]
|
|
184
|
+
|
|
165
185
|
---
|
|
166
186
|
|
|
167
187
|
## License
|
|
@@ -171,7 +191,7 @@ See [LICENSE][stdlib-license].
|
|
|
171
191
|
|
|
172
192
|
## Copyright
|
|
173
193
|
|
|
174
|
-
Copyright © 2016-
|
|
194
|
+
Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors].
|
|
175
195
|
|
|
176
196
|
</section>
|
|
177
197
|
|
|
@@ -190,9 +210,23 @@ Copyright © 2016-2021. The Stdlib [Authors][stdlib-authors].
|
|
|
190
210
|
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-iter-cusum/main.svg
|
|
191
211
|
[coverage-url]: https://codecov.io/github/stdlib-js/stats-iter-cusum?branch=main
|
|
192
212
|
|
|
193
|
-
|
|
213
|
+
<!--
|
|
214
|
+
|
|
215
|
+
[dependencies-image]: https://img.shields.io/david/stdlib-js/stats-iter-cusum.svg
|
|
194
216
|
[dependencies-url]: https://david-dm.org/stdlib-js/stats-iter-cusum/main
|
|
195
217
|
|
|
218
|
+
-->
|
|
219
|
+
|
|
220
|
+
[umd]: https://github.com/umdjs/umd
|
|
221
|
+
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
|
|
222
|
+
|
|
223
|
+
[deno-url]: https://github.com/stdlib-js/stats-iter-cusum/tree/deno
|
|
224
|
+
[umd-url]: https://github.com/stdlib-js/stats-iter-cusum/tree/umd
|
|
225
|
+
[esm-url]: https://github.com/stdlib-js/stats-iter-cusum/tree/esm
|
|
226
|
+
|
|
227
|
+
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
|
|
228
|
+
[chat-url]: https://gitter.im/stdlib-js/stdlib/
|
|
229
|
+
|
|
196
230
|
[stdlib]: https://github.com/stdlib-js/stdlib
|
|
197
231
|
|
|
198
232
|
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
|
|
@@ -201,6 +235,16 @@ Copyright © 2016-2021. The Stdlib [Authors][stdlib-authors].
|
|
|
201
235
|
|
|
202
236
|
[mdn-iterator-protocol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterator_protocol
|
|
203
237
|
|
|
238
|
+
<!-- <related-links> -->
|
|
239
|
+
|
|
240
|
+
[@stdlib/stats/iter/cumean]: https://www.npmjs.com/package/@stdlib/stats-iter-cumean
|
|
241
|
+
|
|
242
|
+
[@stdlib/stats/iter/sum]: https://www.npmjs.com/package/@stdlib/stats-iter-sum
|
|
243
|
+
|
|
244
|
+
[@stdlib/stats/iter/cuprod]: https://www.npmjs.com/package/@stdlib/stats-iter-cuprod
|
|
245
|
+
|
|
246
|
+
<!-- </related-links> -->
|
|
247
|
+
|
|
204
248
|
</section>
|
|
205
249
|
|
|
206
250
|
<!-- /.links -->
|
package/lib/main.js
CHANGED
|
@@ -23,7 +23,6 @@
|
|
|
23
23
|
var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );
|
|
24
24
|
var isIteratorLike = require( '@stdlib/assert-is-iterator-like' );
|
|
25
25
|
var isFunction = require( '@stdlib/assert-is-function' );
|
|
26
|
-
var hasOwnProp = require( '@stdlib/assert-has-own-property' );
|
|
27
26
|
var iteratorSymbol = require( '@stdlib/symbol-iterator' );
|
|
28
27
|
var incrsum = require( '@stdlib/stats-incr-sum' );
|
|
29
28
|
|
|
@@ -84,27 +83,26 @@ function itercusum( iterator ) {
|
|
|
84
83
|
* @returns {Object} iterator protocol-compliant object
|
|
85
84
|
*/
|
|
86
85
|
function next() {
|
|
87
|
-
var out;
|
|
88
86
|
var v;
|
|
89
87
|
if ( FLG ) {
|
|
90
88
|
return {
|
|
91
89
|
'done': true
|
|
92
90
|
};
|
|
93
91
|
}
|
|
94
|
-
out = {};
|
|
95
92
|
v = iterator.next();
|
|
96
|
-
if ( typeof v.value === 'number' ) {
|
|
97
|
-
out.value = acc( v.value );
|
|
98
|
-
} else if ( hasOwnProp( v, 'value' ) ) {
|
|
99
|
-
out.value = acc( NaN );
|
|
100
|
-
}
|
|
101
93
|
if ( v.done ) {
|
|
102
94
|
FLG = true;
|
|
103
|
-
|
|
95
|
+
return v;
|
|
96
|
+
}
|
|
97
|
+
if ( typeof v.value === 'number' ) {
|
|
98
|
+
v = acc( v.value );
|
|
104
99
|
} else {
|
|
105
|
-
|
|
100
|
+
v = acc( NaN );
|
|
106
101
|
}
|
|
107
|
-
return
|
|
102
|
+
return {
|
|
103
|
+
'value': v,
|
|
104
|
+
'done': false
|
|
105
|
+
};
|
|
108
106
|
}
|
|
109
107
|
|
|
110
108
|
/**
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@stdlib/stats-iter-cusum",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.6",
|
|
4
4
|
"description": "Create an iterator which iteratively computes a cumulative sum.",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"author": {
|
|
@@ -28,7 +28,7 @@
|
|
|
28
28
|
"examples": "make examples",
|
|
29
29
|
"benchmark": "make benchmark"
|
|
30
30
|
},
|
|
31
|
-
"homepage": "https://
|
|
31
|
+
"homepage": "https://stdlib.io",
|
|
32
32
|
"repository": {
|
|
33
33
|
"type": "git",
|
|
34
34
|
"url": "git://github.com/stdlib-js/stats-iter-cusum.git"
|
|
@@ -37,7 +37,6 @@
|
|
|
37
37
|
"url": "https://github.com/stdlib-js/stdlib/issues"
|
|
38
38
|
},
|
|
39
39
|
"dependencies": {
|
|
40
|
-
"@stdlib/assert-has-own-property": "^0.0.x",
|
|
41
40
|
"@stdlib/assert-is-function": "^0.0.x",
|
|
42
41
|
"@stdlib/assert-is-iterator-like": "^0.0.x",
|
|
43
42
|
"@stdlib/stats-incr-sum": "^0.0.x",
|