radix 2.0.0 → 2.0.1

data/LICENSE

@@ -1,205 +0,0 @@
-.
-
-                             Apache License
-                        Version 2.0, January 2004
-                     http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
-
-.

data/doc/01_synopsis.rdoc

@@ -1,60 +0,0 @@
-= Synopsis
-
-Base conversions with ASCII ordered notations are easy in Ruby.
-
-  255.to_s(16)   #=> "ff"
-  "ff".to_i(16)  #=> 255
-
-But Ruby reaches it's limit at base 36.
-
-  expect ArgumentError do
-    255.to_s(37)
-  end
-
-Radix provides the means of converting to and from any base.
-
-  require 'radix'
-
-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/doc/02_integer.rdoc

@@ -1,48 +0,0 @@
-= Radix Integer
-
-Radix provides an Integer class for working with integers in various bases.
-
-  require 'radix'
-
-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
-
-Radix integers can ve converted to other bases with the #convert method.
-
-  b = "1000".b(2)
-  d = b.convert(10)
-  d.digits.assert == [8]
-
-Radix::Integer supports all the usual mathematical operators.
-
-  r = "1000".b(2) + "2".b(8)
-  r.assert == "1010".b(2)
-  r.assert == "12".b(8)
-  r.assert == "10".b(10)
-
-A more complex example with a much higher base.
-
-  r = "AZ42".b(62) + "54".b(10)
-  r.assert == "2518124".b(10)
-  r.assert == 2518124
-
-Work with arrays for bases greater than 62.
-
-  r = [100,10].b(256) + "54".b(10)
-  r.assert == "25664".b(10)
-

data/doc/03_float.rdoc

@@ -1,36 +0,0 @@
-= Radix Float
-
-Radix provides a Float class for working with floating point numbers in
-any base.
-
-  require 'radix'
-
-With it, the #b method extends String and Array classes to
-simplify all mulit-base operations.
-
-  b = "100.01".b(2)
-  b.to_a.assert == [1,0,0,'.',0,1]
-
-Convert to base 10.
-
-  t = b.convert(10)
-  t.to_a.assert == [4,'.',2,5]
-
-Like a Numeric class, Radix::Float's can be added, subtracted, multipled, etc.
-
-  r = "1000.01".b(2) + "2".b(8)
-  r.assert == "1010.01".b(2)
-  r.assert == "12.2".b(8)
-  r.assert == "10.25".b(10)
-
-Even complex conversions are supported.
-
-  r = "AZ42".b(62) + "54".b(10)
-  r.assert == "2518124".b(10)
-
-To work with bases greater than 62, use arrays. A '.' entry in the array
-can be used to separate the whole from the fractional part of the number.
-
-  r = [100,10,'.',64].b(256) + "54".b(10)
-  r.assert == "25664.25".b(10)
-

data/doc/04_rational.rdoc

@@ -1,27 +0,0 @@
-= Radix Rational
-
-Radix also provides a Rational class. Like the Integer and Float classes
-Radix::Rational delegates to an underlying instance of Ruby standard
-Rational class.
-
-  require 'radix'
-
-  b = ["100","10"].br(2)
-  b.assert = [2,1].br(10)
-
-When convert to Array or String Radix::Rational uses `/` to separate
-the numerator from the denominator.
-
-  b.to_a  #=> [1,0,0,'/',1,0]
-  b.to_s  #=> "100/10"
-
-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","1"].br(10).to_a(base)  #=> ["W", "Q", '/', 'W']
-
-  ["10","1"].br(10).to_s(base)  #=> "WQ/W"
-

data/doc/05_base.rdoc

@@ -1,82 +0,0 @@
-= Radix Base
-
-Radix::Base encapsulates a base which can then be used to perform conversions
-to and form that base.
-
-NOTE: Radix::Base is the original Radix API. But with the advent of v2.0
-and the new Integer and Float classes, it is outmoded. For now it is here
-for backward compatibility. In a future version it may be deprecated, or
-reworked to serve as the backbone of the other classes.
-
-  require 'radix/base'
-
-First let's try something we all know, hexideciaml.
-First we setup the radix for each.
-
-  b10 = Radix::Base.new(Radix::BASE::B10)
-  b16 = Radix::Base.new(Radix::BASE::B16)
-
-Now we can covert from one base to the other.
-
-  b16.convert("16" , b10).should == "10"
-  b16.convert("160", b10).should == "A0"
-  b16.convert("255", b10).should == "FF"
-
-To confirm, lets convert from deciaml to hexidecimal.
-
-  b10.convert("10", b16).should == "16"
-  b10.convert("A0", b16).should == "160"
-  b10.convert("FF", b16).should == "255"
-
-If we we want to use standard encodings then we
-can simply provide an integer base, rather than
-a Radix object.
-
-  b10.convert("10", 16).should == "16"
-  b10.convert("A0", 16).should == "160"
-  b10.convert("FF", 16).should == "255"
-
-Now let's try a more down to earth base, my favorite,
-senary, or base six.
-
-  b6  = Radix::Base.new(0..5)
-  b6.convert("39", 10).should == "103"
-
-And the notations need not be in ASCII order. Odd alternate notations
-can be used as well.
-
-  b10 = Radix::Base.new([:Q, :W, :E, :R, :T, :Y, :U, :I, :O, :U])
-  b10.convert("FF", 16) #=> "EYY"
-
-== Encoding and Decoding
-
-Radix can also be used to encode and decode strings.
-
-  b16.encode("CHARLIE").should == "434841524C4945"
-  b16.decode("434841524C4945").should == "CHARLIE"
-
-== Module Methods
-
-We can also use the module function to convert to and from standard
-notations upto 62 without creating an instance of Radix::Base.
-
-  Radix.convert("10", 16, 10).should == "16"
-  Radix.convert("A0", 16, 10).should == "160"
-  Radix.convert("FF", 16, 10).should == "255"
-
-Let's try that again with the maximum base supported.
-
-  Radix.convert(     "62", 10, 62).should == "10"
-  Radix.convert("8814542", 10, 62).should == "az42"
-
-  Radix.convert(     "10", 62, 10).should == "62"
-  Radix.convert(   "az42", 62, 10).should == "8814542"
-
-Finally, we will demonstrate how to convert bases larger than 62.
-These can only be represented as arrays since there are not enough
-latin characters to represent them.
-
-  Radix.convert_base([100, 10], 256, 10).should == [2, 5, 6, 1, 0]
-  Radix.convert_base([2, 5, 6, 1, 0], 10, 256).should == [100, 10]
-  Radix.convert_base([1, 0, 1, 0, 1], 2, 10).should == [2, 1]
-