added docs

Author: jalajk3004

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

@@ -0,0 +1,47 @@
+
+{{alias}}( W )
+    Returns an accumulator function which incrementally computes a moving
+    minimum value. ignoring `NaN` values.
+
+    The `W` parameter defines the number of values over which to compute the
+    moving minimum.
+
+    If provided a value, the accumulator function returns an updated moving
+    minimum. If not provided a value, the accumulator function returns the
+    current moving minimum.
+
+    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.
+
+    Parameters
+    ----------
+    W: integer
+        Window size.
+
+    Returns
+    -------
+    acc: Function
+        Accumulator function.
+
+    Examples
+    --------
+    > var accumulator = {{alias}}( 3 );
+    > var m = accumulator()
+    null
+    > m = accumulator( 2.0 )
+    2.0
+    > m = accumulator( -5.0 )
+    -5.0
+    > m = accumulator( NaN )
+    -5.0
+    > m = accumulator( 3.0 )
+    -5.0
+    > m = accumulator( 5.0 )
+    -5.0
+    > m = accumulator()
+    -5.0
+
+    See Also
+    --------
+

lib/node_modules/@stdlib/stats/incr/nanmmin/docs/types/index.d.ts

@@ -0,0 +1,72 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2019 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+// TypeScript Version: 4.1
+
+/// <reference types="@stdlib/types"/>
+
+/**
+* If provided a value, returns an updated minimum value; otherwise, returns the current minimum value.
+*
+* @param x - value
+* @returns minimum value
+*/
+type accumulator = ( x?: number ) => number | null;
+
+/**
+* Returns an accumulator function which incrementally computes a moving minimum value.
+*
+* ## Notes
+*
+* -   The `W` parameter defines the number of values over which to compute the moving minimum.
+* -   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.
+*
+* @param W - window size
+* @throws must provide a positive integer
+* @returns accumulator function
+*
+* @example
+* var accumulator = incrmmin( 3 );
+*
+* var m = accumulator();
+* // returns null
+*
+* m = accumulator( 2.0 );
+* // returns 2.0
+*
+* m = accumulator( -5.0 );
+* // returns -5.0
+*
+* m = accumulator( NaN );
+* // returns -5.0
+*
+* m = accumulator( 3.0 );
+* // returns -5.0
+*
+* m = accumulator( 5.0 );
+* // returns -5.0
+*
+* m = accumulator();
+* // returns -5.0
+*/
+declare function incrnanmmin( W: number ): accumulator;
+
+
+// EXPORTS //
+
+export = incrnanmmin;

lib/node_modules/@stdlib/stats/incr/nanmmin/docs/types/test.ts

@@ -0,0 +1,66 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2019 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+import incrnanmmin = require( './index' );
+
+
+// TESTS //
+
+// The function returns an accumulator function...
+{
+	incrnanmmin( 3 ); // $ExpectType accumulator
+}
+
+// The compiler throws an error if the function is provided an argument which is not a number...
+{
+	incrnanmmin( '5' ); // $ExpectError
+	incrnanmmin( true ); // $ExpectError
+	incrnanmmin( false ); // $ExpectError
+	incrnanmmin( null ); // $ExpectError
+	incrnanmmin( undefined ); // $ExpectError
+	incrnanmmin( [] ); // $ExpectError
+	incrnanmmin( {} ); // $ExpectError
+	incrnanmmin( ( x: number ): number => x ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an invalid number of arguments...
+{
+	incrnanmmin(); // $ExpectError
+	incrnanmmin( 3, 2 ); // $ExpectError
+}
+
+// The function returns an accumulator function which returns an accumulated result...
+{
+	const acc = incrnanmmin( 3 );
+
+	acc(); // $ExpectType number | null
+	acc( 3.14 ); // $ExpectType number | null
+}
+
+// The compiler throws an error if the returned accumulator function is provided invalid arguments...
+{
+	const acc = incrnanmmin( 3 );
+
+	acc( '5' ); // $ExpectError
+	acc( true ); // $ExpectError
+	acc( false ); // $ExpectError
+	acc( null ); // $ExpectError
+	acc( [] ); // $ExpectError
+	acc( {} ); // $ExpectError
+	acc( ( x: number ): number => x ); // $ExpectError
+}