Skip to content

Commit 1f7ddee

Browse files
committed
chore: make documentation in entire package consistent
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: passed - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: missing_dependencies - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed ---
1 parent c8d8fb4 commit 1f7ddee

File tree

10 files changed

+28
-23
lines changed

10 files changed

+28
-23
lines changed

lib/node_modules/@stdlib/stats/strided/dnanmeankbn2/README.md

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

2121
# dnanmeankbn2
2222

23-
> Calculate the [arithmetic mean][arithmetic-mean] of a double-precision floating-point strided array ignoring the `NaN` values using a second-order iterative Kahan–Babuška algorithm.
23+
> Calculate the [arithmetic mean][arithmetic-mean] of a double-precision floating-point strided array, ignoring `NaN` values using a second-order iterative Kahan–Babuška algorithm.
2424
2525
<section class="intro">
2626

@@ -53,7 +53,7 @@ var dnanmeankbn2 = require( '@stdlib/stats/strided/dnanmeankbn2' );
5353

5454
#### dnanmeankbn2( N, x, strideX )
5555

56-
Computes the [arithmetic mean][arithmetic-mean] of a double-precision floating-point strided array `x`, ignoring the `NaN` values using a second-order iterative Kahan–Babuška algorithm.
56+
Computes the [arithmetic mean][arithmetic-mean] of a double-precision floating-point strided array `x`, ignoring `NaN` values using a second-order iterative Kahan–Babuška algorithm.
5757

5858
```javascript
5959
var Float64Array = require( '@stdlib/array/float64' );
@@ -98,7 +98,7 @@ var v = dnanmeankbn2( 5, x1, 2 );
9898

9999
#### dnanmeankbn2.ndarray( N, x, strideX, offsetX )
100100

101-
Computes the [arithmetic mean][arithmetic-mean] of a double-precision floating-point strided array ignoring `NaN` values using a second-order iterative Kahan–Babuška algorithm and alternative indexing semantics.
101+
Computes the [arithmetic mean][arithmetic-mean] of a double-precision floating-point strided array, ignoring `NaN` values using a second-order iterative Kahan–Babuška algorithm and alternative indexing semantics.
102102

103103
```javascript
104104
var Float64Array = require( '@stdlib/array/float64' );
@@ -191,7 +191,7 @@ console.log( v );
191191

192192
#### stdlib_strided_dnanmeankbn2( N, \*X, strideX )
193193

194-
Computes the [arithmetic mean][arithmetic-mean] of a double-precision floating-point strided array ignoring `NaN` values using a second-order iterative Kahan–Babuška algorithm.
194+
Computes the [arithmetic mean][arithmetic-mean] of a double-precision floating-point strided array, ignoring `NaN` values using a second-order iterative Kahan–Babuška algorithm.
195195

196196
```c
197197
const double x[] = { 1.0, 2.0, 0.0/0.0, 3.0, 0.0/0.0, 4.0, 5.0, 6.0, 0.0/0.0, 7.0, 8.0, 0.0/0.0 };
@@ -212,7 +212,7 @@ double stdlib_strided_dnanmeankbn2( const CBLAS_INT N, const double *X, const CB
212212

213213
#### stdlib_strided_dnanmeankbn2_ndarray( N, \*X, strideX, offsetX )
214214

215-
Computes the [arithmetic mean][arithmetic-mean] of a double-precision floating-point strided array ignoring `NaN` values using a second-order iterative Kahan–Babuška algorithm and alternative indexing semantics.
215+
Computes the [arithmetic mean][arithmetic-mean] of a double-precision floating-point strided array, ignoring `NaN` values using a second-order iterative Kahan–Babuška algorithm and alternative indexing semantics.
216216

217217
```c
218218
const double x[] = { 1.0, 2.0, 0.0/0.0, 3.0, 0.0/0.0, 4.0, 5.0, 6.0, 0.0/0.0, 7.0, 8.0, 0.0/0.0 };

