abaco

Abaco

Abaco, an ultra fast number parser for Buffers. It parses a Buffer, or a portion of it, to get the Number value stored as (ASCII) String.

It is faster than parseInt(), parseFloat() and Number() constructor to convert a String or a Buffer to a usable Number.

NOTE: It adds the ability to parse a float with a radix argument, as for #parseInt.

Install

$ npm install abaco [-g]
// clone repo
$ git clone [e-mail]:rootslab/abaco.git

require returns an helper hash/obj.

var Abaco  = require( 'abaco' );

Run Tests

$ cd abaco/
$ npm test

Run Benchmarks

$ cd abaco/
$ npm run-script bench

Sample Usage

See examples.

Methods

Arguments within [ ] are optional.

/*
 * Parse a Buffer that contains string representation of an integer Number.
 * If radix is not specified, it defaults to 10; possible radix value range
 * is between 2 and 16.
 * If begin or end are not specified, it parses the entire Buffer.
 *
 * NOTE: js number precision is limited to ~ 2^53 or 10^16, it means, for example,
 * that the limit for decimal numbers is 16 bytes/chars; so it returns NaN for
 * values out of this range. NaN also signals that is better to use raw String,
 * because number representation is not accurate. See 'bl' table in the code to
 * check bytes limit for every radix.
 *
 * NOTE: Only '-' prefix is supported, no 0x' or '0' prefix, for hex or octal
 * digits; just use the begin offset for skipping some bytes.
 *
 */
Abaco#parseInt( Buffer b [, Number radix [, Number begin [, Number end ] ] ] ) : Number

/*
 * A strict parse, it returns NaN if the number parsed, contains some symbols
 * that are not allowed for the current radix alphabet.
 *
 * Example: #xparseInt( '012', 2 ) returns NaN, 2 is not in binary alphabet.
 */
Abaco#xparseInt( Buffer b [, Number radix [, Number begin [, Number end ] ] ] ) : Number

/*
 * Parse a Buffer that contains a string representation of an integer or float Number.
 * If radix is not specified, it defaults to 10; possible radix value range
 * is between 2 and 16.
 * If begin or end are not specified, it parses the entire Buffer.
 */
Abaco#parseFloat( Buffer b [, Number radix [, Number begin [, Number end ] ] ] ) : Number

/*
 * A strict parseFloat, it returns NaN if the number parsed, contains some symbols
 * that are not allowed for the current radix alphabet.
 */
Abaco#xparseFloat( Buffer b [, Number radix [, Number begin [, Number end ] ] ] ) : Number

/*
 * Parse a list of Buffer as integers.
 */
Abaco#parseIntArray( Array buffers [, Number radix ] ) : Array

/*
 * Parse a list of Buffer as floats.
 */
Abaco#parseFloatArray( Array buffers [, Number radix ] ) : Array

---

MIT License

Copyright (c) 2014-present < 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.