docs: clean-up examples and descriptions

Ref: #1339

Author: kgryte

lib/node_modules/@stdlib/array/base/count-same-value/README.md

@@ -20,7 +20,7 @@ limitations under the License.
 
 # countSameValue
 
-> Count the number of elements that are equal to a given value in an array.
+> Count the number of elements in an array that are equal to a specified value.
 
 <!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
 
@@ -42,7 +42,7 @@ var countSameValue = require( '@stdlib/array/base/count-same-value' );
 
 #### countSameValue( x, value )
 
-Counts the number of elements that are equal to a given value in an array.
+Counts the number of elements in an array that are equal to a specified value.
 
 ```javascript
 var x = [ 0, 1, 0, 1, 2 ];
@@ -72,10 +72,12 @@ var out = countSameValue( x, 1 );
 <!-- eslint no-undef: "error" -->
 
 ```javascript
-var sample = require( '@stdlib/random/sample' );
+var bernoulli = require( '@stdlib/random/array/bernoulli' );
 var countSameValue = require( '@stdlib/array/base/count-same-value' );
 
-var x = sample( [ 1, 2, 3, 4, 5 ] );
+var x = bernoulli( 10, 0.5, {
+    'dtype': 'generic'
+});
 console.log( x );
 
 var n = countSameValue( x, 1 );

lib/node_modules/@stdlib/array/base/count-same-value/docs/repl.txt

@@ -1,6 +1,7 @@
 
 {{alias}}( x, value )
-    Counts the number of elements that are equal to a given value in an array.
+    Counts the number of elements in an array that are equal to a specified
+    value.
 
     Parameters
     ----------
@@ -13,7 +14,7 @@
     Returns
     -------
     out: integer
-        Number of elements that are equal to the given value.
+        Number of elements that are equal to the specified value.
 
     Examples
     --------

lib/node_modules/@stdlib/array/base/count-same-value/docs/types/index.d.ts

