bits_count 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OTJkNThmMzFlZDAwZGY4MTBhYWQwMDMzM2I3MGYyN2JjNTQwNGU2Yg==
+  data.tar.gz: !binary |-
+    ODRmNmUzNTFiODYwZjJlNzA0NmNiZmIxOGIzOTVmYTlkZGEzNzM1YQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NDUxYmJjNzQ4ODEyNzY1ZDI2NWNmOWVlYmJiNDJiMDE0NDI1ZDM3ZDg4NjQz
+    NmZiMjQ4ZjFhZWVkZWNlMDkzZDI0MGM4ZTIyMzYxZmIwN2ExMDg0NjIzNDU0
+    MmFjYzViM2ExMTJmOTY5MWZjNTk2MjE4NzM2NzAxN2ZkYzI5YTI=
+  data.tar.gz: !binary |-
+    NDFlZTllZDVmODc1Y2EwNDk4ZDg5ZjdmNGY2NDYyNjA3ZjY5NTY2ZjRmOGM1
+    ZDM3ZDFmYmEzYzQzYzIxNDEzYmE0ZjZjYTdmMDliZGU3ODI4ZjIzMTNkYWEz
+    NzBiM2M5ZGEyNTNiYjA2NTM2OWY2ZTYyMGUyODg2NTE1MmJlZDU=

data/.gitignore

@@ -0,0 +1,16 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bits_count.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Max Shytikov
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# BitsCount
+
+Implementations of population count (Hamming weight in binary case)
+using pure ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'bits_count'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bits_count
+
+## Usage
+
+Example: Calculate bits count in file
+
+(in IRB)
+```
+require 'bits_count/irb_helper'
+
+count_bits "path/to/some/file.jpg"
+```

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/bits_count/test*.rb']
+end
+
+task :default => :test

data/bits_count.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bits_count/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bits_count"
+  spec.version       = BitsCount::VERSION
+  spec.authors       = ["Max Shytikov"]
+  spec.email         = ["mshytikov@gmail.com"]
+  spec.description   = "Implementation of population count in pure ruby"
+  spec.summary       = "Bit counter"
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/bits_count/file.rb

@@ -0,0 +1,32 @@
+module BitsCount
+  module File
+
+    class << self
+
+      def population_count(path, alg = :str)
+        ::File.open(path, "rb") do |f|
+          case alg
+          when :int32
+            IO.population_count_int32(f) 
+          when :str
+            IO.population_count_str(f) 
+          when :map
+            IO.population_count_map(f) 
+          else
+            raise NotImplementedError, "#{alg} algorithm is not implemented"
+          end
+        end
+      end
+
+      def bits_count(path)
+        f_size = ::File.size(path)
+        bit1_count = population_count(path)
+        {
+          bit0_count: f_size*8 - bit1_count,
+          bit1_count: bit1_count
+        }
+      end
+    end
+
+  end
+end

data/lib/bits_count/io.rb

@@ -0,0 +1,40 @@
+module BitsCount
+  module IO
+
+    BUFFER_SIZE    = 256
+    UNPACK_PATTERN = "N*"
+    BIN_STR_END    = [0].pack("N")
+
+    class << self
+
+      def population_count_int32(io)
+        count = 0
+        each_int32(io) {|int| count += Primitive.population_count_int32(int) }
+        count
+      end
+
+      def population_count_map(io)
+        count = 0
+        each_int32(io) {|int| count += Primitive.population_count_map(int) }
+        count
+      end
+
+      def population_count_str(io)
+        count = 0 
+        while binstr = io.read(BUFFER_SIZE)
+          count += Primitive.population_count_str(binstr) 
+        end
+        count
+      end
+
+      private
+      def each_int32(io, &block)
+        while binstr = io.read(BUFFER_SIZE)
+          binstr << BIN_STR_END if binstr.bytesize < BUFFER_SIZE
+          binstr.unpack(UNPACK_PATTERN).each(&block)
+        end
+      end
+    end
+
+  end 
+end

data/lib/bits_count/irb_helper.rb

@@ -0,0 +1,7 @@
+require 'bits_count'
+
+def count_bits path
+  stats = BitsCount::File.bits_count(path)
+  puts "found %d bits set to 1"%[stats[:bit1_count]]
+  puts "found %d bits set to 0"%[stats[:bit0_count]]
+end

