Skip to content

Commit b78e8ba

Browse files
authored
docs: update function description in JS benchmarks in stats/base/*
PR-URL: #5135 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent d226d10 commit b78e8ba

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+52
-52
lines changed

lib/node_modules/@stdlib/stats/base/dnanmax/benchmark/benchmark.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ var dnanmax = require( './../lib/dnanmax.js' );
3333
// FUNCTIONS //
3434

3535
/**
36-
* Returns a random value or `NaN`.
36+
* Returns a random number.
3737
*
3838
* @private
3939
* @returns {number} random number or `NaN`

lib/node_modules/@stdlib/stats/base/dnanmax/benchmark/benchmark.native.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ var opts = {
4242
// FUNCTIONS //
4343

4444
/**
45-
* Returns a random value or `NaN`.
45+
* Returns a random number.
4646
*
4747
* @private
4848
* @returns {number} random number or `NaN`

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ var dnanmax = require( './../lib/ndarray.js' );
3333
// FUNCTIONS //
3434

3535
/**
36-
* Returns a random value or `NaN`.
36+
* Returns a random number.
3737
*
3838
* @private
3939
* @returns {number} random number or `NaN`

lib/node_modules/@stdlib/stats/base/dnanmax/benchmark/benchmark.ndarray.native.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ var opts = {
4242
// FUNCTIONS //
4343

4444
/**
45-
* Returns a random value or `NaN`.
45+
* Returns a random number.
4646
*
4747
* @private
4848
* @returns {number} random number or `NaN`

lib/node_modules/@stdlib/stats/base/dnanmaxabs/benchmark/benchmark.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ var dnanmaxabs = require( './../lib/dnanmaxabs.js' );
3333
// FUNCTIONS //
3434

3535
/**
36-
* Returns a random value or `NaN`.
36+
* Returns a random number.
3737
*
3838
* @private
3939
* @returns {number} random number or `NaN`

lib/node_modules/@stdlib/stats/base/dnanmaxabs/benchmark/benchmark.native.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ var opts = {
4242
// FUNCTIONS //
4343

4444
/**
45-
* Returns a random value or `NaN`.
45+
* Returns a random number.
4646
*
4747
* @private
4848
* @returns {number} random number or `NaN`

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ var dnanmaxabs = require( './../lib/ndarray.js' );
3333
// FUNCTIONS //
3434

3535
/**
36-
* Returns a random value or `NaN`.
36+
* Returns a random number.
3737
*
3838
* @private
3939
* @returns {number} random number or `NaN`

lib/node_modules/@stdlib/stats/base/dnanmaxabs/benchmark/benchmark.ndarray.native.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ var opts = {
4242
// FUNCTIONS //
4343

4444
/**
45-
* Returns a random value or `NaN`.
45+
* Returns a random number.
4646
*
4747
* @private
4848
* @returns {number} random number or `NaN`

lib/node_modules/@stdlib/stats/base/dnanmeanpw/benchmark/benchmark.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ var dnanmeanpw = require( './../lib/dnanmeanpw.js' );
3333
// FUNCTIONS //
3434

3535
/**
36-
* Returns a random value or `NaN`.
36+
* Returns a random number.
3737
*
3838
* @private
3939
* @returns {number} random number or `NaN`

lib/node_modules/@stdlib/stats/base/dnanmeanpw/benchmark/benchmark.native.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ var opts = {
4242
// FUNCTIONS //
4343

4444
/**
45-
* Returns a random value or `NaN`.
45+
* Returns a random number.
4646
*
4747
* @private
4848
* @returns {number} random number or `NaN`

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ var dnanmeanpw = require( './../lib/ndarray.js' );
3333
// FUNCTIONS //
3434

3535
/**
36-
* Returns a random value or `NaN`.
36+
* Returns a random number.
3737
*
3838
* @private
3939
* @returns {number} random number or `NaN`

lib/node_modules/@stdlib/stats/base/dnanmeanpw/benchmark/benchmark.ndarray.native.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ var opts = {
4242
// FUNCTIONS //
4343

4444
/**
45-
* Returns a random value or `NaN`.
45+
* Returns a random number.
4646
*
4747
* @private
4848
* @returns {number} random number or `NaN`

lib/node_modules/@stdlib/stats/base/dnanmeanwd/benchmark/benchmark.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ var dnanmeanwd = require( './../lib/dnanmeanwd.js' );
3333
// FUNCTIONS //
3434

3535
/**
36-
* Returns a random value or `NaN`.
36+
* Returns a random number.
3737
*
3838
* @private
3939
* @returns {number} random number or `NaN`

lib/node_modules/@stdlib/stats/base/dnanmeanwd/benchmark/benchmark.native.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ var opts = {
4242
// FUNCTIONS //
4343

4444
/**
45-
* Returns a random value or `NaN`.
45+
* Returns a random number.
4646
*
4747
* @private
4848
* @returns {number} random number or `NaN`

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ var dnanmeanwd = require( './../lib/ndarray.js' );
3333
// FUNCTIONS //
3434

3535
/**
36-
* Returns a random value or `NaN`.
36+
* Returns a random number.
3737
*
3838
* @private
3939
* @returns {number} random number or `NaN`

lib/node_modules/@stdlib/stats/base/dnanmeanwd/benchmark/benchmark.ndarray.native.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ var opts = {
4242
// FUNCTIONS //
4343

4444
/**
45-
* Returns a random value or `NaN`.
45+
* Returns a random number.
4646
*
4747
* @private
4848
* @returns {number} random number or `NaN`

lib/node_modules/@stdlib/stats/base/dnanmin/benchmark/benchmark.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ var dnanmin = require( './../lib/dnanmin.js' );
3333
// FUNCTIONS //
3434

3535
/**
36-
* Returns a random value or `NaN`.
36+
* Returns a random number.
3737
*
3838
* @private
3939
* @returns {number} random number or `NaN`

lib/node_modules/@stdlib/stats/base/dnanmin/benchmark/benchmark.native.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ var opts = {
4242
// FUNCTIONS //
4343

4444
/**
45-
* Returns a random value or `NaN`.
45+
* Returns a random number.
4646
*
4747
* @private
4848
* @returns {number} random number or `NaN`

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ var dnanmin = require( './../lib/ndarray.js' );
3333
// FUNCTIONS //
3434

3535
/**
36-
* Returns a random value or `NaN`.
36+
* Returns a random number.
3737
*
3838
* @private
3939
* @returns {number} random number or `NaN`

lib/node_modules/@stdlib/stats/base/dnanmin/benchmark/benchmark.ndarray.native.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ var opts = {
4242
// FUNCTIONS //
4343

4444
/**
45-
* Returns a random value or `NaN`.
45+
* Returns a random number.
4646
*
4747
* @private
4848
* @returns {number} random number or `NaN`

lib/node_modules/@stdlib/stats/base/dnanminabs/benchmark/benchmark.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ var dnanminabs = require( './../lib/dnanminabs.js' );
3333
// FUNCTIONS //
3434

3535
/**
36-
* Returns a random value or `NaN`.
36+
* Returns a random number.
3737
*
3838
* @private
3939
* @returns {number} random number or `NaN`

lib/node_modules/@stdlib/stats/base/dnanminabs/benchmark/benchmark.native.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ var opts = {
4242
// FUNCTIONS //
4343

4444
/**
45-
* Returns a random value or `NaN`.
45+
* Returns a random number.
4646
*
4747
* @private
4848
* @returns {number} random number or `NaN`

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ var dnanminabs = require( './../lib/ndarray.js' );
3333
// FUNCTIONS //
3434

3535
/**
36-
* Returns a random value or `NaN`.
36+
* Returns a random number.
3737
*
3838
* @private
3939
* @returns {number} random number or `NaN`

lib/node_modules/@stdlib/stats/base/dnanminabs/benchmark/benchmark.ndarray.native.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ var opts = {
4242
// FUNCTIONS //
4343

4444
/**
45-
* Returns a random value or `NaN`.
45+
* Returns a random number.
4646
*
4747
* @private
4848
* @returns {number} random number or `NaN`

lib/node_modules/@stdlib/stats/base/dnanrange/benchmark/benchmark.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ var dnanrange = require( './../lib/dnanrange.js' );
3333
// FUNCTIONS //
3434

3535
/**
36-
* Returns a random value or `NaN`.
36+
* Returns a random number.
3737
*
3838
* @private
3939
* @returns {number} random number or `NaN`

lib/node_modules/@stdlib/stats/base/dnanrange/benchmark/benchmark.native.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ var opts = {
4242
// FUNCTIONS //
4343

4444
/**
45-
* Returns a random value or `NaN`.
45+
* Returns a random number.
4646
*
4747
* @private
4848
* @returns {number} random number or `NaN`

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ var dnanrange = require( './../lib/ndarray.js' );
3333
// FUNCTIONS //
3434

3535
/**
36-
* Returns a random value or `NaN`.
36+
* Returns a random number.
3737
*
3838
* @private
3939
* @returns {number} random number or `NaN`

lib/node_modules/@stdlib/stats/base/dnanrange/benchmark/benchmark.ndarray.native.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ var opts = {
4242
// FUNCTIONS //
4343

4444
/**
45-
* Returns a random value or `NaN`.
45+
* Returns a random number.
4646
*
4747
* @private
4848
* @returns {number} random number or `NaN`

lib/node_modules/@stdlib/stats/base/snanmax/benchmark/benchmark.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ var snanmax = require( './../lib/snanmax.js' );
3333
// FUNCTIONS //
3434

3535
/**
36-
* Returns a random value or `NaN`.
36+
* Returns a random number.
3737
*
3838
* @private
3939
* @returns {number} random number or `NaN`

lib/node_modules/@stdlib/stats/base/snanmax/benchmark/benchmark.native.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ var opts = {
4242
// FUNCTIONS //
4343

4444
/**
45-
* Returns a random value or `NaN`.
45+
* Returns a random number.
4646
*
4747
* @private
4848
* @returns {number} random number or `NaN`

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ var snanmax = require( './../lib/ndarray.js' );
3333
// FUNCTIONS //
3434

3535
/**
36-
* Returns a random value or `NaN`.
36+
* Returns a random number.
3737
*
3838
* @private
3939
* @returns {number} random number or `NaN`

lib/node_modules/@stdlib/stats/base/snanmax/benchmark/benchmark.ndarray.native.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ var opts = {
4242
// FUNCTIONS //
4343

4444
/**
45-
* Returns a random value or `NaN`.
45+
* Returns a random number.
4646
*
4747
* @private
4848
* @returns {number} random number or `NaN`

lib/node_modules/@stdlib/stats/base/snanmaxabs/benchmark/benchmark.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ var snanmaxabs = require( './../lib/snanmaxabs.js' );
3333
// FUNCTIONS //
3434

3535
/**
36-
* Returns a random value or `NaN`.
36+
* Returns a random number.
3737
*
3838
* @private
3939
* @returns {number} random number or `NaN`

lib/node_modules/@stdlib/stats/base/snanmaxabs/benchmark/benchmark.native.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ var opts = {
4242
// FUNCTIONS //
4343

4444
/**
45-
* Returns a random value or `NaN`.
45+
* Returns a random number.
4646
*
4747
* @private
4848
* @returns {number} random number or `NaN`

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ var snanmaxabs = require( './../lib/ndarray.js' );
3333
// FUNCTIONS //
3434

3535
/**
36-
* Returns a random value or `NaN`.
36+
* Returns a random number.
3737
*
3838
* @private
3939
* @returns {number} random number or `NaN`

lib/node_modules/@stdlib/stats/base/snanmaxabs/benchmark/benchmark.ndarray.native.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ var opts = {
4242
// FUNCTIONS //
4343

4444
/**
45-
* Returns a random value or `NaN`.
45+
* Returns a random number.
4646
*
4747
* @private
4848
* @returns {number} random number or `NaN`

lib/node_modules/@stdlib/stats/base/snanmeanors/benchmark/benchmark.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ var snanmeanors = require( './../lib/snanmeanors.js' );
3333
// FUNCTIONS //
3434

3535
/**
36-
* Returns a random value or `NaN`.
36+
* Returns a random number.
3737
*
3838
* @private
3939
* @returns {number} random number or `NaN`

lib/node_modules/@stdlib/stats/base/snanmeanors/benchmark/benchmark.native.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ var opts = {
4242
// FUNCTIONS //
4343

4444
/**
45-
* Returns a random value or `NaN`.
45+
* Returns a random number.
4646
*
4747
* @private
4848
* @returns {number} random number or `NaN`

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ var snanmeanors = require( './../lib/ndarray.js' );
3333
// FUNCTIONS //
3434

3535
/**
36-
* Returns a random value or `NaN`.
36+
* Returns a random number.
3737
*
3838
* @private
3939
* @returns {number} random number or `NaN`

lib/node_modules/@stdlib/stats/base/snanmeanors/benchmark/benchmark.ndarray.native.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ var opts = {
4242
// FUNCTIONS //
4343

4444
/**
45-
* Returns a random value or `NaN`.
45+
* Returns a random number.
4646
*
4747
* @private
4848
* @returns {number} random number or `NaN`

lib/node_modules/@stdlib/stats/base/snanmin/benchmark/benchmark.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ var snanmin = require( './../lib/snanmin.js' );
3333
// FUNCTIONS //
3434

3535
/**
36-
* Returns a random value or `NaN`.
36+
* Returns a random number.
3737
*
3838
* @private
3939
* @returns {number} random number or `NaN`

lib/node_modules/@stdlib/stats/base/snanmin/benchmark/benchmark.native.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ var opts = {
4242
// FUNCTIONS //
4343

4444
/**
45-
* Returns a random value or `NaN`.
45+
* Returns a random number.
4646
*
4747
* @private
4848
* @returns {number} random number or `NaN`

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ var snanmin = require( './../lib/ndarray.js' );
3333
// FUNCTIONS //
3434

3535
/**
36-
* Returns a random value or `NaN`.
36+
* Returns a random number.
3737
*
3838
* @private
3939
* @returns {number} random number or `NaN`

lib/node_modules/@stdlib/stats/base/snanmin/benchmark/benchmark.ndarray.native.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ var opts = {
4242
// FUNCTIONS //
4343

4444
/**
45-
* Returns a random value or `NaN`.
45+
* Returns a random number.
4646
*
4747
* @private
4848
* @returns {number} random number or `NaN`

0 commit comments

Comments
 (0)