Skip to content

Commit 4244221

Browse files
committed
Update examples
1 parent 6855f65 commit 4244221

File tree

4 files changed

+28
-26
lines changed

4 files changed

+28
-26
lines changed

lib/node_modules/@stdlib/stats/incr/mvmr/README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -104,14 +104,14 @@ F = accumulator( 3.0 ); // [2.0, 1.0, 3.0]
104104
// returns 0.5
105105

106106
// Window begins sliding...
107-
F = accumulator( -7.0 ); // [1.0, 3.0, -7.0]
108-
// returns -28.0
107+
F = accumulator( 7.0 ); // [1.0, 3.0, 7.0]
108+
// returns ~2.55
109109

110-
F = accumulator( -5.0 ); // [3.0, -7.0, -5.0]
111-
// returns ~-9.33
110+
F = accumulator( -5.0 ); // [3.0, 7.0, 5.0]
111+
// returns ~22.40
112112

113113
F = accumulator();
114-
// returns ~-9.33
114+
// returns ~22.40
115115
```
116116

117117
</section>
@@ -137,6 +137,8 @@ F = accumulator();
137137

138138
Accordingly, one can use the [variance-to-mean ratio][variance-to-mean-ratio] to assess whether observed data can be modeled as a Poisson process. When observed data is "under-dispersed", observed data may be more regular than as would be the case for a Poisson process. When observed data is "over-dispersed", observed data may contain clusters (i.e., clumped, concentrated data).
139139

140+
- The [variance-to-mean ratio][variance-to-mean-ratio] is typically computed on non-negative values. The measure may lack meaning for data which can assume both positive and negative values.
141+
140142
- The [variance-to-mean ratio][variance-to-mean-ratio] is also known as the **index of dispersion**, **dispersion index**, **coefficient of dispersion**, **relative variance**, and the [**Fano factor**][fano-factor].
141143

142144
</section>

lib/node_modules/@stdlib/stats/incr/mvmr/docs/repl.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,14 @@
3434
null
3535
> F = accumulator( 2.0 )
3636
0.0
37-
> F = accumulator( -4.0 )
38-
-24.5
39-
> F = accumulator( 5.0 )
40-
19.0
41-
> F = accumulator( 5.0 )
42-
14.0
37+
> F = accumulator( 1.0 )
38+
~0.33
39+
> F = accumulator( 3.0 )
40+
0.5
41+
> F = accumulator( 7.0 )
42+
~2.55
4343
> F = accumulator()
44-
14.0
44+
~2.55
4545

4646
See Also
4747
--------

lib/node_modules/@stdlib/stats/incr/mvmr/lib/index.js

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -34,17 +34,17 @@
3434
* F = accumulator( 2.0 );
3535
* // returns 0.0
3636
*
37-
* F = accumulator( -4.0 );
38-
* // returns -24.5
37+
* F = accumulator( 1.0 );
38+
* // returns ~0.33
3939
*
40-
* F = accumulator( 5.0 );
41-
* // returns 19.0
40+
* F = accumulator( 3.0 );
41+
* // returns 0.5
4242
*
43-
* F = accumulator( 5.0 );
44-
* // returns 14.0
43+
* F = accumulator( 7.0 );
44+
* // returns ~2.55
4545
*
4646
* F = accumulator();
47-
* // returns 14.0
47+
* // returns ~2.55
4848
*/
4949

5050
// MODULES //

lib/node_modules/@stdlib/stats/incr/mvmr/lib/main.js

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -112,17 +112,17 @@ var isnan = require( '@stdlib/math/base/assert/is-nan' );
112112
* F = accumulator( 2.0 );
113113
* // returns 0.0
114114
*
115-
* F = accumulator( -4.0 );
116-
* // returns -24.5
115+
* F = accumulator( 1.0 );
116+
* // returns ~0.33
117117
*
118-
* F = accumulator( 5.0 );
119-
* // returns 19.0
118+
* F = accumulator( 3.0 );
119+
* // returns 0.5
120120
*
121-
* F = accumulator( 5.0 );
122-
* // returns 14.0
121+
* F = accumulator( 7.0 );
122+
* // returns ~2.55
123123
*
124124
* F = accumulator();
125-
* // returns 14.0
125+
* // returns ~2.55
126126
*
127127
* @example
128128
* var accumulator = incrmvmr( 3, -2.0 );

0 commit comments

Comments
 (0)