Skip to content

Commit 77e54d0

Browse files
kgrytekgryte
committed
Update notes
1 parent be0a8e1 commit 77e54d0

File tree

14 files changed

+56
-65
lines changed

14 files changed

+56
-65
lines changed

‎lib/node_modules/@stdlib/stats/incr/mpcorrdist/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ r = accumulator();
8484
## Notes
8585

8686
- Input values are **not** type checked. If provided `NaN` or a value which, when used in computations, results in `NaN`, the accumulated value is `NaN` for **at least** `W-1` future invocations. If non-numeric inputs are possible, you are advised to type check and handle accordingly **before** passing the value to the accumulator function.
87-
- The first `W-1` returned [sample correlation distances][pearson-correlation] will have less statistical support than subsequent [sample correlation distances][pearson-correlation], as `W` (x,y) pairs are needed to fill the window buffer. Until the window is full, the returned [sample correlation distance][pearson-correlation] equals the [sample correlation distance][pearson-correlation] of all provided values.
87+
- As `W` (x,y) pairs are needed to fill the window buffer, the first `W-1` returned values are calculated from smaller sample sizes. Until the window is full, each returned value is calculated from all provided values.
8888
- Due to limitations inherent in representing numeric values using floating-point format (i.e., the inability to represent numeric values with infinite precision), the [sample correlation distance][pearson-correlation] between perfectly correlated random variables may **not** be `0` or `2`. In fact, the [sample correlation distance][pearson-correlation] is **not** guaranteed to be strictly on the interval `[0,2]`. Any computed distance should, however, be within floating-point roundoff error.
8989

9090
</section>

‎lib/node_modules/@stdlib/stats/incr/mpcorrdist/docs/repl.txt‎

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
{{alias}}( window[, mx, my] )
2+
{{alias}}( W[, mx, my] )
33
Returns an accumulator function which incrementally computes a moving
44
sample Pearson product-moment correlation distance.
55

@@ -13,22 +13,20 @@
1313
is *not* guaranteed to be strictly on the interval [0,2]. Any computed
1414
distance should, however, be within floating-point roundoff error.
1515

16-
The `window` parameter defines the number of values over which to compute
17-
the moving sample correlation distance.
16+
The `W` parameter defines the number of values over which to compute the
17+
moving sample correlation distance.
1818

1919
If provided values, the accumulator function returns an updated moving
2020
sample correlation distance. If not provided values, the accumulator
2121
function returns the current moving sample correlation distance.
2222

23-
The first `W-1` returned sample correlation distances will have less
24-
statistical support than subsequent sample correlation distances, as `W`
25-
values are needed to fill the window buffer. Until the window is full, the
26-
returned sample correlation distance equals the sample correlation distance
27-
of all provided values.
23+
As `W` (x,y) pairs are needed to fill the window buffer, the first `W-1`
24+
returned values are calculated from smaller sample sizes. Until the window
25+
is full, each returned value is calculated from all provided values.
2826

2927
Parameters
3028
----------
31-
window: integer
29+
W: integer
3230
Window size.
3331

3432
mx: number (optional)

‎lib/node_modules/@stdlib/stats/incr/mprod/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ p = accumulator( z );
128128
## Notes
129129

130130
- Input values are **not** type checked. If provided `NaN` or a value which, when used in computations, results in `NaN`, the accumulated value is `NaN` for **at least** `W-1` future invocations. If non-numeric inputs are possible, you are advised to type check and handle accordingly **before** passing the value to the accumulator function.
131-
- The first `W-1` returned products will have less statistical support than subsequent products, as `W` values are needed to fill the window buffer. Until the window is full, the returned product equals the product of all provided values.
131+
- As `W` values are needed to fill the window buffer, the first `W-1` returned values are calculated from smaller sample sizes. Until the window is full, each returned value is calculated from all provided values.
132132
- For large accumulation windows or accumulations of either large or small numbers, care should be taken to prevent overflow and underflow. Note, however, that overflow/underflow may be transient, as the accumulator does not use a double-precision floating-point number to store an accumulated product. Instead, the accumulator splits an accumulated product into a normalized **fraction** and **exponent** and updates each component separately. Doing so guards against a loss in precision.
133133

134134
</section>

‎lib/node_modules/@stdlib/stats/incr/mprod/docs/repl.txt‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,18 @@
11

2-
{{alias}}( window )
2+
{{alias}}( W )
33
Returns an accumulator function which incrementally computes a moving
44
product.
55

6-
The `window` parameter defines the number of values over which to compute
7-
the moving product.
6+
The `W` parameter defines the number of values over which to compute the
7+
moving product.
88

99
If provided a value, the accumulator function returns an updated moving
1010
product. If not provided a value, the accumulator function returns the
1111
current moving product.
1212

13-
The first `W-1` returned products will have less statistical support than
14-
subsequent products, as `W` values are needed to fill the window buffer.
15-
Until the window is full, the returned product equals the product of all
16-
provided values.
13+
As `W` values are needed to fill the window buffer, the first `W-1` returned
14+
values are calculated from smaller sample sizes. Until the window is full,
15+
each returned value is calculated from all provided values.
1716

1817
For accumulations over large windows or accumulations of large numbers, care
1918
should be taken to prevent overflow. Note, however, that overflow/underflow
@@ -25,7 +24,7 @@
2524

2625
Parameters
2726
----------
28-
window: integer
27+
W: integer
2928
Window size.
3029

3130
Returns

‎lib/node_modules/@stdlib/stats/incr/mrange/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ r = accumulator();
7878
## Notes
7979

