Skip to content

Commit

Permalink
[UPDATE] todo + accessor
Browse files Browse the repository at this point in the history
  • Loading branch information
Planeshifter committed May 24, 2015
1 parent 6e3ba6e commit 5b1e75e
Show file tree
Hide file tree
Showing 10 changed files with 186 additions and 69 deletions.
1 change: 1 addition & 0 deletions .gitattributes
@@ -0,0 +1 @@
* text=auto
14 changes: 14 additions & 0 deletions .jshintignore
@@ -0,0 +1,14 @@

# Directories #
###############
build/
reports/
dist/

# Node.js #
###########
/node_modules/

# Git #
#######
.git*
1 change: 1 addition & 0 deletions .npmignore
Expand Up @@ -47,5 +47,6 @@ Desktop.ini
# Utilities #
#############
.jshintrc
.jshintignore
.travis.yml
.editorconfig
11 changes: 9 additions & 2 deletions .travis.yml
@@ -1,5 +1,12 @@
language: node_js
node_js:
- "0.10"
- '0.12'
- '0.11'
- '0.10'
- '0.8'
- 'iojs'
before_install:
- npm update -g npm
after_script:
- npm run coveralls
- npm run coveralls

4 changes: 2 additions & 2 deletions LICENSE
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2014 Athan Reines.
Copyright (c) 2014-2015 The Compute.io Authors. All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand All @@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
SOFTWARE.
34 changes: 27 additions & 7 deletions Makefile
Expand Up @@ -5,32 +5,42 @@
# Set the node.js environment to test:
NODE_ENV ?= test

# Kernel name:
KERNEL ?= $(shell uname -s)

ifeq ($(KERNEL), Darwin)
OPEN ?= open
else
OPEN ?= xdg-open
endif

# NOTES #

NOTES ?= 'TODO|FIXME'
NOTES ?= 'TODO|FIXME|WARNING|HACK|NOTE'


# MOCHA #

# Specify the test framework bin locations:
MOCHA ?= ./node_modules/.bin/mocha
_MOCHA ?= ./node_modules/.bin/_mocha

# Specify the mocha reporter:
MOCHA_REPORTER ?= spec


# ISTANBUL #

# Istanbul configuration:
ISTANBUL ?= ./node_modules/.bin/istanbul
ISTANBUL_OUT ?= ./reports/coverage
ISTANBUL_REPORT ?= lcov
ISTANBUL_LCOV_INFO_PATH ?= $(ISTANBUL_OUT)/lcov.info
ISTANBUL_HTML_REPORT_PATH ?= $(ISTANBUL_OUT)/lcov-report/index.html


# JSHINT #

JSHINT ?= ./node_modules/.bin/jshint
JSHINT_REPORTER ?= ./node_modules/jshint-stylish/stylish.js



# FILES #

Expand Down Expand Up @@ -96,9 +106,20 @@ test-istanbul-mocha: node_modules
view-cov: view-istanbul-report

view-istanbul-report:
open $(ISTANBUL_HTML_REPORT_PATH)
$(OPEN) $(ISTANBUL_HTML_REPORT_PATH)


# LINT #

.PHONY: lint lint-jshint

lint: lint-jshint

lint-jshint: node_modules
$(JSHINT) \
--reporter $(JSHINT_REPORTER) \
./


# NODE #

Expand All @@ -117,7 +138,6 @@ clean-node:


# CLEAN #

.PHONY: clean

