bitarray 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6fcf6acdc1a14446a50e3cca4c8f96da1f36ab10
-  data.tar.gz: dc2cc9af844024134c930ab9678be08731458a7a
+SHA256:
+  metadata.gz: 5a056ce9816063f7e51c6fce69fb88c4644336236545613d4224977a01c50df8
+  data.tar.gz: f9f05b2a142f7cea4f529f9ebfbf9e053f635bb75d4ba44a10bdb6a2864c3f0d
 SHA512:
-  metadata.gz: 3ed10001a59707f9837e62727cf3fbd338c7d5c14af834862d04338800a69639a178a824d0ab629883451f89cdda006d27d9c8116b5751fc351dd17c33878d6a
-  data.tar.gz: 446232b243b040be2e7627b042ff5dc03db7c8ebd13ce4060ac2400299954d940c9aa97349a906a73170f5a1f401e3f7b5505d0d1f680c71781f114f1fa5d94e
+  metadata.gz: 7373fc1fc97187412eee8e854839961b7647f880afbffa8d4f0e261830d214edc4626763a100dcd71a8ce4dd05c2892522594d63c6d21f95be7bc413afc26c87
+  data.tar.gz: f884ad42cba8ce15fa2c3810427f510028db459f14080ca9bda02f823b35d27e00769e941cb5232fb6e0220ddc494d55e00843e5186d4d96a41e5b250754cfc5

data/README.md

@@ -1,13 +1,13 @@
-# BitArray: A simple bit-array/bitfield library in pure Ruby
+# BitArray: Pure Ruby bit-array/bitfield library
 
-A simple, pure-Ruby 'bit field' object. Works well for Bloom filters (the use case for which I originally wrote it).
+A simple, pure-Ruby 'bit field' object. Works well for Bloom filters (the use case for which I originally wrote it, although there are numerous good libraries for that task now).
 
-Originally written in 2007 and left without significant update until 2017, it has now been updated to work within a typical, modern Ruby environment while maintaining the same API.
+Despite its age, BitArray has been updated to work within a typical, modern Ruby environment, but is only 'mildly' maintained.
 
 ## Installation
 
 ```ruby
-gem install bitarray
+bundle add bitarray
 ```
 
 ## Examples
@@ -63,6 +63,7 @@ ba.to_s # "0000111111110000"
 
 
 ## History
+- 1.3 in 2022 (cleanups and a minor perf tweak)
 - 1.2 in 2018 (Added option to skip reverse the bits for each byte by @dalibor)
 - 1.1 in 2018 (fixed a significant bug)
 - 1.0 in 2017 (updated for modern Ruby, more efficient storage, and 10th birthday)
@@ -77,8 +78,8 @@ ba.to_s # "0000111111110000"
 
 Thanks to Michael Slade for encouraging me to update this library on its 10th birthday and for suggesting finally using String's getbyte and setbyte methods now that we're all on 1.9+ compatible implementations.
 
-Further thanks to @tdeo, @JoshuaSP, @dalibor and @m1lt0n for pull requests.
+Further thanks to @tdeo, @JoshuaSP, @dalibor, @yegct and @m1lt0n for pull requests.
 
 ## License
 
-MIT licensed. Copyright 2007-2018 Peter Cooper.
+MIT licensed. Copyright 2007-2022 Peter Cooper.

data/lib/bitarray-array.rb

@@ -3,7 +3,7 @@ class BitArray
   attr_reader :field
   include Enumerable
 
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
   ELEMENT_WIDTH = 32
 
   def initialize(size, field = nil)
@@ -26,7 +26,8 @@ class BitArray
   end
 
   # Iterate over each bit
-  def each(&block)
+  def each
+    return to_enum unless block_given?
     @size.times { |position| yield self[position] }
   end
 
@@ -34,10 +35,17 @@ class BitArray
   def to_s
     @field.collect{|ea| ("%0#{ELEMENT_WIDTH}b" % ea).reverse}.join[0..@size-1]
   end
+  
+  # Iterate over each byte
+  def each_byte
+    return to_enum(:each_byte) unless block_given?
+    @field.each { |byte| yield byte }
+  end
 
   # Returns the total number of bits that are set
-  # (The technique used here is about 6 times faster than using each or inject direct on the bitfield)
+  # Use Brian Kernighan's way, see
+  # https://graphics.stanford.edu/~seander/bithacks.html#CountBitsSetKernighan
   def total_set
-    @field.inject(0) { |a, byte| a += byte & 1 and byte >>= 1 until byte == 0; a }
+    @field.each_byte.inject(0) { |a, byte| (a += 1; byte &= byte - 1) while byte > 0 ; a }
   end
 end

data/lib/bitarray.rb

@@ -3,7 +3,7 @@ class BitArray
   attr_reader :field
   include Enumerable
 
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 
   def initialize(size, field = nil, reverse_byte: true)
     @size = size
@@ -26,7 +26,8 @@ class BitArray
   end
 
   # Iterate over each bit
-  def each(&block)
+  def each
+    return to_enum(:each) unless block_given?
     @size.times { |position| yield self[position] }
   end
 
@@ -38,11 +39,18 @@ class BitArray
       @field.bytes.collect { |ea| ("%08b" % ea) }.join[0, @size]
     end
   end
+  
+  # Iterates over each byte
+  def each_byte
+    return to_enum(:each_byte) unless block_given?
+    @field.bytes.each{ |byte| yield byte }
+  end
 
   # Returns the total number of bits that are set
-  # (The technique used here is about 6 times faster than using each or inject direct on the bitfield)
+  # Use Brian Kernighan's way, see
+  # https://graphics.stanford.edu/~seander/bithacks.html#CountBitsSetKernighan
   def total_set
-    @field.bytes.inject(0) { |a, byte| a += byte & 1 and byte >>= 1 until byte == 0; a }
+    @field.each_byte.inject(0) { |a, byte| (a += 1; byte &= byte - 1) while byte > 0 ; a }
   end
 
   def byte_position(position)

data/test/test_bitarray.rb

@@ -1,5 +1,5 @@
 require "minitest/autorun"
-require "bitarray"
+require_relative "../lib/bitarray"
 
 class TestBitArray < Minitest::Test
   def setup

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bitarray
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Peter Cooper
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-09-13 00:00:00.000000000 Z
+date: 2022-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -47,7 +47,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
 - bitarray.gemspec
@@ -58,7 +57,7 @@ files:
 homepage: https://github.com/peterc/bitarray
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -73,9 +72,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.10
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: A simple, pure Ruby bit-array / bitfield implementation.
 test_files:

data/Gemfile.lock

@@ -1,21 +0,0 @@
-PATH
-  remote: .
-  specs:
-    bitarray (1.2.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    minitest (5.10.1)
-    rake (12.0.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bitarray!
-  minitest
-  rake
-
-BUNDLED WITH
-   1.16.3