thunderer / numbase
Convert any number between arbitrary bases
Installs: 2 248
Dependents: 0
Suggesters: 0
Security: 0
Stars: 24
Watchers: 4
Forks: 3
Open Issues: 0
Requires
- php: ^5.3|^7.0
- ext-gmp: *
Requires (Dev)
- phpunit/phpunit: ^4.1|^5.2
This package is auto-updated.
Last update: 2024-10-29 05:04:33 UTC
README
Easily convert numbers between arbitrary bases and symbol sets.
Installation
This library is available on Packagist as thunderer/numbase
. It requires PHP >=7.4
and GMP extension for handling large numbers. For older PHP versions please use ^0.1
constraint which works with 5.3
and above.
Usage
The Simplest Way™
use Thunder\Numbase\Numbase; $numbase = Numbase::createDefault(); // decimal 15 to hexadecimal number assert('F' === $numbase->convert(15, 10, 16)); // 64000 decimal to base 32000 assert('20' === $numbase->convert(64000, 10, 32000));
Regular usage (see Internals section for more options):
use Thunder\Numbase\Numbase; $base62 = new Base62Symbols(); $numbase = new Numbase(new GmpConverter($base62), new StrictFormatter($base62)); // decimal 15 to hexadecimal number assert('F' === $numbase->convert(15, 10, 16));
Showcase
Convert number to and from a different set of symbols:
$base10 = new Base10Symbols(); $upper = new StringSymbols('!@#$%^&*()'); $numbase = new Numbase(new GmpDigits($base10), new StrictFormatter($upper)); assert('#!' === $numbase->convert('20', 10, 10)); assert('-$!' === $numbase->convert('-30', 10, 10)); $numbase = new Numbase(new GmpDigits($upper), new StrictFormatter($base10)); assert('20' === $numbase->convert('#!', 10, 10)); assert('-30' === $numbase->convert('-$!', 10, 10));
Get array of digit values (for bases too large for any symbol set):
$numbase = new Numbase(new GmpDigits(new Base62Symbols()), new ArrayFormatter()); // convert 10^12 to base 99: assert(array('10', '61', '53', '3', '51', '60', '10') === $numbase->convert('10000000000000', 10, 99));
Internals
Numbase is built upon several concepts:
- converters that convert numbers to array of numbers of digits,
- formatters that take those arrays and return final numbers,
- symbols used in converters to check symbols values and to get digits symbols in formatters.
There are several implementations of each concept bundled with this library, for example:
- converters:
- GmpConverter: can convert any integer between any base greater than 2, uses
gmp_*()
functions, - GmpStrvalConverter: uses
gmp_strval()
to convert between bases 2 and 62, - BaseConvertConverter: uses
base_convert()
to convert between bases 2 and 32,
- GmpConverter: can convert any integer between any base greater than 2, uses
- formatters:
- ArrayFormatter: returns raw array of digits numbers,
- StrictFormatter: returns number as string, throws exception when digit is not found in symbols set,
- FallbackFormatter: returns number as string, but returns string with digit values separated by configured separator when any digit is not found in symbols set,
- symbols:
- ArraySymbols: takes associative
array(value => symbol)
, - Base62Symbols: contains alphanumeric set of symbols
0-9A-Za-z up
to base 62, - StringSymbols: takes string and splits it assigning consecutive values to each character.
- ArraySymbols: takes associative
The named constructor Numbase::createDefault()
uses GmpConverter
, StrictFormatter
and Base62Symbols
as defaults.
License
See LICENSE file in the main directory of this library.