Skip to content

Commit c31588c

Browse files
committed
docs(ndarray/meankbn): fix module header & JSDoc example to match conventions
1 parent ce8acdd commit c31588c

File tree

1 file changed

+6
-10
lines changed
  • lib/node_modules/@stdlib/stats/base/ndarray/meankbn/lib

1 file changed

+6
-10
lines changed

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

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,26 +19,22 @@
1919
'use strict';
2020

2121
/**
22-
* Compute the arithmetic mean of a one-dimensional ndarray.
22+
* Compute the arithmetic mean of a one-dimensional ndarray using the improved Kahan–Babuška algorithm.
2323
*
2424
* @module @stdlib/stats/base/ndarray/meankbn
2525
*
2626
* @example
2727
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
28-
* var mean = require( '@stdlib/stats/base/ndarray/meankbn' );
28+
* var Float64Array = require( '@stdlib/array/float64' );
29+
* var meankbn = require( '@stdlib/stats/base/ndarray/meankbn' );
2930
*
30-
* var xbuf = [ 1.0, 3.0, 4.0, 2.0 ];
31-
* var x = new ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
31+
* var buf = new Float64Array( [ 1.0, 3.0, 4.0, 2.0 ] );
32+
* var x = new ndarray( 'float64', buf, [ buf.length ], [ 1 ], 0, 'row-major' );
3233
*
33-
* var v = mean( [ x ] );
34+
* var v = meankbn( [ x ] );
3435
* // returns 2.5
3536
*/
3637

37-
// MODULES //
38-
3938
var main = require( './main.js' );
4039

41-
42-
// EXPORTS //
43-
4440
module.exports = main;

0 commit comments

Comments
 (0)