data/lib/bits_count/primitive.rb

@@ -0,0 +1,32 @@
+module BitsCount
+  module Primitive
+
+    UNPACK_PATTERN = "B*"
+
+    class << self
+
+      def population_count_int32(i)
+        i = i - ((i >> 1) & 0x55555555)
+        i = (i & 0x33333333) + ((i >> 2) & 0x33333333)
+        i = (i + (i >> 4)) & 0x0F0F0F0F
+        i = i + (i >> 8)
+        i = i + (i >> 16)
+        i & 0x0000003F
+      end
+
+
+      def population_count_str(s)
+        s.unpack(UNPACK_PATTERN).first.count(?1)
+      end
+
+      def population_count_map(i)
+        WORDBITS[i&0xFFFF] + WORDBITS[i>>16]
+      end
+
+    end
+
+    WORDBITS = Hash[0.upto(2**16-1).map{|i| [i, population_count_int32(i)] }].freeze
+    
+  end
+end
+

data/lib/bits_count/version.rb

@@ -0,0 +1,3 @@
+module BitsCount
+  VERSION = "0.0.1"
+end

data/lib/bits_count.rb

@@ -0,0 +1,7 @@
+require "bits_count/version"
+require 'bits_count/primitive'
+require 'bits_count/io'
+require 'bits_count/file'
+
+module BitsCount
+end

data/test/bits_count/test_file.rb

@@ -0,0 +1,35 @@
+require 'test_helper'
+
+class TestBitsCountFile < Test::Unit::TestCase
+  include Fixtures
+
+  Fixtures.all.each do  |path, bit0_count, bit1_count| 
+    file_name = File.basename(path)
+
+    define_method "test_population_count_with_file_#{file_name}" do
+      assert_equal(bit1_count, BitsCount::File.population_count(path, :int32), "alg :int32")
+      assert_equal(bit1_count, BitsCount::File.population_count(path, :str), "alg :srt")
+      assert_equal(bit1_count, BitsCount::File.population_count(path, :map), "alg :srt")
+    end
+
+    define_method "test_bits_count_#{file_name}" do
+      expected = { bit0_count: bit0_count, bit1_count: bit1_count }
+      assert_equal(expected, BitsCount::File.bits_count(path))
+    end
+  end 
+
+  def test_population_count_with_unknown_algorithm
+    assert_raise NotImplementedError do
+      BitsCount::File.population_count(Fixtures.large_bin, :fast)
+    end
+  end
+
+  def test_benchmark
+    path = Fixtures.large_bin
+    Benchmark.bmbm  do |x|
+      [:int32, :map, :str].each do |alg|
+        x.report("File.population_count alg: #{alg}") { BitsCount::File.population_count(path, alg) } 
+      end
+    end
+  end
+end

data/test/bits_count/test_io.rb

@@ -0,0 +1,39 @@
+require 'test_helper'
+require 'stringio'
+
+class TestBitsCountIO < Test::Unit::TestCase
+  TEST_BIT_STRINGS = {
+    "1"           => 1,
+    "01"          => 1,
+    "010"         => 1,
+    "011"         => 2,
+    "01"*32       => 32,
+    "1"*64        => 64,
+    "0"<< "1"*63  => 63,
+    "01"*64       => 64,
+    "0"*512<< "1" => 1
+  }
+
+  TEST_METHODS = BitsCount::IO.methods.grep(/population_count/)
+
+  TEST_METHODS.each do |method|
+    define_method "test_#{method}" do
+      TEST_BIT_STRINGS.each do |binstr, expected_count|
+        StringIO.open([binstr].pack("b*"), "rb") do |io|
+          assert_equal(expected_count, BitsCount::IO.send(method, io), "Bin sring: #{binstr}")
+        end
+      end
+    end
+  end
+
+  def test_benchmark
+    io =  StringIO.new(File.binread(Fixtures.large_bin), 'rb')
+    Benchmark.bmbm  do |x|
+      TEST_METHODS.each do |method|
+        x.report("IO.#{method}"){ io.rewind; BitsCount::IO.send(method, io)  }
+      end
+    end
+    io.close
+  end
+end
+

data/test/bits_count/test_primitive.rb