8080
- Input values are **not** type checked. If provided `NaN`, the accumulated value is `NaN` for **at least** `W-1` future invocations. If non-numeric inputs are possible, you are advised to type check and handle accordingly **before** passing the value to the accumulator function.
81-
- The first `W-1` returned accumulated values will have less statistical support than subsequent accumulated values, as `W` values are needed to fill the window buffer. Until the window is full, the returned range equals the range for all provided values.
81+
- As `W` values are needed to fill the window buffer, the first `W-1` returned values are calculated from smaller sample sizes. Until the window is full, each returned value is calculated from all provided values.
8282

8383
</section>
8484

‎lib/node_modules/@stdlib/stats/incr/mrange/docs/repl.txt‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,21 @@
11

2-
{{alias}}( window )
2+
{{alias}}( W )
33
Returns an accumulator function which incrementally computes a moving range.
44

5-
The `window` parameter defines the number of values over which to compute
6-
the moving range.
5+
The `W` parameter defines the number of values over which to compute the
6+
moving range.
77

88
If provided a value, the accumulator function returns an updated moving
99
range. If not provided a value, the accumulator function returns the current
1010
moving range.
1111

12-
The first `W-1` returned ranges will have less statistical support than
13-
subsequent ranges, as `W` values are needed to fill the window buffer. Until
14-
the window is full, the returned range equals the range for all provided
15-
values.
12+
As `W` values are needed to fill the window buffer, the first `W-1` returned
13+
values are calculated from smaller sample sizes. Until the window is full,
14+
each returned value is calculated from all provided values.
1615

1716
Parameters
1817
----------
19-
window: integer
18+
W: integer
2019
Window size.
2120

2221
Returns

‎lib/node_modules/@stdlib/stats/incr/mstdev/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ s = accumulator();
8484
## Notes
8585

8686
- Input values are **not** type checked. If provided `NaN` or a value which, when used in computations, results in `NaN`, the accumulated value is `NaN` for **at least** `W-1` future invocations. If non-numeric inputs are possible, you are advised to type check and handle accordingly **before** passing the value to the accumulator function.
87-
- The first `W-1` returned [corrected sample standard deviation][standard-deviation] values will have less statistical support than subsequent [corrected sample standard deviation][standard-deviation] values, as `W` values are needed to fill the window buffer. Until the window is full, the returned [corrected sample standard deviation][standard-deviation] equals the [corrected sample standard deviation][standard-deviation] of all provided values.
87+
- As `W` values are needed to fill the window buffer, the first `W-1` returned values are calculated from smaller sample sizes. Until the window is full, each returned value is calculated from all provided values.
8888

8989
</section>
9090

‎lib/node_modules/@stdlib/stats/incr/mstdev/docs/repl.txt‎

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,23 @@
11

2-
{{alias}}( window[, mean] )
2+
{{alias}}( W[, mean] )
33
Returns an accumulator function which incrementally computes a moving
44
corrected sample standard deviation.
55

6-
The `window` parameter defines the number of values over which to compute
7-
the moving corrected sample standard deviation.
6+
The `W` parameter defines the number of values over which to compute the
7+
moving corrected sample standard deviation.
88

99
If provided a value, the accumulator function returns an updated moving
1010
corrected sample standard deviation. If not provided a value, the
1111
accumulator function returns the current moving corrected sample standard
1212
deviation.
1313

14-
The first `W-1` returned corrected sample standard deviation values will
15-
have less statistical support than subsequent corrected sample standard
16-
deviation values, as `W` values are needed to fill the window buffer. Until
17-
the window is full, the returned corrected sample standard deviation equals
18-
the corrected sample standard deviation of all provided values.
14+
As `W` values are needed to fill the window buffer, the first `W-1` returned
15+
values are calculated from smaller sample sizes. Until the window is full,
16+
each returned value is calculated from all provided values.
1917

2018
Parameters
2119
----------
22-
window: integer
20+
W: integer
2321
Window size.
2422

2523
mean: number (optional)

‎lib/node_modules/@stdlib/stats/incr/msum/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ sum = accumulator();
7878
## Notes
7979

8080
- Input values are **not** type checked. If provided `NaN` or a value which, when used in computations, results in `NaN`, the accumulated value is `NaN` for **at least** `W-1` future invocations. If non-numeric inputs are possible, you are advised to type check and handle accordingly **before** passing the value to the accumulator function.
81-
- The first `W-1` returned sums will have less statistical support than subsequent sums, as `W` values are needed to fill the window buffer. Until the window is full, the returned sum equals the sum of all provided values.
81+
- As `W` values are needed to fill the window buffer, the first `W-1` returned values are calculated from smaller sample sizes. Until the window is full, each returned value is calculated from all provided values.
8282

8383
</section>
8484

‎lib/node_modules/@stdlib/stats/incr/msum/docs/repl.txt‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11

2-
{{alias}}( window )
2+
{{alias}}( W )
33
Returns an accumulator function which incrementally computes a moving sum.
44

5-
The `window` parameter defines the number of values over which to compute
6-
the moving sum.
5+
The `W` parameter defines the number of values over which to compute the
6+
moving sum.
77

88
If provided a value, the accumulator function returns an updated moving sum.
99
If not provided a value, the accumulator function returns the current moving
1010
sum.
1111

12-
The first `W-1` returned sums will have less statistical support than
13-
subsequent sums, as `W` values are needed to fill the window buffer. Until
14-
the window is full, the returned sum equals the sum of all provided values.
12+
As `W` values are needed to fill the window buffer, the first `W-1` returned
13+
values are calculated from smaller sample sizes. Until the window is full,
14+
each returned value is calculated from all provided values.
1515

1616
Parameters
1717
----------
18-
window: integer
18+
W: integer
1919
Window size.
2020

2121
Returns

0 commit comments

Comments
 (0)