lib/node_modules/@stdlib/stats/strided/dnanmeankbn2/docs/repl.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
{{alias}}( N, x, strideX )
33
Computes the arithmetic mean of a double-precision floating-point strided
4-
array, ignoring `NaN` values and using a
4+
array, ignoring `NaN` values, using a
55
second-order iterative Kahan–Babuška algorithm.
66

77
The `N` and stride parameters determine which elements in the strided array
@@ -51,7 +51,7 @@
5151

5252
{{alias}}.ndarray( N, x, strideX, offsetX )
5353
Computes the arithmetic mean of a double-precision floating-point strided
54-
array, ignoring `NaN` values and using a second-order
54+
array, ignoring `NaN` values, using a second-order
5555
iterative Kahan–Babuška algorithm and alternative indexing semantics.
5656

5757
While typed array views mandate a view offset based on the underlying

lib/node_modules/@stdlib/stats/strided/dnanmeankbn2/docs/types/index.d.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
*/
2424
interface Routine {
2525
/**
26-
* Computes the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values and using a second-order iterative Kahan–Babuška algorithm.
26+
* Computes the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values, using a second-order iterative Kahan–Babuška algorithm.
2727
*
2828
* @param N - number of indexed elements
2929
* @param x - input array
@@ -41,7 +41,7 @@ interface Routine {
4141
( N: number, x: Float64Array, strideX: number ): number;
4242

4343
/**
44-
* Computes the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values and using a second-order iterative Kahan–Babuška algorithm and alternative indexing semantics.
44+
* Computes the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values, using a second-order iterative Kahan–Babuška algorithm and alternative indexing semantics.
4545
*
4646
* @param N - number of indexed elements
4747
* @param x - input array
@@ -61,7 +61,7 @@ interface Routine {
6161
}
6262

6363
/**
64-
* Computes the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values and using a second-order iterative Kahan–Babuška algorithm.
64+
* Computes the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values, using a second-order iterative Kahan–Babuška algorithm.
6565
*
6666
* @param N - number of indexed elements
6767
* @param x - input array

lib/node_modules/@stdlib/stats/strided/dnanmeankbn2/include/stdlib/stats/strided/dnanmeankbn2.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,12 @@ extern "C" {
2929
#endif
3030

3131
/**
32-
* Computes the arithmetic mean of a double-precision floating-point strided array ignoring the `NaN` values using a second-order iterative Kahan–Babuška algorithm.
32+
* Computes the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values, using a second-order iterative Kahan–Babuška algorithm.
3333
*/
3434
double API_SUFFIX(stdlib_strided_dnanmeankbn2)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX );
3535

3636
/**
37-
* Computes the arithmetic mean of a double-precision floating-point strided array ignoring the `NaN` using a second-order iterative Kahan–Babuška algorithm and alternative indexing semantics.
37+
* Computes the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values, using a second-order iterative Kahan–Babuška algorithm and alternative indexing semantics.
3838
*/
3939
double API_SUFFIX(stdlib_strided_dnanmeankbn2_ndarray)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX );
4040

lib/node_modules/@stdlib/stats/strided/dnanmeankbn2/lib/dnanmeankbn2.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ var ndarray = require( './ndarray.js' );
2727
// MAIN //
2828

