bitwise 0.3.1 → 0.4.0

data/README.md

@@ -3,7 +3,7 @@ Bitwise
 
 Fast, memory efficient bitwise operations on large binary strings.
 
-Internally a bit array is represented as a ruby string with `Encoding::ASCII_8BIT` encoding, which keeps billions of bits in a workable footprint.
+Internally a bit array is represented as a ruby string with `Encoding::BINARY` encoding, which keeps billions of bits in a workable footprint.
 
 * 1,000,000 bits = 125KB
 * 10,000,000 bits = 1.25MB
@@ -18,47 +18,47 @@ Install
 Usage
 -----
 
-Bitwise assignment and retrieval:
+Set and clear bits:
 
 ```ruby
 b = Bitwise.new("\x00")
 
-b.to_bits
+b.bits
  => "00000000"
 
 b.set_at(1)
 b.set_at(4)
 
-b.to_bits
+b.bits
  => "01001000"
 
 b.clear_at(1)
 
-b.to_bits
+b.bits
  => "00001000"
 ```
 
-String-based assignment and retrieval:
+String-based accessor:
 
 ```ruby
 b = Bitwise.new
-b.value = "abc"
+b.raw = "abc"
 
 b.size
  => 3
-b.to_bits
+b.bits
  => "011000010110001001100011"
-b.value.unpack('C*')
+b.raw.unpack('C*')
  => [97, 98, 99]
 ```
 
-Index-based assignment and retrieval:
+Index-based accessor:
 
 ```ruby
 b = Bitwise.new
 b.indexes = [1, 2, 4, 8, 16]
 
-b.to_bits
+b.bits
  => "011010001000000010000000"
 b.indexes
  => [1, 2, 4, 8, 16]
@@ -67,7 +67,7 @@ b.cardinality
 
 b.set_at(10)
 
-b.to_bits
+b.bits
  => "011010001010000010000000"
 b.indexes
  => [1, 2, 4, 8, 10, 16]
@@ -75,6 +75,15 @@ b.cardinality
  => 6
 ```
 