@@ -0,0 +1,37 @@
+require 'test_helper'
+
+class TestBitsCountPrimitive < Test::Unit::TestCase
+
+  def test_population_count_int32
+    assert_equal(0, BitsCount::Primitive.population_count_int32(0))
+    assert_equal(1, BitsCount::Primitive.population_count_int32(1))
+    assert_equal(2, BitsCount::Primitive.population_count_int32(3))
+    assert_equal(32, BitsCount::Primitive.population_count_int32(2**32-1))
+  end
+
+  def test_population_count_map
+    assert_equal(0, BitsCount::Primitive.population_count_map(0))
+    assert_equal(1, BitsCount::Primitive.population_count_map(1))
+    assert_equal(2, BitsCount::Primitive.population_count_map(3))
+    assert_equal(32, BitsCount::Primitive.population_count_map(2**32-1))
+  end
+
+  def test_population_count_str
+    assert_equal(1, BitsCount::Primitive.population_count_str([1].pack("L")))
+    assert_equal(32, BitsCount::Primitive.population_count_str([2**32-1].pack("L")))
+    assert_equal(64, BitsCount::Primitive.population_count_str([2**64-1].pack("Q")))
+  end
+
+
+  def test_benchmark
+    n = 10000
+    int = 0x55555555
+    bstr = [int].pack("N")
+    Benchmark.bmbm  do |x|
+      x.report("Primitive.population_count_map")   { n.times{ BitsCount::Primitive.population_count_map(int) } }
+      x.report("Primitive.population_count_int32") { n.times{ BitsCount::Primitive.population_count_int32(int) } }
+      x.report("Primitive.population_count_str")   { n.times{ BitsCount::Primitive.population_count_str(bstr)  } }
+   end
+  end
+
+end

data/test/fixtures/bit0-25_bit1-15.bin

@@ -0,0 +1 @@
+Y�9%�

data/test/fixtures/bit0-7_bit1-1.bin

@@ -0,0 +1 @@
+@

data/test/fixtures/tmp/.gitignore

@@ -0,0 +1,4 @@
+# Ignore everything in this directory
+*
+# Except this file
+!.gitignore

data/test/test_helper.rb

@@ -0,0 +1,35 @@
+require 'test/unit'
+require 'bits_count'
+require 'benchmark'
+
+module Fixtures
+  ROOT = File.expand_path('fixtures',  File.dirname(__FILE__))
+
+  def fixture_path(name)
+    File.expand_path(name.to_s, ROOT)
+  end
+
+  class << self
+    
+    def all
+      Dir.glob(File.expand_path("*.bin", ROOT)).map do |path|
+        file_name = File.basename(path, '.bin')
+        bit0_count = file_name[/bit0-(\d+)/, 1].to_i
+        bit1_count = file_name[/bit1-(\d+)/, 1].to_i
+        [path, bit0_count, bit1_count]
+      end
+    end
+
+
+    def large_bin
+      path = File.expand_path("tmp/large.bin", ROOT)
+      if !File.exists?(path)
+        File.open(path, "wb") do |f|
+          1024.times { f.write(([0x55555555] * 256).pack("N*")) }
+        end
+      end
+      path
+    end
+
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: bits_count
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Max Shytikov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Implementation of population count in pure ruby
+email:
+- mshytikov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bits_count.gemspec
+- lib/bits_count.rb
+- lib/bits_count/file.rb
+- lib/bits_count/io.rb
+- lib/bits_count/irb_helper.rb
+- lib/bits_count/primitive.rb
+- lib/bits_count/version.rb
+- test/bits_count/test_file.rb
+- test/bits_count/test_io.rb
+- test/bits_count/test_primitive.rb
+- test/fixtures/bit0-0_bit1-0.bin
+- test/fixtures/bit0-25_bit1-15.bin
+- test/fixtures/bit0-7_bit1-1.bin
+- test/fixtures/tmp/.gitignore
+- test/test_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Bit counter
+test_files:
+- test/bits_count/test_file.rb
+- test/bits_count/test_io.rb
+- test/bits_count/test_primitive.rb
+- test/fixtures/bit0-0_bit1-0.bin
+- test/fixtures/bit0-25_bit1-15.bin
+- test/fixtures/bit0-7_bit1-1.bin
+- test/fixtures/tmp/.gitignore
+- test/test_helper.rb