docs: update function description in JS benchmarks in stats/base/*

aayush0325 · web-flow · commit b78e8ba6bdd1 · 2025-02-09T01:55:05.000-08:00
PR-URL: #5135 Reviewed-by: Athan Reines <kgryte@gmail.com>
diff --git a/lib/node_modules/@stdlib/stats/base/dnanmax/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dnanmax/benchmark/benchmark.js
@@ -33,7 +33,7 @@ var dnanmax = require( './../lib/dnanmax.js' );
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
 * @returns {number} random number or `NaN`
diff --git a/lib/node_modules/@stdlib/stats/base/dnanmax/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dnanmax/benchmark/benchmark.native.js
@@ -42,7 +42,7 @@ var opts = {
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
 * @returns {number} random number or `NaN`
diff --git a/lib/node_modules/@stdlib/stats/base/dnanmax/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/base/dnanmax/benchmark/benchmark.ndarray.js
@@ -33,7 +33,7 @@ var dnanmax = require( './../lib/ndarray.js' );
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
 * @returns {number} random number or `NaN`
diff --git a/lib/node_modules/@stdlib/stats/base/dnanmax/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/stats/base/dnanmax/benchmark/benchmark.ndarray.native.js
@@ -42,7 +42,7 @@ var opts = {
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
 * @returns {number} random number or `NaN`
diff --git a/lib/node_modules/@stdlib/stats/base/dnanmaxabs/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dnanmaxabs/benchmark/benchmark.js
@@ -33,7 +33,7 @@ var dnanmaxabs = require( './../lib/dnanmaxabs.js' );
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
 * @returns {number} random number or `NaN`
diff --git a/lib/node_modules/@stdlib/stats/base/dnanmaxabs/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dnanmaxabs/benchmark/benchmark.native.js
@@ -42,7 +42,7 @@ var opts = {
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
 * @returns {number} random number or `NaN`
diff --git a/lib/node_modules/@stdlib/stats/base/dnanmaxabs/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/base/dnanmaxabs/benchmark/benchmark.ndarray.js
@@ -33,7 +33,7 @@ var dnanmaxabs = require( './../lib/ndarray.js' );
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
 * @returns {number} random number or `NaN`
diff --git a/lib/node_modules/@stdlib/stats/base/dnanmaxabs/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/stats/base/dnanmaxabs/benchmark/benchmark.ndarray.native.js
@@ -42,7 +42,7 @@ var opts = {
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
 * @returns {number} random number or `NaN`
diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpw/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpw/benchmark/benchmark.js
@@ -33,7 +33,7 @@ var dnanmeanpw = require( './../lib/dnanmeanpw.js' );
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
 * @returns {number} random number or `NaN`
diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpw/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpw/benchmark/benchmark.native.js
@@ -42,7 +42,7 @@ var opts = {
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
 * @returns {number} random number or `NaN`
diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpw/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpw/benchmark/benchmark.ndarray.js
@@ -33,7 +33,7 @@ var dnanmeanpw = require( './../lib/ndarray.js' );
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
 * @returns {number} random number or `NaN`
diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpw/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpw/benchmark/benchmark.ndarray.native.js
@@ -42,7 +42,7 @@ var opts = {
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
 * @returns {number} random number or `NaN`
diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanwd/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dnanmeanwd/benchmark/benchmark.js
@@ -33,7 +33,7 @@ var dnanmeanwd = require( './../lib/dnanmeanwd.js' );
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
 * @returns {number} random number or `NaN`
diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanwd/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dnanmeanwd/benchmark/benchmark.native.js
@@ -42,7 +42,7 @@ var opts = {
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
 * @returns {number} random number or `NaN`
diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanwd/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/base/dnanmeanwd/benchmark/benchmark.ndarray.js
@@ -33,7 +33,7 @@ var dnanmeanwd = require( './../lib/ndarray.js' );
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
 * @returns {number} random number or `NaN`
diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanwd/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/stats/base/dnanmeanwd/benchmark/benchmark.ndarray.native.js
@@ -42,7 +42,7 @@ var opts = {
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
 * @returns {number} random number or `NaN`
diff --git a/lib/node_modules/@stdlib/stats/base/dnanmin/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dnanmin/benchmark/benchmark.js
@@ -33,7 +33,7 @@ var dnanmin = require( './../lib/dnanmin.js' );
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
 * @returns {number} random number or `NaN`
diff --git a/lib/node_modules/@stdlib/stats/base/dnanmin/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dnanmin/benchmark/benchmark.native.js
@@ -42,7 +42,7 @@ var opts = {
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
 * @returns {number} random number or `NaN`
diff --git a/lib/node_modules/@stdlib/stats/base/dnanmin/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/base/dnanmin/benchmark/benchmark.ndarray.js
@@ -33,7 +33,7 @@ var dnanmin = require( './../lib/ndarray.js' );
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
 * @returns {number} random number or `NaN`
diff --git a/lib/node_modules/@stdlib/stats/base/dnanmin/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/stats/base/dnanmin/benchmark/benchmark.ndarray.native.js
@@ -42,7 +42,7 @@ var opts = {
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
 * @returns {number} random number or `NaN`
diff --git a/lib/node_modules/@stdlib/stats/base/dnanminabs/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dnanminabs/benchmark/benchmark.js
@@ -33,7 +33,7 @@ var dnanminabs = require( './../lib/dnanminabs.js' );
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
 * @returns {number} random number or `NaN`
diff --git a/lib/node_modules/@stdlib/stats/base/dnanminabs/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dnanminabs/benchmark/benchmark.native.js
@@ -42,7 +42,7 @@ var opts = {
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
 * @returns {number} random number or `NaN`
diff --git a/lib/node_modules/@stdlib/stats/base/dnanminabs/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/base/dnanminabs/benchmark/benchmark.ndarray.js
@@ -33,7 +33,7 @@ var dnanminabs = require( './../lib/ndarray.js' );
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
 * @returns {number} random number or `NaN`
diff --git a/lib/node_modules/@stdlib/stats/base/dnanminabs/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/stats/base/dnanminabs/benchmark/benchmark.ndarray.native.js
@@ -42,7 +42,7 @@ var opts = {
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
 * @returns {number} random number or `NaN`
diff --git a/lib/node_modules/@stdlib/stats/base/dnanrange/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dnanrange/benchmark/benchmark.js
@@ -33,7 +33,7 @@ var dnanrange = require( './../lib/dnanrange.js' );
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
 * @returns {number} random number or `NaN`
diff --git a/lib/node_modules/@stdlib/stats/base/dnanrange/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dnanrange/benchmark/benchmark.native.js
@@ -42,7 +42,7 @@ var opts = {
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
 * @returns {number} random number or `NaN`
diff --git a/lib/node_modules/@stdlib/stats/base/dnanrange/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/base/dnanrange/benchmark/benchmark.ndarray.js
@@ -33,7 +33,7 @@ var dnanrange = require( './../lib/ndarray.js' );
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
 * @returns {number} random number or `NaN`
diff --git a/lib/node_modules/@stdlib/stats/base/dnanrange/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/stats/base/dnanrange/benchmark/benchmark.ndarray.native.js
@@ -42,7 +42,7 @@ var opts = {
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
 * @returns {number} random number or `NaN`
diff --git a/lib/node_modules/@stdlib/stats/base/snanmax/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/snanmax/benchmark/benchmark.js
@@ -33,7 +33,7 @@ var snanmax = require( './../lib/snanmax.js' );
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
 * @returns {number} random number or `NaN`
diff --git a/lib/node_modules/@stdlib/stats/base/snanmax/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/snanmax/benchmark/benchmark.native.js
@@ -42,7 +42,7 @@ var opts = {
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
 * @returns {number} random number or `NaN`
diff --git a/lib/node_modules/@stdlib/stats/base/snanmax/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/base/snanmax/benchmark/benchmark.ndarray.js
@@ -33,7 +33,7 @@ var snanmax = require( './../lib/ndarray.js' );
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
 * @returns {number} random number or `NaN`
diff --git a/lib/node_modules/@stdlib/stats/base/snanmax/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/stats/base/snanmax/benchmark/benchmark.ndarray.native.js
@@ -42,7 +42,7 @@ var opts = {
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
 * @returns {number} random number or `NaN`
diff --git a/lib/node_modules/@stdlib/stats/base/snanmaxabs/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/snanmaxabs/benchmark/benchmark.js
@@ -33,7 +33,7 @@ var snanmaxabs = require( './../lib/snanmaxabs.js' );
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
 * @returns {number} random number or `NaN`
diff --git a/lib/node_modules/@stdlib/stats/base/snanmaxabs/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/snanmaxabs/benchmark/benchmark.native.js
@@ -42,7 +42,7 @@ var opts = {
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
 * @returns {number} random number or `NaN`
diff --git a/lib/node_modules/@stdlib/stats/base/snanmaxabs/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/base/snanmaxabs/benchmark/benchmark.ndarray.js
@@ -33,7 +33,7 @@ var snanmaxabs = require( './../lib/ndarray.js' );
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
 * @returns {number} random number or `NaN`
diff --git a/lib/node_modules/@stdlib/stats/base/snanmaxabs/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/stats/base/snanmaxabs/benchmark/benchmark.ndarray.native.js
@@ -42,7 +42,7 @@ var opts = {
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
 * @returns {number} random number or `NaN`
diff --git a/lib/node_modules/@stdlib/stats/base/snanmeanors/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/snanmeanors/benchmark/benchmark.js
@@ -33,7 +33,7 @@ var snanmeanors = require( './../lib/snanmeanors.js' );
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
 * @returns {number} random number or `NaN`
diff --git a/lib/node_modules/@stdlib/stats/base/snanmeanors/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/snanmeanors/benchmark/benchmark.native.js
@@ -42,7 +42,7 @@ var opts = {
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
 * @returns {number} random number or `NaN`
diff --git a/lib/node_modules/@stdlib/stats/base/snanmeanors/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/base/snanmeanors/benchmark/benchmark.ndarray.js
@@ -33,7 +33,7 @@ var snanmeanors = require( './../lib/ndarray.js' );
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
 * @returns {number} random number or `NaN`
diff --git a/lib/node_modules/@stdlib/stats/base/snanmeanors/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/stats/base/snanmeanors/benchmark/benchmark.ndarray.native.js
@@ -42,7 +42,7 @@ var opts = {
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
 * @returns {number} random number or `NaN`
diff --git a/lib/node_modules/@stdlib/stats/base/snanmin/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/snanmin/benchmark/benchmark.js
@@ -33,7 +33,7 @@ var snanmin = require( './../lib/snanmin.js' );
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
 * @returns {number} random number or `NaN`
diff --git a/lib/node_modules/@stdlib/stats/base/snanmin/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/snanmin/benchmark/benchmark.native.js
@@ -42,7 +42,7 @@ var opts = {
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
 * @returns {number} random number or `NaN`
diff --git a/lib/node_modules/@stdlib/stats/base/snanmin/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/base/snanmin/benchmark/benchmark.ndarray.js
@@ -33,7 +33,7 @@ var snanmin = require( './../lib/ndarray.js' );
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
 * @returns {number} random number or `NaN`
diff --git a/lib/node_modules/@stdlib/stats/base/snanmin/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/stats/base/snanmin/benchmark/benchmark.ndarray.native.js
@@ -42,7 +42,7 @@ var opts = {
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
 * @returns {number} random number or `NaN`
diff --git a/lib/node_modules/@stdlib/stats/base/snanminabs/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/snanminabs/benchmark/benchmark.js
diff --git a/lib/node_modules/@stdlib/stats/base/snanminabs/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/snanminabs/benchmark/benchmark.native.js
diff --git a/lib/node_modules/@stdlib/stats/base/snanminabs/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/base/snanminabs/benchmark/benchmark.ndarray.js
diff --git a/lib/node_modules/@stdlib/stats/base/snanminabs/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/stats/base/snanminabs/benchmark/benchmark.ndarray.native.js
diff --git a/lib/node_modules/@stdlib/stats/base/snanrange/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/snanrange/benchmark/benchmark.js
diff --git a/lib/node_modules/@stdlib/stats/base/snanrange/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/snanrange/benchmark/benchmark.native.js
diff --git a/lib/node_modules/@stdlib/stats/base/snanrange/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/base/snanrange/benchmark/benchmark.ndarray.js
diff --git a/lib/node_modules/@stdlib/stats/base/snanrange/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/stats/base/snanrange/benchmark/benchmark.ndarray.native.js

Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ var dnanmax = require( './../lib/dnanmax.js' );`
`33`	`33`	`// FUNCTIONS //`
`34`	`34`
`35`	`35`	`/**`
`36`		-* Returns a random value or `NaN`.
	`36`	`+* Returns a random number.`
`37`	`37`	`*`
`38`	`38`	`* @private`
`39`	`39`	* @returns {number} random number or `NaN`
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ var opts = {`
`42`	`42`	`// FUNCTIONS //`
`43`	`43`
`44`	`44`	`/**`
`45`		-* Returns a random value or `NaN`.
	`45`	`+* Returns a random number.`
`46`	`46`	`*`
`47`	`47`	`* @private`
`48`	`48`	* @returns {number} random number or `NaN`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ var dnanmaxabs = require( './../lib/dnanmaxabs.js' );`
`33`	`33`	`// FUNCTIONS //`
`34`	`34`
`35`	`35`	`/**`
`36`		-* Returns a random value or `NaN`.
	`36`	`+* Returns a random number.`
`37`	`37`	`*`
`38`	`38`	`* @private`
`39`	`39`	* @returns {number} random number or `NaN`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ var dnanmeanpw = require( './../lib/dnanmeanpw.js' );`
`33`	`33`	`// FUNCTIONS //`
`34`	`34`
`35`	`35`	`/**`
`36`		-* Returns a random value or `NaN`.
	`36`	`+* Returns a random number.`
`37`	`37`	`*`
`38`	`38`	`* @private`
`39`	`39`	* @returns {number} random number or `NaN`