Skip to content

Commit

Permalink
cleaner README
Browse files Browse the repository at this point in the history
  • Loading branch information
make-github-pseudonymous-again committed Apr 10, 2015
1 parent 381062e commit f6380bf
Showing 1 changed file with 24 additions and 19 deletions.
43 changes: 24 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,19 @@ Comparison code bricks for JavaScript.
[![NPM downloads per month](http://img.shields.io/npm/dm/aureooms-js-compare.svg?style=flat)](https://www.npmjs.org/package/aureooms-js-compare)
[![GitHub issues](http://img.shields.io/github/issues/aureooms/js-compare.svg?style=flat)](https://github.com/aureooms/js-compare/issues)

Example usage:
Can be managed through [bower](https://github.com/bower/bower),
[component](https://github.com/componentjs/component), or
[npm](https://github.com/npm/npm).

```javascript
var compare , increasing , decreasing , lexicographical , reverselexicographical ;
```js
let compare = require( "aureooms-js-compare" ) ;
```

compare = require( "aureooms-js-compare" ) ;
Example usage:

increasing = compare.increasing ;
decreasing = compare.decreasing ;
```js
let increasing = compare.increasing ;
let decreasing = compare.decreasing ;

increasing( 1 , 1 ) === 0 ; // true
increasing( 1 , 2 ) < 0 ; // true
Expand All @@ -31,7 +35,7 @@ decreasing( 1 , 1 ) === 0 ; // true
decreasing( 1 , 2 ) > 0 ; // true
decreasing( 2 , 1 ) < 0 ; // true

lexicographical = compare.lexicographical( increasing ) ;
let lexicographical = compare.lexicographical( increasing ) ;

lexicographical( [ 1 , 1 ] , [ 1 , 1 ] ) === 0 ; // true
lexicographical( [ 1 , 1 ] , [ 1 , 2 ] ) < 0 ; // true
Expand All @@ -42,7 +46,7 @@ lexicographical( [ 1 , 1 , 1 ] , [ 1 , 1 ] ) > 0 ; // true
lexicographical( [ 2 , 1 ] , [ 1 , 1 , 1 ] ) > 0 ; // true
lexicographical( [ 1 , 1 , 1 ] , [ 2 , 1 ] ) < 0 ; // true

reverselexicographical = compare.reverse( lexicographical ) ;
let reverselexicographical = compare.reverse( lexicographical ) ;

reverselexicographical( [ 1 , 1 ] , [ 1 , 1 ] ) === 0 ; // true
reverselexicographical( [ 1 , 1 ] , [ 1 , 2 ] ) > 0 ; // true
Expand All @@ -56,24 +60,25 @@ reverselexicographical( [ 1 , 1 , 1 ] , [ 2 , 1 ] ) > 0 ; // true
// ... and many more variants.

/** compare backwards, if identical compare length */
increasing = compare.colexicographical( compare.increasing ) ;
let increasing = compare.colexicographical( compare.increasing ) ;
/** compare length first, if identical compare forwards */
increasing = compare.quasilexicographical( compare.increasing ) ;
let increasing = compare.quasilexicographical( compare.increasing ) ;
/** compare length first, if identical compare backwards */
increasing = compare.quasicolexicographical( compare.increasing ) ;
let increasing = compare.quasicolexicographical( compare.increasing ) ;
/** compare components in range [0, 3[, forwards */
increasing = compare.fixedlexicographical( compare.increasing , 3 ) ;
let increasing = compare.fixedlexicographical( compare.increasing , 3 ) ;
/** compare components in range [0, 3[, backwards */
increasing = compare.fixedcolexicographical( compare.increasing , 3 ) ;
let increasing = compare.fixedcolexicographical( compare.increasing , 3 ) ;
/** compare components in range [1, 4[, forwards */
increasing = compare.rangedlexicographical( compare.increasing , 1 , 4 ) ;
let increasing = compare.rangedlexicographical( compare.increasing , 1 , 4 ) ;
/** compare components in range [1, 4[, backwards */
increasing = compare.rangedcolexicographical( compare.increasing , 1 , 4 ) ;
let increasing = compare.rangedcolexicographical( compare.increasing , 1 , 4 ) ;

// Also includes comparison function creation tools, Hereunder, all versions are equivalent.
increasing = compare.fn( compare.increasing , function ( item ) { return item.length ; } )
increasing = compare.attr( compare.increasing , "length" )
increasing = compare.len( compare.increasing )
// Also includes comparison function creation tools. Hereunder, all versions are equivalent.
let operator = require( "aureooms-js-operator" ) ;
let increasing = compare.fn( compare.increasing , operator.len ) ;
let increasing = compare.attr( compare.increasing , "length" ) ;
let increasing = compare.len( compare.increasing ) ;

// Plus an additional useful tool.
compare.sign( -2378 ) === -1 ; // true
Expand Down

0 comments on commit f6380bf

Please sign in to comment.