bitset 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d7264d2aacb2a035cc9d03a759e3d7df802490d7
-  data.tar.gz: b67c9f93d7b5dc611807cdd148ffdcf871588bbf
+  metadata.gz: 4c14192c25ee30542e0317d9866aae505540db2d
+  data.tar.gz: 3ca3e7cdd173f8f45785f80925afc31960236200
 SHA512:
-  metadata.gz: f5374f4557cf95b59488c7e84f9af6865b8c2b92dc605369e7e756e4be6fc1abfbbbef85f6198fe192ed43a4594bd59519da98bcb8577bd8024961429ac1c6a9
-  data.tar.gz: 77c7dd54f09f8f7f0e439324a8e01c22959e6d6a7e2d517607eb803724099173012fbd85cf736aef61a8e3519d2ac01fde340e298094e66a917f0418e4f0841a
+  metadata.gz: 0c811e6e8fc572c7efd0338e4b249189542be2c8e533cc672166cd22e2113b4d1ed10c28a5ea1587492c38d26787700dd45fa3d705badf6273014ecde1fa64b8
+  data.tar.gz: 5f602be6047488f9f1ba99f168b98050f3479fba816032bdeb7a4873786f9e8de9fd6b076c0ad29d3ac39c5818a7977a72209c19f2acdad637a735e5c7f966a7

data/README.markdown

@@ -39,16 +39,16 @@ Obviously you can also set and clear bits...
 
     >> bitset = Bitset.new(8)
     => 00000000
-    
+
     >> bitset[3] = true
     => 00010000
-    
+
     >> bitset[3] = false
     => 00000000
-    
+
     >> bitset.set(1, 3, 5, 7)
     => 01010101
-    
+
     >> bitset.clear(1, 5)
     => 00010001
 
@@ -59,31 +59,31 @@ support basic set and bitwise operations. So, let's look at a few of those.
 
     >> a = Bitset.from_s('00001111')
     => 00001111
-    
+
     >> b = Bitset.from_s('01010101')
     => 01010101
-    
+
     >> a & b
     => 00000101
-    
+
     >> a | b
     => 01011111
-    
+
     >> b - a
     => 01010000
-    
+
     >> a ^ b
     => 01011010
-    
+
     >> ~a
     => 11110000
-    
+
     >> a.hamming(b)
     => 4
-    
+
     >> a.cardinality
     => 4
-    
+
     >> a.reverse
     => 11110000
 
@@ -123,6 +123,15 @@ support basic set and bitwise operations. So, let's look at a few of those.
     >> b.each_set      # AKA b.to_a
     => [1, 3, 5, 7]
 
+    # b.each_set(index) == b.each_set[index], but faster.
+    >> b.each_set(-3) # Negative index wraps around.
+    => 3
+
+    # b.each_set(index, len) == b.each_set[index, len], but faster.
+    >> b.each_set(2,2) # Block is also allowed
+    => [5,7]
+
+
     # The following methods modify a Bitset in place very quickly:
     >> a.intersect!(b)      #  like a &= b
     >> a.union!(b)          #  like a |= b

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.1.0

data/bitset.gemspec

@@ -2,17 +2,17 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: bitset 1.0.1 ruby lib
+# stub: bitset 1.1.0 ruby lib
 # stub: ext/bitset/extconf.rb
 
 Gem::Specification.new do |s|
   s.name = "bitset".freeze
-  s.version = "1.0.1"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Tyler McMullen".freeze]
-  s.date = "2017-05-26"
+  s.date = "2018-01-06"
   s.description = "A fast C-based Bitset. It supports the standard set operations as well as operations you may expect on bit arrays,such as popcount.".freeze
   s.email = "eric.boesch@nist.gov".freeze
   s.extensions = ["ext/bitset/extconf.rb".freeze]
@@ -35,7 +35,7 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/ericboesch/bitset".freeze
   s.licenses = ["MIT".freeze]
-  s.rubygems_version = "2.6.12".freeze
+  s.rubygems_version = "2.6.14".freeze
   s.summary = "Bitset implementation.".freeze
 end
 

data/ext/bitset/bitset.c

@@ -2,8 +2,10 @@
 #include "builtin.h"
 
 #include <stdint.h>
+#include <stdbool.h>
 #include <string.h>
 #include <stdio.h>
+#include <limits.h>
 
 VALUE cBitset;
 
@@ -173,15 +175,19 @@ static VALUE rb_bitset_set_p(int argc, VALUE * argv, VALUE self) {
     return Qtrue;
 }
 
