toni

Toni

Toni, a simple and efficient bitmap implementation for positive integer sets (max 32 bits), with no element repetition, using bitwise operations and a Buffer.

Modifying a single bit instead of an entire byte, to signal item presence in the current set, obviously saves 87.5% of Buffer space, but it also implies a gain greater than 200% in performances, for accessing values, when it was used with big integer ranges.

See BitArray.

###Install

$ npm install toni [-g]

require:

var Toni  = require( 'toni' );

###Run Tests

install devDependencies :

 $ cd toni/
 # to update devDependencies, use 'npm update --dev'
 $ npm install --dev
 # run tests
 $ npm test

###Run Benchmarks

run benchmarks for Toni.

$ cd toni/
$ npm run bench

###Constructor

Toni( [ Object opt ] )
// or
new Toni( [ Object opt ] )

####Options

Default options are listed.

opt = {
    // minimun range is 8 items/bits (1 byte), max is 2^32 (4 bytes)
    range : 8
}

###Properties

 /*
  * Instance configuration object.
  */
 Toni.options : Object

 /*
  * the bitmap buffer.
  */
 Toni.btable : Buffer

 /*
  * current items in the set.
  */
 Toni.items : Number

/*
  * a shortcut for the bitmap buffer length.
  */
 Toni.btlen : Number

###Methods

Arguments within [ ] are optional.

/*
 * Clear the bitmap / set (filling with 0's).
 */
Toni#clear : function () : Toni

/*
 * Add an integer value to the set and test item/value presence in the set.
 * When the value is out of range, or if the element is already present, the
 * operation fails and it returns -1.
 *
 */
Toni#add : function ( Number value ) : Number

/*
 * Remove an integer value from the set and test item/value presence in the set.
 * When the value is out of range, or if the element is not in the set,
 * the operation fails and it returns -1.
 */
Toni#del : function ( Number value ) : Number

MIT License

Copyright (c) 2014 < Guglielmo Ferri : [e-mail] >

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 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.