Skip to content

Commit 2ed81a1

Browse files
authored
Apply suggestions from code review
Signed-off-by: Athan <kgryte@gmail.com>
1 parent fde222f commit 2ed81a1

4 files changed

Lines changed: 5 additions & 6 deletions

File tree

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

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ limitations under the License.
2020

2121
# sdsmeanors
2222

23-
> Compute the [arithmetic mean][arithmetic-mean] of a single-precision floating-point ndarray using ordinary recursive summation with extended accumulation.
23+
> Compute the [arithmetic mean][arithmetic-mean] of a one-dimensional single-precision floating-point ndarray using ordinary recursive summation with extended accumulation.
2424
2525
<section class="intro">
2626

@@ -53,7 +53,7 @@ var sdsmeanors = require( '@stdlib/stats/base/ndarray/sdsmeanors' );
5353

5454
#### sdsmeanors( arrays )
5555

56-
Computes the [arithmetic mean][arithmetic-mean] of a single-precision floating-point ndarray using ordinary recursive summation with extended accumulation.
56+
Computes the [arithmetic mean][arithmetic-mean] of a one-dimensional single-precision floating-point ndarray using ordinary recursive summation with extended accumulation.
5757

5858
```javascript
5959
var Float32Array = require( '@stdlib/array/float32' );
@@ -80,7 +80,6 @@ The function has the following parameters:
8080

8181
- If provided an empty one-dimensional ndarray, the function returns `NaN`.
8282
- Accumulated intermediate values are stored as double-precision floating-point numbers.
83-
- Ordinary recursive summation (i.e., "simple" summation) is performant, but can incur significant numerical error. If performance is paramount and error tolerated, using ordinary recursive summation to compute the arithmetic mean is acceptable; in all other cases, exercise due caution.
8483

8584
</section>
8685

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
import { float32ndarray } from '@stdlib/types/ndarray';
2424

2525
/**
26-
* Computes the arithmetic mean of a single-precision floating-point ndarray using ordinary recursive summation with extended accumulation.
26+
* Computes the arithmetic mean of a one-dimensional single-precision floating-point ndarray using ordinary recursive summation with extended accumulation.
2727
*
2828
* @param arrays - array-like object containing an input ndarray
2929
* @returns arithmetic mean

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
'use strict';
2020

2121
/**
22-
* Compute the arithmetic mean of a single-precision floating-point ndarray using ordinary recursive summation with extended accumulation.
22+
* Compute the arithmetic mean of a one-dimensional single-precision floating-point ndarray using ordinary recursive summation with extended accumulation.
2323
*
2424
* @module @stdlib/stats/base/ndarray/sdsmeanors
2525
*

lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@stdlib/stats/base/ndarray/sdsmeanors",
33
"version": "0.0.0",
4-
"description": "Compute the arithmetic mean of a single-precision floating-point ndarray using ordinary recursive summation with extended accumulation.",
4+
"description": "Compute the arithmetic mean of a one-dimensional single-precision floating-point ndarray using ordinary recursive summation with extended accumulation.",
55
"license": "Apache-2.0",
66
"author": {
77
"name": "The Stdlib Authors",

0 commit comments

Comments
 (0)