radix 2.0.1 → 2.1.1

data/{HISTORY.rdoc → HISTORY.md}

@@ -1,6 +1,32 @@
-= RELEASE HISTORY
+# RELEASE HISTORY
 
-== 2.0.1 / 2011-10-23
+## 2.1.1 / 2013-02-06
+
+Minor release to fix gemspec. Which, alas, Bunder cannot do without.
+
+Changes:
+
+* Update .gemspec file for lastest indexer.
+
+
+## 2.1.0 / 2013-01-31
+
+This release fixes two bugs. The first caused base conversions of `0`
+to return an empty string. Second, the `Float#to_r` extension was
+ using multiplication when it should have been using power. 
+Ruby 1.9 includes `Float#to_r` though, so the use of Radix's *fixed*
+core extension is conditioned on Ruby 1.8 now. This release also 
+updates  the build a bit, primarily converting RDoc documents to 
+Markdown.
+
+Changes:
+
+* Fix issue #5, Float#to_r using times instead of power. (simonratner)
+* Fix issue #4, zero converts to empty string. (bbasata)
+* Convert RDoc documents to Markdown.
+
+
+## 2.0.1 / 2011-10-23
 
 This release is simply an adminstrative release to update the project
 build configuration. The functionality of the library itself has not
@@ -13,7 +39,7 @@ Changes:
 * Switch to BSD-2-Clause license.
 
 
-== 2.0.0 / 2010-10-31
+## 2.0.0 / 2010-10-31
 
 Radix::Number has been deprecate in favor of three separate classes,
 Radix::Integer, Radix::Float and Radix::Rational. In addition
@@ -27,7 +53,7 @@ Changes:
 * Add Radix::Rational
 
 
-== 1.1.0 / 2010-09-03
+## 1.1.0 / 2010-09-03
 
 Radix now provides an actual Numeric subclass, Radix::Number, that stores
 the base and can be used like any other Numeric object. This makes it very
@@ -42,7 +68,7 @@ Changes:
 * Rename Radix class to Radix::Base.
 
 
-== 1.0.0 / 2009-07-01
+## 1.0.0 / 2009-07-01
 
 This is the initial stand-alone release of Radix,
 ported from the basex.rb library of Ruby Facets.

data/LICENSE.txt

@@ -0,0 +1,23 @@
+BSD-2-Clause License
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+   1. Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+
+   2. Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR  SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/{README.rdoc → README.md}

@@ -1,19 +1,17 @@
-= Radix
+# Radix
 