+Bit-based accessor is also provided for convenience, but be aware that it's not efficient. Use string-based accessor whenever possible.
+
+```ruby
+b = Bitwise.new
+b.bits = '0100100010'
+b.bits
+ => "0100100010000000"
+```
+
 NOT, OR, AND and XOR:
 
 ```ruby

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.4.0

data/bitwise.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "bitwise"
-  s.version = "0.3.1"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kenn Ejima"]
-  s.date = "2011-12-13"
+  s.date = "2011-12-17"
   s.description = "Fast, memory efficient bitwise operations on large binary strings"
   s.email = "kenn.ejima@gmail.com"
   s.extensions = ["ext/bitwise/extconf.rb"]
@@ -18,7 +18,6 @@ Gem::Specification.new do |s|
     "README.md"
   ]
   s.files = [
-    ".document",
     "Gemfile",
     "LICENSE.txt",
     "README.md",

data/lib/bitwise.rb

@@ -1,12 +1,12 @@
-# coding: ascii-8bit
+# encoding: binary
 
 require 'bitwise/bitwise'
 
 class Bitwise
   attr_accessor :value
 
-  def initialize(value = "")
-    @value = value.force_encoding(Encoding::ASCII_8BIT)
+  def initialize(string = "")
+    self.raw = string
   end
 
   def size
@@ -14,10 +14,6 @@ class Bitwise
   end
   alias :to_s :size
 
-  def to_bits
-    @value.unpack('B*').first
-  end
-
   def set_at(index)
     get_byte(index)
     @value.setbyte(@div, @byte | bitmask)
@@ -52,7 +48,7 @@ class Bitwise
   end
 
   def not
-    Bitwise.new(Bitwise.string_not(self.value))
+    Bitwise.new(Bitwise.string_not(self.raw))
   end
   alias :~ :not
 
@@ -75,11 +71,26 @@ class Bitwise
   alias :^ :xor
 
   def assign_max_and_min(other)
-    @min, @max = [ self.value, other.value ].sort_by{|i| i.bytesize }
+    @min, @max = [ self.raw, other.raw ].sort_by{|i| i.bytesize }
+  end
+
+  def bits
+    @value.unpack('B*').first
   end
 
-  def value=(string)
-    @value = string.force_encoding(Encoding::ASCII_8BIT)
+  def bits=(string)
+    @value = string.scan(/[01]{1,8}/).map do |slice|
+      (slice.bytesize == 8 ? slice : (slice + '0' * (8 - slice.bytesize))).to_i(2).chr
+    end.join
+    @value.bytesize
+  end
+
+  def raw
+    @value
+  end
+
+  def raw=(string)
+    @value = string.force_encoding(Encoding::BINARY)
     @value.bytesize
   end
 
@@ -89,23 +100,21 @@ class Bitwise
     array.each do |index|
       set_at(index)
     end
-    array.size
+    @value.bytesize
   end
 
   def indexes
     indexes = []
-    position = 0
-    @value.each_byte do |c|
+    @value.each_byte.with_index do |c, position|
       BITS_TABLE[c].each do |i|
         indexes << (position*8 + i)
       end
-      position += 1
     end
     indexes
   end
 
   def cardinality
-    Bitwise.population_count(self.value)
+    Bitwise.population_count(self.raw)
   end
 
   BITS_TABLE = (0..255).map do |i|

data/spec/bitwise_spec.rb

@@ -1,5 +1,3 @@
-# coding: ascii-8bit
-
 require 'bitwise'
 require 'set'
 
@@ -8,38 +6,51 @@ describe Bitwise do
     @bitwise = Bitwise.new("\x00")
   end
 
-  describe "assignment and retrieval" do
-    it "bit-based" do
-      @bitwise.to_bits.should == '00000000'
+  it "should encode to binary" do
+    @bitwise.raw.encoding.should == Encoding::BINARY
+    @bitwise.indexes = [1,2]
+    @bitwise.raw.encoding.should == Encoding::BINARY
+  end
+
+  it "set and clear" do
+    @bitwise.bits.should == '00000000'
 
-      @bitwise.set_at(1)
-      @bitwise.set_at(4)
-      @bitwise.to_bits.should == '01001000'
-      @bitwise.cardinality.should == 2
+    @bitwise.set_at(1)
+    @bitwise.set_at(4)
+    @bitwise.bits.should == '01001000'
+    @bitwise.cardinality.should == 2
 
-      @bitwise.clear_at(1)
-      @bitwise.to_bits.should == '00001000'
-      @bitwise.cardinality.should == 1
+    @bitwise.clear_at(1)
+    @bitwise.bits.should == '00001000'
+    @bitwise.cardinality.should == 1
 
-      lambda { @bitwise.set_at(7) }.should_not raise_error(IndexError)
-      lambda { @bitwise.set_at(8) }.should raise_error(IndexError)
+    lambda { @bitwise.set_at(7) }.should_not raise_error(IndexError)
+    lambda { @bitwise.set_at(8) }.should raise_error(IndexError)
+  end
+
+  describe "accessor" do
+    it "bit-based" do
+      @bitwise.bits = '0100100010'
+      @bitwise.size.should == 2
+      @bitwise.bits.should == '0100100010000000'
+      @bitwise.cardinality.should == 3
     end
 
     it "string-based" do
-      @bitwise.value = 'abc'
+      @bitwise.raw = 'abc'
       @bitwise.size.should == 3
-      @bitwise.to_bits.should == '011000010110001001100011'
+      @bitwise.bits.should == '011000010110001001100011'
       @bitwise.cardinality.should == 10
     end
 
     it "index-based" do
       @bitwise.indexes = [1, 2, 4, 8, 16]
-      @bitwise.to_bits.should == '011010001000000010000000'
+      @bitwise.bits.should == '011010001000000010000000'
       @bitwise.indexes.should == [1, 2, 4, 8, 16]
       @bitwise.cardinality.should == 5
 
       @bitwise.set_at 10
-      @bitwise.to_bits.should == '011010001010000010000000'
+      @bitwise.bits.should == '011010001010000010000000'
       @bitwise.indexes.should == [1, 2, 4, 8, 10, 16]
       @bitwise.cardinality.should == 6
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bitwise
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-13 00:00:00.000000000 Z
+date: 2011-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2155170980 !ruby/object:Gem::Requirement
+  requirement: &2153110060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2155170980
+  version_requirements: *2153110060
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2155169340 !ruby/object:Gem::Requirement
+  requirement: &2153109020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2155169340
+  version_requirements: *2153109020
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2155168600 !ruby/object:Gem::Requirement
+  requirement: &2153108300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2155168600
+  version_requirements: *2153108300
 - !ruby/object:Gem::Dependency
   name: rake-compiler
-  requirement: &2155167760 !ruby/object:Gem::Requirement
+  requirement: &2153107500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2155167760
+  version_requirements: *2153107500
 description: Fast, memory efficient bitwise operations on large binary strings
 email: kenn.ejima@gmail.com
 executables: []
@@ -64,7 +64,6 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
-- .document
 - Gemfile
 - LICENSE.txt
 - README.md

data/.document

@@ -1,5 +0,0 @@
-lib/**/*.rb
-bin/*
-- 
-features/**/*.feature
-LICENSE.txt