Skip to content

Commit a2674ef

Browse files
kgrytekgryte
committed
Update examples
1 parent e11c67e commit a2674ef

File tree

14 files changed

+246
-260
lines changed

14 files changed

+246
-260
lines changed

‎lib/node_modules/@stdlib/stats/incr/mcovariance/lib/main.js‎

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,24 @@ var isnan = require( '@stdlib/math/base/assert/is-nan' );
176176
* @example
177177
* var accumulator = incrmcovariance( 3 );
178178
*
179+
* var v = accumulator();
180+
* // returns null
181+
*
182+
* v = accumulator( 2.0, 1.0 );
183+
* // returns 0.0
184+
*
185+
* v = accumulator( -5.0, 3.14 );
186+
* // returns ~-7.49
187+
*
188+
* v = accumulator( 3.0, -1.0 );
189+
* // returns -8.35
190+
*
191+
* v = accumulator( 5.0, -9.5 );
192+
* // returns -29.42
193+
*
194+
* v = accumulator();
195+
* // returns -29.42
196+
*
179197
* @example
180198
* var accumulator = incrmcovariance( 3, -2.0, 10.0 );
181199
*/
@@ -222,25 +240,6 @@ function incrmcovariance( W, meanx, meany ) {
222240
* @param {number} [x] - input value
223241
* @param {number} [y] - input value
224242
* @returns {(number|null)} unbiased sample covariance or null
225-
*
226-
* @example
227-
* var v = accumulator1();
228-
* // returns null
229-
*
230-
* v = accumulator1( 2.0, 1.0 );
231-
* // returns 0.0
232-
*
233-
* v = accumulator1( -5.0, 3.14 );
234-
* // returns ~-7.49
235-
*
236-
* v = accumulator1( 3.0, -1.0 );
237-
* // returns -8.35
238-
*
239-
* v = accumulator1( 5.0, -9.5 );
240-
* // returns -29.42
241-
*
242-
* v = accumulator1();
243-
* // returns -29.42
244243
*/
245244
function accumulator1( x, y ) {
246245
var v1;

‎lib/node_modules/@stdlib/stats/incr/mmax/lib/main.js‎

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,24 @@ var NINF = require( '@stdlib/constants/math/float64-ninf' );
3737
*
3838
* @example
3939
* var accumulator = incrmmax( 3 );
40+
*
41+
* var m = accumulator();
42+
* // returns null
43+
*
44+
* m = accumulator( 2.0 );
45+
* // returns 2.0
46+
*
47+
* m = accumulator( -5.0 );
48+
* // returns 2.0
49+
*
50+
* m = accumulator( 3.0 );
51+
* // returns 3.0
52+
*
53+
* m = accumulator( 5.0 );
54+
* // returns 5.0
55+
*
56+
* m = accumulator();
57+
* // returns 5.0
4058
*/
4159
function incrmmax( W ) {
4260
var buf;
@@ -59,25 +77,6 @@ function incrmmax( W ) {
5977
* @private
6078
* @param {number} [x] - input value
6179
* @returns {(number|null)} maximum value or null
62-
*
63-
* @example
64-
* var m = accumulator();
65-
* // returns null
66-
*
67-
* m = accumulator( 2.0 );
68-
* // returns 2.0
69-
*
70-
* m = accumulator( -5.0 );
71-
* // returns 2.0
72-
*
73-
* m = accumulator( 3.0 );
74-
* // returns 3.0
75-
*
76-
* m = accumulator( 5.0 );
77-
* // returns 5.0
78-
*
79-
* m = accumulator();
80-
* // returns 5.0
8180
*/
8281
function accumulator( x ) {
8382
var v;

‎lib/node_modules/@stdlib/stats/incr/mmaxabs/lib/main.js‎

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,24 @@ var abs = require( '@stdlib/math/base/special/abs' );
3636
*
3737
* @example
3838
* var accumulator = incrmmaxabs( 3 );
39+
*
40+
* var m = accumulator();
41+
* // returns null
42+
*
43+
* m = accumulator( 2.0 );
44+
* // returns 2.0
45+
*
46+
* m = accumulator( -5.0 );
47+
* // returns 5.0
48+
*
49+
* m = accumulator( 3.0 );
50+
* // returns 5.0
51+
*
52+
* m = accumulator( 5.0 );
53+
* // returns 5.0
54+
*
55+
* m = accumulator();
56+
* // returns 5.0
3957
*/
4058
function incrmmaxabs( W ) {
4159
var buf;
@@ -58,25 +76,6 @@ function incrmmaxabs( W ) {
5876
* @private
5977
* @param {number} [x] - input value
6078
* @returns {(number|null)} maximum absolute value or null
61-
*
62-
* @example
63-
* var m = accumulator();
64-
* // returns null
65-
*
66-
* m = accumulator( 2.0 );
67-
* // returns 2.0
68-
*
69-
* m = accumulator( -5.0 );
70-
* // returns 5.0
71-
*
72-
* m = accumulator( 3.0 );
73-
* // returns 5.0
74-
*
75-
* m = accumulator( 5.0 );
76-
* // returns 5.0
77-
*
78-
* m = accumulator();
79-
* // returns 5.0
8079
*/
8180
function accumulator( x ) {
8281
var ax;

‎lib/node_modules/@stdlib/stats/incr/mmean/lib/main.js‎

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,24 @@ var isnan = require( '@stdlib/math/base/assert/is-nan' );
3535
*
3636
* @example
3737
* var accumulator = incrmmean( 3 );
38+
*
39+
* var mu = accumulator();
40+
* // returns null
41+
*
42+
* mu = accumulator( 2.0 );
43+
* // returns 2.0
44+
*
45+
* mu = accumulator( -5.0 );
46+
* // returns -1.5
47+
*
48+
* mu = accumulator( 3.0 );
49+
* // returns 0.0
50+
*
51+
* mu = accumulator( 5.0 );
52+
* // returns 1.0
53+
*
54+
* mu = accumulator();
55+
* // returns 1.0
3856
*/
3957
function incrmmean( W ) {
4058
var delta;
@@ -58,25 +76,6 @@ function incrmmean( W ) {
5876
* @private
5977
* @param {number} [x] - input value
6078
* @returns {(number|null)} mean or null
61-
*
62-
* @example
63-
* var mu = accumulator();
64-
* // returns null
65-
*
66-
* mu = accumulator( 2.0 );
67-
* // returns 2.0
68-
*
69-
* mu = accumulator( -5.0 );
70-
* // returns -1.5
71-
*
72-
* mu = accumulator( 3.0 );
73-
* // returns 0.0
74-
*
75-
* mu = accumulator( 5.0 );
76-
* // returns 1.0
77-
*
78-
* mu = accumulator();
79-
* // returns 1.0
8079
*/
8180
function accumulator( x ) {
8281
var k;

‎lib/node_modules/@stdlib/stats/incr/mmidrange/lib/main.js‎

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,24 @@ var NINF = require( '@stdlib/constants/math/float64-ninf' );
3737
*
3838
* @example
3939
* var accumulator = incrmmidrange( 3 );
40+
*
41+
* var mr = accumulator();
42+
* // returns null
43+
*
44+
* mr = accumulator( 2.0 );
45+
* // returns 2.0
46+
*
47+
* mr = accumulator( -5.0 );
48+
* // returns -1.5
49+
*
50+
* mr = accumulator( 3.0 );
51+
* // returns -1.0
52+
*
53+
* mr = accumulator( 5.0 );
54+
* // returns 0.0
55+
*
56+
* mr = accumulator();
57+
* // returns 0.0
4058
*/
4159
function incrmmidrange( W ) {
4260
var buf;
@@ -61,25 +79,6 @@ function incrmmidrange( W ) {
6179
* @private
6280
* @param {number} [x] - input value
6381
* @returns {(number|null)} mid-range or null
64-
*
65-
* @example
66-
* var mr = accumulator();
67-
* // returns null
68-
*
69-
* mr = accumulator( 2.0 );
70-
* // returns 2.0
71-
*
72-
* mr = accumulator( -5.0 );
73-
* // returns -1.5
74-
*
75-
* mr = accumulator( 3.0 );
76-
* // returns -1.0
77-
*
78-
* mr = accumulator( 5.0 );
79-
* // returns 0.0
80-
*
81-
* mr = accumulator();
82-
* // returns 0.0
8382
*/
8483
function accumulator( x ) {
8584
var v;

‎lib/node_modules/@stdlib/stats/incr/mmin/lib/main.js‎

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,24 @@ var PINF = require( '@stdlib/constants/math/float64-pinf' );
3737
*
3838
* @example
3939
* var accumulator = incrmmin( 3 );
40+
*
41+
* var m = accumulator();
42+
* // returns null
43+
*
44+
* m = accumulator( 2.0 );
45+
* // returns 2.0
46+
*
47+
* m = accumulator( -5.0 );
48+
* // returns -5.0
49+
*
50+
* m = accumulator( 3.0 );
51+
* // returns -5.0
52+
*
53+
* m = accumulator( 5.0 );
54+
* // returns -5.0
55+
*
56+
* m = accumulator();
57+
* // returns -5.0
4058
*/
4159
function incrmmin( W ) {
4260
var buf;
@@ -59,25 +77,6 @@ function incrmmin( W ) {
5977
* @private
6078
* @param {number} [x] - input value
6179
* @returns {(number|null)} minimum value or null
62-
*
63-
* @example
64-
* var m = accumulator();
65-
* // returns null
66-
*
67-
* m = accumulator( 2.0 );
68-
* // returns 2.0
69-
*
70-
* m = accumulator( -5.0 );
71-
* // returns -5.0
72-
*
73-
* m = accumulator( 3.0 );
74-
* // returns -5.0
75-
*
76-
* m = accumulator( 5.0 );
77-
* // returns -5.0
78-
*
79-
* m = accumulator();
80-
* // returns -5.0
8180
*/
8281
function accumulator( x ) {
8382
var v;

‎lib/node_modules/@stdlib/stats/incr/mminabs/lib/main.js‎

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,24 @@ var PINF = require( '@stdlib/constants/math/float64-pinf' );
3737
*
3838
* @example
3939
* var accumulator = incrmminabs( 3 );
40+
*
41+
* var m = accumulator();
42+
* // returns null
43+
*
44+
* m = accumulator( 2.0 );
45+
* // returns 2.0
46+
*
47+
* m = accumulator( -5.0 );
48+
* // returns 2.0
49+
*
50+
* m = accumulator( 3.0 );
51+
* // returns 2.0
52+
*
53+
* m = accumulator( 5.0 );
54+
* // returns 2.0
55+
*
56+
* m = accumulator();
57+
* // returns 2.0
4058
*/
4159
function incrmminabs( W ) {
4260
var buf;
@@ -59,25 +77,6 @@ function incrmminabs( W ) {
5977
* @private
6078
* @param {number} [x] - input value
6179
* @returns {(number|null)} minimum absolute value or null
62-
*
63-
* @example
64-
* var m = accumulator();
65-
* // returns null
66-
*
67-
* m = accumulator( 2.0 );
68-
* // returns 2.0
69-
*
70-
* m = accumulator( -5.0 );
71-
* // returns 2.0
72-
*
73-
* m = accumulator( 3.0 );
74-
* // returns 2.0
75-
*
76-
* m = accumulator( 5.0 );
77-
* // returns 2.0
78-
*
79-
* m = accumulator();
80-
* // returns 2.0
8180
*/
8281
function accumulator( x ) {
8382
var ax;

0 commit comments

Comments
 (0)