-{<img src="http://travis-ci.org/rubyworks/radix.png" />}[http://travis-ci.org/rubyworks/radix]
-
-License:: BSD-2-Clause
-Copyright:: 2009 Thomas Sawyer, Rubyworks
-
-
-== DESCRIPTION
+[Website](http://rubyworks.github.com/radix) /
+[Report Issue](http://github.com/rubyworks/radix/issues) /
+[Source Code](http://github.com/rubyworks/radix) /
+[![Build Status](https://secure.travis-ci.org/rubyworks/radix.png)](http://travis-ci.org/rubyworks/radix) /
+[![Gem Version](https://badge.fury.io/rb/radix.png)](http://badge.fury.io/rb/radix)
 
 Radix is a very easy to use Ruby library for converting numbers to and from
 any base. It supports both Integer, Float and Rational numbers, as well as 
 representational string-notations that need not be in ASCII order.
 
 
-== FEATURES
+## Features
 
 * Convert to and from any base.
 * Convert Integers, Floats and Rational numbers.
@@ -22,65 +20,60 @@ representational string-notations that need not be in ASCII order.
 * Very intuitive API.
 
 
-== RESOURCES
-
-* {Website}[http://rubyworks.github.com/radix]
-* {Source Code}[http://github.com/rubyworks/radix]
-* {Mailing List}[http://groups.google/group/rubyworks-mailinglist]
-* {Issue Tracker}[http://github.com/rubyworks/radix/issues]
-
-
-== SYNOPSIS
+## Usage
 
 Base conversions with ASCII ordered notations are easy in Ruby.
 
-  255.to_s(16)   #=> "FF"
+    255.to_s(16)   #=> "FF"
 
-  "FF".to_i(16)  #=> 255
+    "FF".to_i(16)  #=> 255
 
 But Ruby reaches it's limit at base 36.
 
-  255.to_s(37)   #=> Error
+    255.to_s(37)   #=> Error
 
 Radix provides the means of converting to and from any base.
 
 For example, a number in base 256 can be represented by the array [100, 10]
 (ie. 100**256 + 10**1) and can be convert to base 10.
 
-  [100,10].b(256).to_a(10)  #=> [2,5,6,1,0]
+    [100,10].b(256).to_a(10)  #=> [2,5,6,1,0]
 
 Or, to get a string representation for any base up to 62.
 
-  [100,10].b(256).to_s(10)  #=> "25610"
+    [100,10].b(256).to_s(10)  #=> "25610"
 
 A string representation of a number can be converted too, again,
 up to base 62.
 
-  "10".b(62).to_s(10)  #=> "62"
+    "10".b(62).to_s(10)  #=> "62"
 
 To use a custom character set, use an array of characters as the base
 rather than an integer. For example we can convert a base 10 number
 to another base 10 number using a different encoding.
 
-  base = [:Q, :W, :E, :R, :T, :Y, :U, :I, :O, :U]
+    base = [:Q, :W, :E, :R, :T, :Y, :U, :I, :O, :U]
 
-  "10".b(10).to_a(base)  #=> [:W, :Q]
+    "10".b(10).to_a(base)  #=> [:W, :Q]
 
-To learn more have a look at the {QED}[http://rubyworks.github.com/radix/docs/qed].
+To learn more have a look at the [QED Demo](http://rubydoc.info/gems/radix/file/DEMO.md).
 
-== HOW TO INSTALL
+
+## Installing
 
 To install with RubyGems simply open a console and type:
 
-  $ gem install radix
+    $ gem install radix
+
+Radix follows [Ruby Setup](http://rubyworks.github.com/setup) package standard
+so it can also be installed in an FHS compliant manner using setup.rb.
 
-Radix follows {Ruby Setup}[http://rubyworks.github.com/setup] package standard.
 
+## Copyrights
 
-== COPYRIGHTS
+Copyright (c) 2009 Rubyworks
 
-Copyright (c) 2009 Thomas Sawyer, Rubyworks
+This program is distributable in accordance with the *BSD-2-Clause* license.
 
-This program is distributable in accordance with the *FreeBSD* license.
+See LICENSE.txt for details.
 
-See NOTICE.rdoc for details.

data/demo/01_synopsis.md

@@ -0,0 +1,46 @@
+# Synopsis
+
+Radix provides the means of converting to and from any base.
+For example, a number in base 256 can be represented by the array [100, 10]
+(ie. 100**256 + 10**1) and easily converted to base 10.
+
+    [100,10].b(256).to_i  #=> 25610
+
+We can get an Array representation as well.
+
+    [100,10].b(256).to_a(10)  #=> [2,5,6,1,0]
+    [100,10].b(256).to_a(62)  #=> [6,41,4]
+    [100,10].b(256).to_a(64)  #=> [6,16,10]
+
+To get a String representation for any base use #to_s.
+
+    [100,10].b(256).to_s(10)  #=> "25610"
+    [100,10].b(256).to_s(62)  #=> "6 41 4"
+    [100,10].b(256).to_s(64)  #=> "6 16 10"
+
+Notice that anything above base 10 is seperated by a space divider. The divider
+can be changed by providing a second argument.
+
+    [100,10].b(256).to_s(64, ':')  #=> "6:16:10"
+
+A string representation of a number can be converted upto base 62 (B62).
+
+    "10".b(62).to_s(10)  #=> "62"
+    "zz".b(62).to_s(10)  #=> "3843"
+
+To encode a number with a base greater than 10, use an Array base. Radix
+provides a built-in set of these, such as `BASE::B62`.
+
+    [100,10].b(256).to_s(Radix::BASE::B62)  #=> "6f4"
+
+To use a custom character set, use an array of characters as the base
+rather than an integer. For example we can convert a base 10 number
+to another base 10 number but useing a different encoding.
+
+    base = %w[Q W E R T Y U I O U]
+
+    "10".b(10).to_a(base)  #=> ["W", "Q"]
+
+    "10".b(10).to_s(base)  #=> "WQ"
+
+All of the above holds equally for floating point numbers.

data/demo/02_integer.md

@@ -0,0 +1,256 @@
+# Radix Integer
+
+Radix provides an Integer class for working with integers in various bases.
+
+    require 'radix'
+
+## Initialization
+
+Radix::Integer's initializer can accept either an Integer, String or
+Array as a value and an integer base.
+
+Give an integer value, it will automatically be converted to the base
+specified.
+
+    check do |integer, base, digits|
+      r = Radix::Integer.new(integer, base)
+      r.digits.assert == digits
+    end
+
+    ok  8,  2, [1,0,0,0]
+    ok  4,  2, [1,0,0]
+    ok  8, 10, [8]
+    ok 10, 10, [1, 0]
+    ok  8, 16, [8]
+    ok 16, 16, [1, 0]
+
+Where as a String value is taken to already be in the base given.
+
+    ok "1000", 2, [1,0,0,0]
+    ok  "100", 2, [1,0,0]
+
+    ok  "8", 10, [8]
+    ok "10", 10, [1, 0]
+    ok  "8", 16, [8]
+    ok "10", 16, [1, 0]
+
+And an Array is also taken to be in the base given.
+
+    ok %w[1 0 0 0], 2, [1,0,0,0]
+    ok %w[  1 0 0], 2, [1,0,0]
+
+    ok %w[  8], 10, [8]
+    ok %w[1 0], 10, [1, 0]
+    ok %w[  8], 16, [8]
+    ok %w[1 0], 16, [1, 0]
+
+Integers can also be negative, rather than positive. In each case
+just prepend the value with a minus sign.
+
+    check do |integer, base, digits|
+      r = Radix::Integer.new(integer, base)
+      r.digits.assert == digits
+      r.assert.negative?
+    end
+
+    ok             -8, 2, ['-',1,0,0,0]
+    ok        "-1000", 2, ['-',1,0,0,0]
+    ok  %w[- 1 0 0 0], 2, ['-',1,0,0,0]
+
+If a value has a digit outside of the range of the base an ArgumentError
+will be raised.
+
+    expect ArgumentError do
+      Radix::Integer.new('9', 2)
+    end
+
+Radix provides a convenience extension method to Integer, String and Array
+called #b, to more easily initialize a Radix numeric object. The method simply
+passes the receiver on to `Radix::Integer#new`.
+
+    check do |integer, base, digits|
+      r = integer.b(base)
+      r.assert.is_a?(Radix::Integer)
+      r.digits.assert == digits
+    end
+
+    ok 8, 2, [1,0,0,0]
+    ok 4, 2, [1,0,0]
+
+    ok "1000", 2, [1,0,0,0]
+    ok  "100", 2, [1,0,0]
+
+    ok %w"1 0 0 0", 2, [1,0,0,0]
+    ok   %w"1 0 0", 2, [1,0,0]
+
+## Conversion
+
+Radix integers can ve converted to other bases with the #convert method.
+
+    b = "1000".b(2)
+    d = b.convert(10)
+    d.digits.assert == [8]
+
+We can convert a Radix::Integer to a regular base-10 Integer with the #to_i
+method.
+
+    b = "1000".b(2)
+    d = b.to_i
+    d.assert == 8
+
+## Equality
+
+Radix extend the Integer, String and Array classes with the #b method
+which simplifies the creation of Radix::Integer instances. The following
+return the equivalent instance of Radix::Integer.
+
+    a = 8.b(2)
+    b = "1000".b(2)
+    c = [1, 0, 0, 0].b(2)
+
+    a.assert == b
+    b.assert == c
+    c.assert == a
+
+    a.assert == 8
+    b.assert == 8
+    c.assert == 8
+
+More stringent equality can be had from #eql?, in which the other integer
+must be a Radix::Integer too.
+
+    a.assert.eql?(b)
+    a.refute.eql?(8)
+
+## Operations
+
+Radix::Integer supports all the usual mathematical operators.
+
+### Addition
+
+    check do |a, b, x|
+      (a + b).assert == x
+    end
+
+    ok "1000".b(2), "0010".b(2), "1010".b(2)
+    ok "1000".b(2),    "2".b(8), "1010".b(2)
+    ok "1000".b(2),    "2".b(8),   "10".b(10)
+
+A more complex example.
+
+    x = "AZ42".b(62) + "54".b(10)
+    x.assert == "2518124".b(10)
+    x.assert == 2518124
+
+Adding negative integers will, of course, be akin to subtraction.
+
+    ok "1000".b(2), "-0010".b(2), "110".b(2)
+    ok "1000".b(2),    "-2".b(8), "110".b(2)
+    ok "1000".b(2),    "-2".b(8),   "6".b(10)
+
+    ok "-1000".b(2), "0010".b(2), "-110".b(2)
+    ok "-1000".b(2),    "2".b(8), "-110".b(2)
+    ok "-1000".b(2),    "2".b(8),   "-6".b(10)
+
+    ok "-1000".b(2), "-0010".b(2), "-1010".b(2)
+    ok "-1000".b(2),    "-2".b(8), "-1010".b(2)
+    ok "-1000".b(2),    "-2".b(8),   "-10".b(10)
+
+### Subtraction
+
+    check do |a, b, x|
+      (a - b).assert == x
+    end
+
+    ok "1000".b(2), "10".b(2), "0110".b(2)
+    ok "1000".b(2),  "2".b(8), "0110".b(2)
+    ok "1000".b(2),  "2".b(8), "6".b(8)
+    ok "1000".b(2),  "2".b(8), "6".b(10)
+
+A more complex example.
+
+    x = "AZ42".b(62) - "54".b(10)
+    x.assert == "2518016".b(10)
+    x.assert == 2518016
+
+### Multiplication
+
+    check do |a, b, x|
+      (a * b).assert == x
+    end
+
+    ok "1000".b(2), "10".b(2), "10000".b(2)
+    ok "1000".b(2),  "2".b(8), "10000".b(2)
+    ok "1000".b(2),  "2".b(8), "20".b(8)
+    ok "1000".b(2),  "2".b(8), "16".b(10)
+
+A more complex example.
+
+    x = "Z42".b(62) * "4".b(10)
+    x.assert == "539160".b(10)
+    x.assert == 539160
+
+### Division
+
+    check do |a, b, x|
+      (a / b).assert == x
+    end
+
+    ok "1000".b(2), "10".b(2), "100".b(2)
+    ok "1000".b(2),  "2".b(8), "100".b(2)
+    ok "1000".b(2),  "2".b(8), "4".b(8)
+    ok "1000".b(2),  "2".b(8), "4".b(10)
+
+A more complex example.
+
+    x = "AZ42".b(62) / "54".b(10)
+    x.assert == "46630".b(10)
+    x.assert == 46630
+
+### Power
+
+    check do |a, b, x|
+      (a ** b).assert == x
+    end
+
+    ok "1000".b(2), "10".b(2), 64
+
+### Modulo
+
+    check do |a, b, x|
+      (a % b).assert == x
+    end
+
+    ok "1000".b(2), "10".b(2), 0
+    ok "1000".b(2), "11".b(2), 2
+
+### Bitwise Shift
+
+    check do |a, b, x|
+      (a << b).assert == x
+    end
+
+    ok "10".b(2), "10".b(2), "1000".b(2)
+    ok "10".b(2),         2, "1000".b(2)
+    ok "10".b(2),         2, 8
+
+### Bitwise AND
+
+    check do |a, b, x|
+      (a & b).assert == x
+    end
+
+    ok "1010".b(2), "10".b(2), "10".b(2)
+    ok "1010".b(2),  "2".b(8), "10".b(2)
+
+## Coerce
+
+When a Radix::Integer is the operand in an operation against a regular
+Ruby Integer, the calculation should still work via #coerce.
+
+    check do |a, b, x|
+      (a + b).assert == x
+    end
+
+    ok 10, "10".b(2), "12".b(10)
+