Add support for computing a moving maximum

kgryte · kgryte · commit fe7f9a851411 · 2018-05-12T13:11:17.000-07:00
diff --git a/lib/node_modules/@stdlib/stats/incr/msummary/README.md b/lib/node_modules/@stdlib/stats/incr/msummary/README.md
@@ -56,7 +56,8 @@ summary = accumulator( 2.0 ); // [2.0]
         'sum': 2.0,
         'mean': 2.0,
         'variance': 0.0,
-        'stdev': 0.0
+        'stdev': 0.0,
+        'max': 2.0
     }
 */
 
@@ -67,7 +68,8 @@ summary = accumulator( 1.0 ); // [2.0, 1.0]
         'sum': 3.0,
         'mean': 1.5,
         'variance': 0.5,
-        'stdev': 0.7071067811865476
+        'stdev': 0.7071067811865476,
+        'max': 2.0
     }
 */
 
@@ -78,7 +80,8 @@ summary = accumulator( -3.0 ); // [2.0, 1.0, -3.0]
         'sum': 0.0,
         'mean': 0.0,
         'variance': 7.0,
-        'stdev': 2.6457513110645907
+        'stdev': 2.6457513110645907,
+        'max': 2.0
     }
 */
 
diff --git a/lib/node_modules/@stdlib/stats/incr/msummary/docs/repl.txt b/lib/node_modules/@stdlib/stats/incr/msummary/docs/repl.txt
@@ -17,6 +17,7 @@
     - mean: arithmetic mean.
     - variance: unbiased sample variance.
     - stdev: corrected sample standard deviation.
+    - max: maximum value.
 
     The first `W-1` returned summaries will have less statistical support than
     subsequent summaries, as `W` values are needed to fill the window buffer.
diff --git a/lib/node_modules/@stdlib/stats/incr/msummary/lib/main.js b/lib/node_modules/@stdlib/stats/incr/msummary/lib/main.js
@@ -25,6 +25,7 @@ var incrmsum = require( '@stdlib/stats/incr/msum' );
 var incrmmean = require( '@stdlib/stats/incr/mmean' );
 var incrmvariance = require( '@stdlib/stats/incr/mvariance' );
 var incrmstdev = require( '@stdlib/stats/incr/mstdev' );
+var incrmmax = require( '@stdlib/stats/incr/mmax' );
 
 
 // MAIN //
@@ -44,6 +45,7 @@ function incrmsummary( W ) {
 	var summary;
 	var mstdev;
 	var mmean;
+	var mmax;
 	var msum;
 	if ( !isPositiveInteger( W ) ) {
 		throw new TypeError( 'invalid input argument. Must provide a positive integer. Value: `' + W + '`.' );
@@ -52,6 +54,7 @@ function incrmsummary( W ) {
 	mstdev = incrmstdev( W );
 	mmean = incrmmean( W );
 	msum = incrmsum( W );
+	mmax = incrmmax( W );
 	summary = {};
 
 	return accumulator;
@@ -85,6 +88,7 @@ function incrmsummary( W ) {
 		summary.mean = mmean( x );
 		summary.variance = mvariance( x );
 		summary.stdev = mstdev( x );
+		summary.max = mmax( x );
 		return summary;
 	}
 }
diff --git a/lib/node_modules/@stdlib/stats/incr/msummary/test/test.js b/lib/node_modules/@stdlib/stats/incr/msummary/test/test.js
@@ -95,7 +95,8 @@ tape( 'the accumulator function incrementally computes a moving summary', functi
 		'sum': 11.0,
 		'mean': 3.666666666666666666,
 		'variance': 0.3333333333333339,
-		'stdev': 0.5773502691896263
+		'stdev': 0.5773502691896263,
+		'max': 4.0
 	};
 	t.deepEqual( actual[ N-1 ], expected, 'returns expected incremental results' );
 	t.deepEqual( acc(), expected, 'returns expected incremental results' );