2929
/**
30-
* Computes the arithmetic mean of a double-precision floating-point strided array ignoring the `NaN` using a second-order iterative Kahan–Babuška algorithm.
30+
* Computes the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values, using a second-order iterative Kahan–Babuška algorithm.
3131
*
3232
* ## Method
3333
*

lib/node_modules/@stdlib/stats/strided/dnanmeankbn2/lib/dnanmeankbn2.native.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ var addon = require( './../src/addon.node' );
2626
// MAIN //
2727

2828
/**
29-
* Computes the arithmetic mean of a double-precision floating-point strided array ignoring the `NaN` using a second-order iterative Kahan–Babuška algorithm.
29+
* Computes the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values, using a second-order iterative Kahan–Babuška algorithm.
3030
*
3131
* @param {PositiveInteger} N - number of indexed elements
3232
* @param {Float64Array} x - input array

lib/node_modules/@stdlib/stats/strided/dnanmeankbn2/lib/ndarray.js

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,15 @@ var dnannsumkbn2 = require( '@stdlib/blas/ext/base/dnannsumkbn2' ).ndarray;
2424
var Float64Array = require( '@stdlib/array/float64' );
2525

2626

27+
// VARIABLES //
28+
29+
var WORKSPACE = new Float64Array( 2 );
30+
31+
2732
// MAIN //
2833

2934
/**
30-
* Computes the arithmetic mean of a double-precision floating-point strided array ignoring the `NaN` using a second-order iterative Kahan–Babuška algorithm.
35+
* Computes the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values, using a second-order iterative Kahan–Babuška algorithm.
3136
*
3237
* ## Method
3338
*
@@ -52,16 +57,16 @@ var Float64Array = require( '@stdlib/array/float64' );
5257
* // returns 1.25
5358
*/
5459
function dnanmeankbn2( N, x, strideX, offsetX ) {
55-
var output = new Float64Array( 2 );
56-
5760
if ( N <= 0 ) {
5861
return NaN;
5962
}
6063
if ( N === 1 || strideX === 0 ) {
6164
return x[ offsetX ];
6265
}
63-
output = dnannsumkbn2( N, x, strideX, offsetX, output, 1, 0 );
64-
return output[ 0 ] / output[ 1 ];
66+
WORKSPACE[ 0 ] = 0.0;
67+
WORKSPACE[ 1 ] = 0;
68+
dnannsumkbn2( N, x, strideX, offsetX, WORKSPACE, 1, 0 );
69+
return WORKSPACE[ 0 ] / WORKSPACE[ 1 ];
6570
}
6671

6772

lib/node_modules/@stdlib/stats/strided/dnanmeankbn2/lib/ndarray.native.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ var addon = require( './../src/addon.node' );
2626
// MAIN //
2727

2828
/**
29-
* Computes the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values and using a second-order iterative Kahan–Babuška algorithm.
29+
* Computes the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values, using a second-order iterative Kahan–Babuška algorithm.
3030
*
3131
* @param {PositiveInteger} N - number of indexed elements
3232
* @param {Float64Array} x - input array

lib/node_modules/@stdlib/stats/strided/dnanmeankbn2/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/strided/dnanmeankbn2",
33
"version": "0.0.0",
4-
"description": "Calculate the arithmetic mean of a double-precision floating-point strided array ignoring the `NaN` using a second-order iterative Kahan–Babuška algorithm.",
4+
"description": "Calculate the arithmetic mean of a double-precision floating-point strided array, ignoring NaN values, using a second-order iterative Kahan-Babuska algorithm.",
55
"license": "Apache-2.0",
66
"author": {
77
"name": "The Stdlib Authors",

lib/node_modules/@stdlib/stats/strided/dnanmeankbn2/src/main.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
#include "stdlib/strided/base/stride2offset.h"
2323

2424
/**
25-
* Computes the arithmetic mean of a double-precision floating-point strided array ignoring the `NaN` values using a second-order iterative Kahan–Babuška algorithm.
25+
* Computes the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values, using a second-order iterative Kahan–Babuška algorithm.
2626
*
2727
* ## Method
2828
*
@@ -43,7 +43,7 @@ double API_SUFFIX(stdlib_strided_dnanmeankbn2)( const CBLAS_INT N, const double
4343
}
4444

4545
/**
46-
* Computes the arithmetic mean of a double-precision floating-point strided array ignoring the `NaN` using a second-order iterative Kahan–Babuška algorithm and alternative indexing semantics.
46+
* Computes the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values, using a second-order iterative Kahan–Babuška algorithm and alternative indexing semantics.
4747
*
4848
* @param N number of indexed elements
4949
* @param X input array

0 commit comments

Comments
 (0)