[UPDATE] lib, tests, examples.

Author: kgryte

README.md

@@ -19,18 +19,47 @@ For use in the browser, use [browserify](https://github.com/substack/node-browse
 To use the module,
 
 ``` javascript
-var foo = require( 'compute-isnumeric' );
+var isnumeric = require( 'compute-isnumeric' );
 ```
 
-#### foo( arr )
+#### isnumeric( arr )
 
-What does this function do?
+Computes for each `array` element whether an element is numeric. The function returns an `array` with length equal to that of the input `array`. Each output `array` element is either `0` or `1`. A value of `1` means that an element is numeric and `0` means that an element is __not__ numeric.
+
+``` javascript
+var out = isnumeric( [ 5, 1/0, 'beep', 3, 9, NaN, true ] );
+// returns [ 1, 1, 0, 1, 1, 0, 0 ]
+```
 
 
 ## Examples
 
 ``` javascript
-var foo = require( 'compute-isnumeric' );
+var isnumeric = require( 'compute-isnumeric' );
+
+// Simulate some data...
+var data = new Array( 100 ),
+	len = data.length,
+	rand;
+
+// Every so often include a non-numeric value...
+for ( var i = 0; i < len; i++ ) {
+	rand = Math.random()*10;
+	if ( rand < 0.5 ) {
+		rand = null;
+	}
+	data[ i ] = rand;
+}
+
+var out = isnumeric( data );
+
+// Count the number of numeric values detected...
+var sum = 0;
+for ( var i = 0; i < len; i++ ) {
+	sum += out[ i ];
+}
+
+console.log( 'Count: %d', sum );
 ```
 
 To run the example code from the top-level application directory,

examples/index.js

@@ -1,3 +1,27 @@
 'use strict';
 
-var module = require( './../lib' );
+var isnumeric = require( './../lib' );
+
+// Simulate some data...
+var data = new Array( 100 ),
+	len = data.length,
+	rand;
+
+// Every so often include a non-numeric value...
+for ( var i = 0; i < len; i++ ) {
+	rand = Math.random()*10;
+	if ( rand < 0.5 ) {
+		rand = null;
+	}
+	data[ i ] = rand;
+}
+
+var out = isnumeric( data );
+
+// Count the number of numeric values detected...
+var sum = 0;
+for ( var i = 0; i < len; i++ ) {
+	sum += out[ i ];
+}
+
+console.log( 'Count: %d', sum );

lib/index.js

@@ -28,22 +28,34 @@
 
 'use strict';
 
-// MODULES //
-
-// var module_alias = require( 'module_name' );
-
-
-// FUNCTIONS //
+// ISNUMERIC //
 
 /**
-* FUNCTION: foo()
-*	{{ foo description }}.
+* FUNCTION: isnumeric( arr )
+*	Computes for each array element whether an element is numeric.
+*
+* @param {Array} arr - input array
+* @param {Array} array of 1s and 0s indicating if an element is numeric
 */
-function foo() {
-
-} // end FUNCTION foo()
+function isnumeric( arr ) {
+	if ( !Array.isArray( arr ) ) {
+		throw new TypeError( 'isnumeric()::invalid input argument. Must provide an array.' );
+	}
+	var len = arr.length,
+		out = new Array( len ),
+		val;
+
+	for ( var i = 0; i < len; i++ ) {
+		out[ i ] = 0;
+		val = arr[ i ];
+		if ( typeof val === 'number' && val === val ) {
+			out[ i ] = 1;
+		}
+	}
+	return out;
+} // end FUNCTION isnumeric()
 
 
 // EXPORTS //
 
-module.exports = foo;
+module.exports = isnumeric;

package.json

@@ -25,7 +25,17 @@
   "keywords": [
     "compute.io",
     "compute",
-    "computation"
+    "computation",
+    "array",
+    "utilities",
+    "utils",
+    "isnumeric",
+    "numeric",
+    "logical",
+    "mathematics",
+    "math",
+    "statistics",
+    "stats"
   ],
   "bugs": {
     "url": "https://github.com/compute-io/isnumeric/issues"

test/test.js

@@ -6,7 +6,7 @@ var // Expectation library:
 	chai = require( 'chai' ),
 
 	// Module to be tested:
-	lib = require( './../lib' );
+	isnumeric = require( './../lib' );
 
 
 // VARIABLES //
@@ -20,9 +20,41 @@ var expect = chai.expect,
 describe( 'compute-isnumeric', function tests() {
 
 	it( 'should export a function', function test() {
-		expect( lib ).to.be.a( 'function' );
+		expect( isnumeric ).to.be.a( 'function' );
 	});
 
-	it( 'should do something' );
+	it( 'should throw an error if not provided an array', function test() {
+		var values = [
+			'5',
+			5,
+			null,
+			undefined,
+			NaN,
+			true,
+			{},
+			function(){}
+		];
+
+		for ( var i = 0; i < values.length; i++ ) {
+			expect( badValue( values[i] ) ).to.throw( TypeError );
+		}
+
+		function badValue( value ) {
+			return function() {
+				isnumeric( value );
+			};
+		}
+	});
+
+	it( 'should compute whether each array element is numeric', function test() {
+		var data, expected, actual;
+
+		data = [ 5, 'beep', 3, 9, true, NaN, 1/0 ];
+
+		expected = [ 1, 0, 1, 1, 0, 0, 1 ];
+		actual = isnumeric( data );
+
+		assert.deepEqual( actual, expected );
+	});
 
 });