roaring 0.3.0 → 0.4.1

data/lib/roaring.rb

@@ -1,44 +1,74 @@
 # frozen_string_literal: true
 
 require_relative "roaring/version"
-require_relative "roaring/roaring"
+require "roaring/roaring"
 require "set"
 
 module Roaring
   class Error < StandardError; end
 
   module BitmapCommon
-    def self.included(base)
-      super
-
-      base.extend ClassMethods
-
-      base.alias_method :size, :cardinality
-      base.alias_method :length, :cardinality
-      base.alias_method :count, :cardinality
-
-      base.alias_method :+, :|
-      base.alias_method :union, :|
-      base.alias_method :intersection, :&
-      base.alias_method :difference, :-
-
-      base.alias_method :delete, :remove
-      base.alias_method :delete?, :remove?
-
-      base.alias_method :first, :min
-      base.alias_method :last, :max
-
-      base.alias_method :eql?, :==
-
-      base.alias_method :===, :include?
-
-      base.alias_method :subset?, :<=
-      base.alias_method :proper_subset?, :<
-      base.alias_method :superset?, :>=
-      base.alias_method :proper_superset?, :>
-    end
-
     module ClassMethods
+      # @private
+      # @!macro [attach] property
+      #   @!parse alias_method :<<, :add
+      #
+      #   @!parse alias_method :size, :cardinality
+      #   @!parse alias_method :length, :cardinality
+      #   @!parse alias_method :count, :cardinality
+      #
+      #   @!parse alias_method :&, :and
+      #   @!parse alias_method :|, :or
+      #   @!parse alias_method :^, :xor
+      #   @!parse alias_method :-, :andnot
+      #   @!parse alias_method :+, :or
+      #   @!parse alias_method :union, :or
+      #   @!parse alias_method :intersection, :and
+      #   @!parse alias_method :difference, :andnot
+      #
+      #   @!parse alias_method :delete, :remove
+      #   @!parse alias_method :delete?, :remove?
+      #
+      #   @!parse alias_method :first, :min
+      #   @!parse alias_method :last, :max
+      #
+      #   @!parse alias_method :eql?, :==
+      #
+      #   @!parse alias_method :===, :include?
+      #
+      #   @!parse alias_method :subset?, :<=
+      #   @!parse alias_method :proper_subset?, :<
+      def define_roaring_aliases!
+        alias_method :<<, :add
+
+        alias_method :size, :cardinality
+        alias_method :length, :cardinality
+        alias_method :count, :cardinality
+
+        alias_method :&, :and
+        alias_method :|, :or
+        alias_method :^, :xor
+        alias_method :-, :andnot
+        alias_method :+, :or
+        alias_method :union, :or
+        alias_method :intersection, :and
+        alias_method :difference, :andnot
+
+        alias_method :delete, :remove
+        alias_method :delete?, :remove?
+
+        alias_method :first, :min
+        alias_method :last, :max
+
+        alias_method :eql?, :==
+
+        alias_method :===, :include?
+
+        alias_method :subset?, :<=
+        alias_method :proper_subset?, :<
+      end
+
+      # Convenience method for building a bitmap
       def [](*args)
         if args.size == 0
           new
@@ -61,6 +91,12 @@ module Roaring
 
       if enum.instance_of?(self.class)
         replace(enum)
+      elsif Range === enum
+        if enum.exclude_end?
+          add_range(enum.begin, enum.end)
+        else
+          add_range_closed(enum.begin, enum.end)
+        end
       else
         enum.each { |x| self << x }
       end
@@ -74,14 +110,27 @@ module Roaring
       replace(other)
     end
 
-    def >(other)
+    # Check if `self` is a superset of `other`. A superset requires that `self` contain all of `other`'s elemtents. They may be equal.
+    # @return [Boolean] `true` if `self` is a strict subset of `other`, otherwise `false`
+    def superset?(other)
+      other <= self
+    end
+
+    # Check if `self` is a strict superset of `other`. A strict superset requires that `self` contain all of `other`'s elemtents, but that they aren't exactly equal.
+    # @return [Boolean] `true` if `self` is a strict subset of `other`, otherwise `false`
+    def proper_superset?(other)
       other < self
     end
 
-    def >=(other)
-      other <= self
+    alias_method :>=, :superset?
+    alias_method :>, :proper_superset?
+
+    def add_range(min, max)
+      return if max <= min
+      add_range_closed(min, max - 1)
     end
 
+    # @return [Integer] Returns 0 if the bitmaps are equal, -1 / +1 if the set is a subset / superset of the given set, or nil if they both have unique elements.
     def <=>(other)
       if self == other
         0
@@ -102,14 +151,15 @@ module Roaring
       serialize
     end
 
-    def to_a
-      map(&:itself)
-    end
-
     def to_set
-      ::Set.new(to_a)
+      ::Set.new(self)
     end
 
+    # @example Small bitmap
+    #   Roaring::Bitmap32[1,2,3].inspect #=> "#<Roaring::Bitmap32 {1, 2, 3}>"
+    # @example Large bitmap
+    #   Roaring::Bitmap32[1..1000].inspect #=> "#<Roaring::Bitmap32 (1000 values)>"
+    # @return [String] a programmer-readable representation of the bitmap
     def inspect
       cardinality = self.cardinality
       if cardinality < 64
@@ -122,6 +172,9 @@ module Roaring
 
   class Bitmap32
     include BitmapCommon
+    extend BitmapCommon::ClassMethods
+
+    define_roaring_aliases!
 
     MIN = 0
     MAX = (2**32) - 1
@@ -130,6 +183,9 @@ module Roaring
 
   class Bitmap64
     include BitmapCommon
+    extend BitmapCommon::ClassMethods
+
+    define_roaring_aliases!
 
     MIN = 0
     MAX = (2**64) - 1

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: roaring
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - John Hawthorn
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-12 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prime
@@ -32,12 +31,14 @@ extensions:
 - ext/roaring/extconf.rb
 extra_rdoc_files: []
 files:
+- ".yardopts"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
+- benchmark/to_a.rb
+- benchmark/to_set.rb
 - ext/roaring/bitmap32.c
 - ext/roaring/bitmap64.c
 - ext/roaring/cext.c
@@ -56,7 +57,6 @@ metadata:
   homepage_uri: https://github.com/jhawthorn/roaring-ruby
   changelog_uri: https://github.com/jhawthorn/roaring-ruby
   source_code_uri: https://github.com/jhawthorn/roaring-ruby
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -71,8 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key:
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Roaring bitmaps for Ruby
 test_files: []

data/Gemfile.lock

@@ -1,39 +0,0 @@
-PATH
-  remote: .
-  specs:
-    roaring (0.3.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    debug (1.6.2)
-      irb (>= 1.3.6)
-      reline (>= 0.3.1)
-    forwardable (1.3.2)
-    io-console (0.5.11)
-    irb (1.4.1)
-      reline (>= 0.3.0)
-    minitest (5.16.3)
-    prime (0.1.2)
-      forwardable
-      singleton
-    rake (13.0.6)
-    rake-compiler (1.2.0)
-      rake
-    reline (0.3.1)
-      io-console (~> 0.5)
-    singleton (0.1.1)
-
-PLATFORMS
-  x86_64-linux
-
-DEPENDENCIES
-  debug
-  minitest (~> 5.0)
-  prime
-  rake (~> 13.0)
-  rake-compiler
-  roaring!
-
-BUNDLED WITH
-   2.3.4