clean:
Expand Down
34 changes: 26 additions & 8 deletions README.md
Expand Up @@ -16,15 +16,13 @@ For use in the browser, use [browserify](https://github.com/substack/node-browse

## Usage

To use the module,

``` javascript
var min = require( 'compute-nanmin' );
```

#### min( arr )
#### min( arr[, accessor] )

Computes the minimum value of an array ignoring non-numeric values.
Computes the minimum value of an array ignoring non-numeric values. For numeric `arrays`,

``` javascript
var data = [ 2, null, 5, 3, null, 7 ];
Expand All @@ -33,6 +31,26 @@ var val = min( data );
// returns 2
```

For non-numeric `arrays`, provide an accessor `function` for accessing numeric values

``` javascript
var arr = [
{'x':2},
{'x':null},
{'x':5},
{'x':3},
{'x':null},
{'x':7}
];

function getValue( d, i ) {
return d.x;
}

var val = max( arr, getValue );
// returns 2
```

Note: if an input `array` does not contain any numeric values, the function returns `null`.


Expand Down Expand Up @@ -66,7 +84,7 @@ $ node ./examples/index.js

### Unit

Unit tests use the [Mocha](http://visionmedia.github.io/mocha) test framework with [Chai](http://chaijs.com) assertions. To run the tests, execute the following command in the top-level application directory:
Unit tests use the [Mocha](http://mochajs.org) test framework with [Chai](http://chaijs.com) assertions. To run the tests, execute the following command in the top-level application directory:

``` bash
$ make test
Expand All @@ -90,15 +108,15 @@ $ make view-cov
```


---
## License

[MIT license](http://opensource.org/licenses/MIT).
[MIT license](http://opensource.org/licenses/MIT).


---
## Copyright

Copyright © 2014. Athan Reines.
Copyright © 2014-2015. The Compute.io Authors.


[npm-image]: http://img.shields.io/npm/v/compute-nanmin.svg
Expand Down
84 changes: 43 additions & 41 deletions lib/index.js
@@ -1,55 +1,57 @@
/**
*
* COMPUTE: nanmin
*
*
* DESCRIPTION:
* - Computes the minimum value of an array ignoring non-numeric values.
*
*
* NOTES:
* [1]
*
*
* TODO:
* [1]
*
*
* LICENSE:
* MIT
*
* Copyright (c) 2014. Athan Reines.
*
*
* AUTHOR:
* Athan Reines. kgryte@gmail.com. 2014.
*
*/

'use strict';

// MODULES //

var isArray = require( 'validate.io-array' ),
isFunction = require( 'validate.io-function' ),
isNumber = require( 'validate.io-number' );

// NANMIN //

/**
* FUNCTION: nanmin( arr )
* FUNCTION: nanmin( arr[, accessor] )
* Computes the minimum value of an array ignoring any non-numeric values.
*
* @param {Array} arr - array of values
* @returns {Number} min value
* @param {Number[]|Array} arr - array of values
* @param {Function} [accessor] - accessor function for accessing array values
* @returns {Number|Null} min value or null
*/
function nanmin( arr ) {
if ( !Array.isArray( arr ) ) {
throw new TypeError( 'nanmin()::invalid input argument. Must provide an array.' );
function nanmin( arr, clbk ) {
if ( !isArray( arr ) ) {
throw new TypeError( 'nanmin()::invalid input argument. Must provide an array. Value: `' + arr + '`.' );
}
if ( arguments.length > 1 && !isFunction( clbk ) ) {
throw new TypeError( 'nanmin()::invalid input argument. Accessor must be a function. Value: `' + clbk + '`.' );
}

var len = arr.length,
min = null,
val;
val,
i;

if ( !len ) {
return null;
}

for ( var i = 0; i < len; i++ ) {
val = arr[ i ];
if ( typeof val !== 'number' || val !== val ) {
continue;
if ( clbk ) {
for ( i = 0; i < len; i++ ) {
val = clbk( arr[ i ], i);
if ( !isNumber( val ) ) {
continue;
}
if ( min === null || val < min ) {
min = val;
}
}
if ( min === null || val < min ) {
min = val;
} else {
for ( i = 0; i < len; i++ ) {
val = arr[ i ];
if ( !isNumber( val ) ) {
continue;
}
if ( min === null || val < min ) {
min = val;
}
}
}
return min;
Expand Down
21 changes: 12 additions & 9 deletions package.json
Expand Up @@ -10,6 +10,10 @@
{
"name": "Athan Reines",
"email": "kgryte@gmail.com"
},
{
"name": "Philipp Burckhardt",
"email": "pburckhardt@outlook.com"
}
],
"scripts": {
Expand Down Expand Up @@ -39,17 +43,16 @@
"bugs": {
"url": "https://github.com/compute-io/nanmin/issues"
},
"dependencies": {},
"dependencies": {
"validate.io-array": "^1.0.5",
"validate.io-function": "^1.0.2",
"validate.io-number": "^1.0.3"
},
"devDependencies": {
"chai": "1.x.x",
"mocha": "1.x.x",
"chai": "2.x.x",
"mocha": "2.x.x",
"coveralls": "^2.11.1",
"istanbul": "^0.3.0"
},
"licenses": [
{
"type": "MIT",
"url": "http://www.opensource.org/licenses/MIT"
}
]
"licenses": "MIT"
}

0 comments on commit 5b1e75e

Please sign in to comment.