-static VALUE rb_bitset_cardinality(VALUE self) {
-    Bitset * bs = get_bitset(self);
+static int cardinality(Bitset * bs) {
     int i;
     int max = INTS(bs);
     int count = 0;
     for(i = 0; i < max; i++) {
         count += psnip_builtin_popcount64(bs->data[i]);
     }
-    return INT2NUM(count);
+    return count;
+}
+
+static VALUE rb_bitset_cardinality(VALUE self) {
+    Bitset * bs = get_bitset(self);
+    return INT2NUM(cardinality(bs));
 }
 
 static VALUE rb_bitset_intersect(VALUE self, VALUE other) {
@@ -388,21 +394,51 @@ static VALUE rb_bitset_dup(VALUE self) {
 
 /* Yield the bit numbers of each set bit in sequence to a block. If
    there is no block, return an array of those numbers. */
-static VALUE rb_bitset_each_set(VALUE self) {
+static VALUE rb_bitset_each_set(int argc, VALUE * argv,  VALUE self) {
     Bitset * bs = get_bitset(self);
     int seg_no;
     int max = INTS(bs);
     uint64_t* seg_ptr = bs->data;
     int block_p = rb_block_given_p();
     VALUE ary = Qnil;
+    int set_bit_no = -1;
+
+    /* If there is one argument, it is an index into the notional
+       output array, and return an int. If there are two arguments,
+       return up to <n> arguments where is the second argument. */
+    int min_set_bit_no = (argc > 0) ? NUM2INT(argv[0]) : 0;
+    int max_set_bit_no;
+
+    if (argc > 2) {
+       VALUE error = rb_const_get(rb_cObject, rb_intern("ArgumentError"));
+       rb_raise(error, "wrong number of arguments (given %d, expected 0..2)",
+                argc);
+    }
+
+    if (min_set_bit_no < 0) {
+        /* Convert negative numbers into offsets from the end of the array. */
+        min_set_bit_no = cardinality(bs) + min_set_bit_no;
+    }
 
-    if (!block_p) {
+    max_set_bit_no = (argc == 0)
+        ? INT_MAX
+        : (argc == 1)
+        ? (min_set_bit_no + 1)
+        : (min_set_bit_no + NUM2INT(argv[1]));
+
+    if (min_set_bit_no < 0 || max_set_bit_no < min_set_bit_no)
+        return Qnil;
+
+    if (argc != 1 && !block_p) {
        ary = rb_ary_new();
     }
+    if (min_set_bit_no < 0 || max_set_bit_no < min_set_bit_no)
+        return Qnil;
 
     for (seg_no = 0; seg_no < max; ++seg_no, ++seg_ptr) {
        uint64_t segment = *seg_ptr;
        int bit_position = 0;
+       bool finished = false;
        while (segment) {
           VALUE v;
 
@@ -412,13 +448,26 @@ static VALUE rb_bitset_each_set(VALUE self) {
              segment >>= shift;
           }
           v = INT2NUM(_seg_no_to_bit_no(seg_no) + bit_position);
+          ++bit_position;
+          segment >>= 1;
+          ++set_bit_no;
+          if (set_bit_no < min_set_bit_no) {
+             continue;
+          }
+          if (set_bit_no >= max_set_bit_no) {
+              finished = true;
+             break;
+          }
           if (block_p) {
              rb_yield(v);
+          } else if (argc == 1) {
+              return v;
           } else {
              rb_ary_push(ary, v);
           }
-          ++bit_position;
-          segment >>= 1;
+       }
+       if (finished) {
+           break;
        }
     }
 
@@ -576,7 +625,7 @@ void Init_bitset() {
     rb_define_method(cBitset, "to_binary_array", rb_bitset_to_binary_array, 0);
     rb_define_method(cBitset, "dup", rb_bitset_dup, 0);
     rb_define_alias(cBitset, "clone", "dup");
-    rb_define_method(cBitset, "each_set", rb_bitset_each_set, 0);
+    rb_define_method(cBitset, "each_set", rb_bitset_each_set, -1);
     rb_define_alias(cBitset, "to_a", "each_set");
     /* #each_set allows an optional block, and #to_a normally doesn't.
         But an alias is simpler than having two different functions. */

data/spec/bitset_spec.rb

@@ -271,6 +271,13 @@ describe Bitset do
       bs.set(*sets)
       expect(bs.each_set).to eq(sets)
     end
+
+    it 'behaves properly with arguments' do
+      bs = Bitset.from_s "110110011"
+      expect { bs.each_set 1, 2, 3 }.to raise_error(ArgumentError)
+      expect(bs.each_set 2).to eq(3)
+      expect(bs.each_set -3, 2).to eq([4,7])
+    end
   end
 
   describe :empty? do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bitset
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Tyler McMullen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-26 00:00:00.000000000 Z
+date: 2018-01-06 00:00:00.000000000 Z
 dependencies: []
 description: A fast C-based Bitset. It supports the standard set operations as well
   as operations you may expect on bit arrays,such as popcount.
@@ -51,7 +51,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Bitset implementation.