base_custom

Crates.iobase_custom
lib.rsbase_custom
version0.2.0
sourcesrc
created_at2017-06-22 15:05:03.11408
updated_at2018-12-07 01:18:00.368239
descriptionUse any characters as your own numeric base and convert to and from decimal.
homepagehttps://github.com/danielpclark/base_custom
repositoryhttps://github.com/danielpclark/base_custom
max_upload_size
id20172
size31,610
Daniel P. Clark (danielpclark)

documentation

http://danielpclark.github.io/base_custom/index.html

README

base_custom

Build Status crates.io version License

Use any characters as your own numeric base and convert to and from decimal. This can be taken advantage of in various ways:

  • Mathematics: number conversion
  • Brute force sequencing
  • Rolling ciphers
  • Moderate information concealment
  • Other potential uses such as deriving music or art from numbers

There is also a Ruby and Crystal implementation of this which this was based off of.

Installation

Add the following to your Cargo.toml file

[dependencies]
base_custom = "^0.2"

To include it for usage add

extern crate base_custom;
use base_custom::BaseCustom;

to your file.

Usage

// Binary with no delimiter
let base2 = BaseCustom::<char>::new("01".chars().collect());
assert_eq!(base2.decimal("00001"), 1_u64);
assert_eq!(base2.decimal("100110101"), 309_u64);
assert_eq!(base2.gen(340), "101010100");
assert_eq!(base2.gen(0xF45), "111101000101");
assert_eq!(base2.gen(0b111), "111");

// Trinary with no delimiter
let base3 = BaseCustom::<char>::new("ABC".chars().collect());
assert_eq!(base3.decimal("ABC"), 5);
assert_eq!(base3.gen(123), "BBBCA");

// Custom base like Musical Chords and a space delimiter
let base_music = BaseCustom::<String>::new("A A# B C C# D D# E F F# G G#", Some(' '));
assert_eq!(base_music.decimal("F F# B D# D A# D# F# "), 314159265);
assert_eq!(base_music.gen(314159265), "F F# B D# D A# D# F# ");

When using BaseCustom::<String>::new the second parameter must be of Option<char> to choose your optional delimiter.

Benchmarks

Benchmarks are provided for the various usages and implementations. BaseCustom<char> is by far the most efficient implementation.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Commit count: 35

cargo fmt