feat: add stats/base/ndarray/meankbn

lib/node_modules/@stdlib/stats/base/ndarray/meankbn/README.md

@@ -0,0 +1,23 @@
+# @stdlib/stats/base/ndarray/meankbn
+
+Compute the arithmetic mean of a one dimensional ndarray using improved Kahan-Babuska compensation.
+
+## Installation
+
+This package is part of the stdlib monorepo and is not published independently.
+
+## Usage
+
+```javascript
+var ndarray = require('@stdlib/ndarray/base/ctor');
+var Float64Array = require('@stdlib/array/float64');
+var meankbn = require('@stdlib/stats/base/ndarray/meankbn');
+
+var buf = new Float64Array([ 1.0, 3.0, 4.0, 2.0 ]);
+var x = new ndarray('float64', buf, [buf.length], [1], 0, 'row-major');
+
+// NOTE: ndarray variants accept an array-like of ndarrays:
+var v = meankbn([ x ]);
+// returns 2.5
+
+

lib/node_modules/@stdlib/stats/base/ndarray/meankbn/benchmark/benchmark.js

@@ -0,0 +1,102 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2025 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.
+*/
+
+'use strict';
+
+// MODULES //
+
+var bench = require( '@stdlib/bench' );
+var uniform = require( '@stdlib/random/array/uniform' );
+var isnan = require( '@stdlib/math/base/assert/is-nan' );
+var pow = require( '@stdlib/math/base/special/pow' );
+var ndarray = require( '@stdlib/ndarray/base/ctor' );
+var pkg = require( './../package.json' ).name;
+var mean = require( './../lib' );
+
+
+// VARIABLES //
+
+var options = {
+	'dtype': 'generic'
+};
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+	var xbuf;
+	var x;
+
+	xbuf = uniform( len, -10.0, 10.0, options );
+	x = new ndarray( options.dtype, xbuf, [ len ], [ 1 ], 0, 'row-major' );
+
+	return benchmark;
+
+	function benchmark( b ) {
+		var v;
+		var i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			v = mean( [ x ] );
+			if ( isnan( v ) ) {
+				b.fail( 'should not return NaN' );
+			}
+		}
+		b.toc();
+		if ( isnan( v ) ) {
+			b.fail( 'should not return NaN' );
+		}
+		b.pass( 'benchmark finished' );
+		b.end();
+	}
+}
+
+
+// MAIN //
+
+/**
+* Main execution sequence.
+*
+* @private
+*/
+function main() {
+	var len;
+	var min;
+	var max;
+	var f;
+	var i;
+
+	min = 1; // 10^min
+	max = 6; // 10^max
+
+	for ( i = min; i <= max; i++ ) {
+		len = pow( 10, i );
+		f = createBenchmark( len );
+		bench( pkg+':len='+len, f );
+	}
+}
+
+main();

lib/node_modules/@stdlib/stats/base/ndarray/meankbn/docs/repl.txt

@@ -0,0 +1,31 @@
+
+{{alias}}( arrays )
+    Computes the arithmetic mean of a one-dimensional ndarray.
+
+    If provided an empty ndarray, the function returns `NaN`.
+
+    Parameters
+    ----------
+    arrays: ArrayLikeObject<ndarray>
+        Array-like object containing a one-dimensional input ndarray.
+
+    Returns
+    -------
+    out: number
+        Arithmetic mean.
+
+    Examples
+    --------
+    > var xbuf = [ 1.0, -2.0, 2.0 ];
+    > var dt = 'generic';
+    > var sh = [ xbuf.length ];
+    > var sx = [ 1 ];
+    > var ox = 0;
+    > var ord = 'row-major';
+    > var x = new {{alias:@stdlib/ndarray/ctor}}( dt, xbuf, sh, sx, ox, ord );
+    > {{alias}}( [ x ] )
+    ~0.3333
+
+    See Also
+    --------
+

lib/node_modules/@stdlib/stats/base/ndarray/meankbn/docs/types/index.d.ts

@@ -0,0 +1,45 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2025 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"/>
+
+import { ndarray } from '@stdlib/types/ndarray';
+
+/**
+* Computes the arithmetic mean of a one-dimensional ndarray.
+*
+* @param arrays - array-like object containing an input ndarray
+* @returns arithmetic mean
+*
+* @example
+* var ndarray = require( '@stdlib/ndarray/base/ctor' );
+*
+* var xbuf = [ 1.0, 3.0, 4.0, 2.0 ];
+* var x = new ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
+*
+* var v = mean( [ x ] );
+* // returns 2.5
+*/
+declare function mean<T extends ndarray = ndarray>( arrays: [ T ] ): number;
+
+
+// EXPORTS //
+
+export = mean;

lib/node_modules/@stdlib/stats/base/ndarray/meankbn/docs/types/test.ts

@@ -0,0 +1,57 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2025 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.
+*/
+
+/* eslint-disable space-in-parens */
+
+import zeros = require( '@stdlib/ndarray/zeros' );
+import mean = require( './index' );
+
+
+// TESTS //
+
+// The function returns a number...
+{
+	const x = zeros( [ 10 ], {
+		'dtype': 'generic'
+	});
+
+	mean( [ x ] ); // $ExpectType number
+}
+
+// The compiler throws an error if the function is provided a first argument which is not an array of ndarrays...
+{
+	mean( '10' ); // $ExpectError
+	mean( 10 ); // $ExpectError
+	mean( true ); // $ExpectError
+	mean( false ); // $ExpectError
+	mean( null ); // $ExpectError
+	mean( undefined ); // $ExpectError
+	mean( [] ); // $ExpectError
+	mean( {} ); // $ExpectError
+	mean( ( x: number ): number => x ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	const x = zeros( [ 10 ], {
+		'dtype': 'generic'
+	});
+
+	mean(); // $ExpectError
+	mean( [ x ], {} ); // $ExpectError
+}

lib/node_modules/@stdlib/stats/base/ndarray/meankbn/examples/index.js

@@ -0,0 +1,9 @@
+'use strict';
+var ndarray = require('@stdlib/ndarray/base/ctor');
+var Float64Array = require('@stdlib/array/float64');
+var meankbn = require('@stdlib/stats/base/ndarray/meankbn');
+
+var buf = new Float64Array([1.0, 3.0, 4.0, 2.0]);
+var x = new ndarray('float64', buf, [buf.length], [1], 0, 'row-major');
+
+console.log('mean:', meankbn([x]));

lib/node_modules/@stdlib/stats/base/ndarray/meankbn/index.js

@@ -0,0 +1,21 @@
+'use strict';
+
+/**
+* Compute the arithmetic mean of a one dimensional ndarray using improved Kahan-Babuska compensation.
+*
+* @module @stdlib/stats/base/ndarray/meankbn
+*
+* @example
+* var ndarray = require('@stdlib/ndarray/base/ctor');
+* var Float64Array = require('@stdlib/array/float64');
+* var meankbn = require('@stdlib/stats/base/ndarray/meankbn');
+*
+* var buf = new Float64Array([ 1.0, 3.0, 4.0, 2.0 ]);
+* var x = new ndarray('float64', buf, [buf.length], [1], 0, 'row-major');
+*
+* var v = meankbn([ x ]);
+* // returns 2.5
+*/
+var main = require('./lib/main.js');
+
+module.exports = main;

lib/node_modules/@stdlib/stats/base/ndarray/meankbn/lib/index.js

@@ -0,0 +1,44 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2025 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.
+*/
+
+'use strict';
+
+/**
+* Compute the arithmetic mean of a one-dimensional ndarray.
+*
+* @module @stdlib/stats/base/ndarray/meankbn
+*
+* @example
+* var ndarray = require( '@stdlib/ndarray/base/ctor' );
+* var mean = require( '@stdlib/stats/base/ndarray/meankbn' );
+*
+* var xbuf = [ 1.0, 3.0, 4.0, 2.0 ];
+* var x = new ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
+*
+* var v = mean( [ x ] );
+* // returns 2.5
+*/
+
+// MODULES //
+
+var main = require( './main.js' );
+
+
+// EXPORTS //
+
+module.exports = main;