@@ -23,11 +23,11 @@
 import { Collection } from '@stdlib/types/array';
 
 /**
-* Counts the number of elements that are equal to a given value in an array.
+* Counts the number of elements in an array that are equal to a specified value.
 *
 * @param x - input array
-* @param value - given value
-* @returns number of elements that are equal to the given value
+* @param value - search value
+* @returns number of elements that are equal to a specified value
 *
 * @example
 * var x = [ 0, 1, 0, 1, 1 ];

lib/node_modules/@stdlib/array/base/count-same-value/examples/index.js

@@ -18,10 +18,12 @@
 
 'use strict';
 
-var sample = require( '@stdlib/random/sample' );
+var bernoulli = require( '@stdlib/random/array/bernoulli' );
 var countSameValue = require( './../lib' );
 
-var x = sample( [ 1, 2, 3, 4, 5 ] );
+var x = bernoulli( 10, 0.5, {
+	'dtype': 'generic'
+});
 console.log( x );
 
 var n = countSameValue( x, 1 );

lib/node_modules/@stdlib/array/base/count-same-value/lib/index.js

@@ -19,7 +19,7 @@
 'use strict';
 
 /**
-* Count the number of elements that are equal to a given value in an array.
+* Count the number of elements in an array that are equal to a specified value.
 *
 * @module @stdlib/array/base/count-same-value
 *

lib/node_modules/@stdlib/array/base/count-same-value/lib/main.js

@@ -21,30 +21,30 @@
 // MODULES //
 
 var isComplexLike = require( '@stdlib/assert/is-complex-like' );
-var real = require( '@stdlib/complex/real' );
-var imag = require( '@stdlib/complex/imag' );
 var reinterpret = require( '@stdlib/strided/base/reinterpret-complex' );
 var isComplexTypedArray = require( '@stdlib/array/base/assert/is-complex-typed-array' );
 var isAccessorArray = require( '@stdlib/array/base/assert/is-accessor-array' );
 var resolveGetter = require( '@stdlib/array/base/resolve-getter' );
 var isSameValue = require( '@stdlib/assert/is-same-value' );
+var real = require( '@stdlib/complex/real' );
+var imag = require( '@stdlib/complex/imag' );
 
 
 // FUNCTIONS //
 
 /**
-* Counts the number of elements that are equal to a given value in an indexed array.
+* Counts the number of elements in an array that are equal to a specified value.
 *
 * @private
 * @param {Collection} x - input array
-* @param {*} value - given value
-* @returns {NonNegativeInteger} number of elements that are equal to the given value
+* @param {*} value - search value
+* @returns {NonNegativeInteger} number of elements that are equal to a specified value
 *
 * @example
-* var x = [ 0, 1, 0, 1 ];
+* var x = [ 0, 1, 0, 1, 1 ];
 *
 * var n = indexed( x, 1 );
-* // returns 2
+* // returns 3
 */
 function indexed( x, value ) {
 	var n;
@@ -60,20 +60,20 @@ function indexed( x, value ) {
 }
 
 /**
-* Counts the number of elements that are equal to a given value in an accessor array.
+* Counts the number of elements in an accessor array that are equal to a specified value.
 *
 * @private
 * @param {Collection} x - input array
-* @param {*} value - given value
-* @returns {NonNegativeInteger} number of elements that are equal to the given value
+* @param {*} value - search value
+* @returns {NonNegativeInteger} number of elements that are equal to a provided value
 *
 * @example
 * var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' );
 *
-* var x = toAccessorArray( [ 0, 1, 0, 1 ] );
+* var x = toAccessorArray( [ 0, 1, 0, 1, 1 ] );
 *
 * var n = accessors( x, 1 );
-* // returns 2
+* // returns 3
 */
 function accessors( x, value ) {
 	var get;
@@ -92,16 +92,16 @@ function accessors( x, value ) {
 }
 
 /**
-* Counts the number of elements that are equal to a given value in a complex array.
+* Counts the number of elements in a complex array that are equal to a specified value.
 *
 * @private
 * @param {Collection} x - input array
-* @param {*} value - given value
-* @returns {NonNegativeInteger} number of elements that are equal to the given value
+* @param {*} value - search value
+* @returns {NonNegativeInteger} number of elements that are equal to a specified value
 *
 * @example
-* var Complex128 = require( '@stdlib/complex/float64' );
 * var Complex128Array = require( '@stdlib/array/complex128' );
+* var Complex128 = require( '@stdlib/complex/float64' );
 *
 * var x = new Complex128Array( [ 1.0, 2.0, 0.0, 0.0, 3.0, 4.0, 0.0, 0.0 ] );
 *
@@ -118,15 +118,14 @@ function complex( x, value ) {
 	if ( !isComplexLike( value ) ) {
 		return 0;
 	}
-
 	re = real( value );
 	im = imag( value );
 
 	view = reinterpret( x, 0 );
 
 	n = 0;
 	for ( i = 0; i < view.length; i += 2 ) {
-		if ( isSameValue( view[ i ], re ) && isSameValue( view[ i + 1 ], im ) ) {
+		if ( isSameValue( view[ i ], re ) && isSameValue( view[ i+1 ], im ) ) {
 			n += 1;
 		}
 	}
@@ -137,11 +136,11 @@ function complex( x, value ) {
 // MAIN //
 
 /**
-* Counts the number of elements that are equal to a given value in an array.
+* Counts the number of elements in an array that are equal to a specified value.
 *
 * @param {Collection} x - input array
-* @param {*} value - given value
-* @returns {NonNegativeInteger} number of elements that are equal to the given value
+* @param {*} value - search value
+* @returns {NonNegativeInteger} number of elements that are equal to a specified value
 *
 * @example
 * var x = [ 0, 1, 0, 1, 1 ];

lib/node_modules/@stdlib/array/base/count-same-value/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stdlib/array/base/count-same-value",
   "version": "0.0.0",
-  "description": "Count the number of elements that are equal to a given value in an array.",
+  "description": "Count the number of elements in an array that are equal to a specified value.",
   "license": "Apache-2.0",
   "author": {
     "name": "The Stdlib Authors",
@@ -60,6 +60,7 @@
     "summation",
     "countif",
     "total",
-    "same"
+    "same",
+    "equal"
   ]
 }

lib/node_modules/@stdlib/array/base/count-same-value/test/test.js

@@ -56,10 +56,15 @@ tape( 'the function distinguishes between positive and negative zeros (generic)'
 	var x;
 
 	x = [ 0.0, -0.0, 0.0, -0.0, 0.0, NaN, 1.0 ];
+
 	expected = 3;
 	actual = countSameValue( x, 0.0 );
+	t.strictEqual( actual, expected, 'returns expected value' );
 
+	expected = 2;
+	actual = countSameValue( x, -0.0 );
 	t.strictEqual( actual, expected, 'returns expected value' );
+
 	t.end();
 });
 
@@ -68,7 +73,7 @@ tape( 'the function considers all NaN values to be identical (generic)', functio
 	var actual;
 	var x;
 
-	x = [ NaN, 0, NaN, 2, NaN, 9, NaN ];
+	x = [ NaN, 0.0, NaN, 2.0, NaN, 9.0, NaN ];
 	expected = 4;
 	actual = countSameValue( x, NaN );
 
@@ -95,10 +100,15 @@ tape( 'the function distinguishes between positive and negative zeros (accessors
 	var x;
 
 	x = toAccessorArray( [ 0.0, -0.0, 0.0, -0.0, 0.0, NaN, 1.0 ] );
+
 	expected = 3;
 	actual = countSameValue( x, 0.0 );
+	t.strictEqual( actual, expected, 'returns expected value' );
 
+	expected = 2;
+	actual = countSameValue( x, -0.0 );
 	t.strictEqual( actual, expected, 'returns expected value' );
+
 	t.end();
 });
 
@@ -107,7 +117,7 @@ tape( 'the function considers all NaN values to be identical (accessors)', funct
 	var actual;
 	var x;
 
-	x = toAccessorArray( [ NaN, 0, NaN, 2, NaN, 9, NaN ] );
+	x = toAccessorArray( [ NaN, 0.0, NaN, 2.0, NaN, 9.0, NaN ] );
 	expected = 4;
 	actual = countSameValue( x, NaN );
 
@@ -134,10 +144,15 @@ tape( 'the function distinguishes between positive and negative zeros (real type
 	var x;
 
 	x = new Float32Array( [ 0.0, -0.0, 0.0, -0.0, 0.0, NaN, 1.0 ] );
+
 	expected = 3;
 	actual = countSameValue( x, 0.0 );
+	t.strictEqual( actual, expected, 'returns expected value' );
 
+	expected = 2;
+	actual = countSameValue( x, -0.0 );
 	t.strictEqual( actual, expected, 'returns expected value' );
+
 	t.end();
 });
 
@@ -146,7 +161,7 @@ tape( 'the function considers all NaN values to be identical (real typed array)'
 	var actual;
 	var x;
 
-	x = new Float32Array( [ NaN, 0, NaN, 2, NaN, 9, NaN ] );
+	x = new Float32Array( [ NaN, 0.0, NaN, 2.0, NaN, 9.0, NaN ] );
 	expected = 4;
 	actual = countSameValue( x, NaN );
 
@@ -172,7 +187,7 @@ tape( 'the function distinguishes between positive and negative zeros (complex t
 	var actual;
 	var x;
 
-	x = new Complex128Array( [ 0.0, -0.0, 0.0, -0.0, 0.0, 0.0, -0.0, -0.0, -0.0, 0.0 ] );
+	x = new Complex128Array( [ 0.0, -0.0, 0.0, -0.0, 0.0, 0.0, -0.0, -0.0, -0.0, 0.0 ] ); // eslint-disable-line max-len
 	expected = 2;
 	actual = countSameValue( x, new Complex128( 0.0, -0.0 ) );