range_list 1.0.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f27b8cd8551942e4ff09f2cc32c525e7fd5724cdbea8e322203cd01df681fb46
-  data.tar.gz: c24ffbe52e439561c2010fccdf67f68d9700703b23c4ed45d34c143ba5e6de46
+  metadata.gz: 7ea59292d297f5583f7a9ceddaf8194cbd33704180c3e43f15fe87358c8d02d5
+  data.tar.gz: f8ea601a80d2261c1b869aa57699bd0c71d048b4a94b25b978d67d1636d426b5
 SHA512:
-  metadata.gz: 62a1a66f4607c3e17424d8bd76cd8371626e8ff0d64961f189f09534fb33cc6e60537e821b3bb743389057db0c76a4e5e83cd7cbe8d3a6872c6c808891237f16
-  data.tar.gz: 9fb515423d8048f124e15a88cb3c5b718e7d273694bb8e9fe128ce2e37ebda636ba1da330af406abfc57d8566686fa71eff91d88c7af1eee55cd9b5b4ad75ad1
+  metadata.gz: 52b7dd400bb94273b9e0ff1702db7d5bd328f88e425322ba3838cc859e4629f0f5f2776bcedec7f73ba90ca0936b8f661fd435bde89bf67bbfdede88c93f62b5
+  data.tar.gz: af2aee3e2b4c37cdffbe89518423ea037b3348db50c9bfeff3b27259f6ff54f055265c3cbfb7c5ec7a9bc7410baa475e1d2f59be0259a5061b2e5197bd8e7280

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    range_list (1.0.0)
-      treemap (~> 1.0)
+    range_list (1.3.0)
+      rbtree (~> 0.4.5)
 
 GEM
   remote: https://rubygems.org/
@@ -15,6 +15,7 @@ GEM
       ast (~> 2.4.1)
     rainbow (3.1.1)
     rake (13.0.6)
+    rbtree (0.4.5)
     regexp_parser (2.2.1)
     rexml (3.2.5)
     rubocop (1.25.1)
@@ -44,7 +45,6 @@ GEM
     standard (1.7.2)
       rubocop (= 1.25.1)
       rubocop-performance (= 1.13.2)
-    treemap (1.0.3)
     unicode-display_width (2.1.0)
     webrick (1.7.0)
     yard (0.9.27)

data/README.md

@@ -1,15 +1,15 @@
 # RangeList
 
+RangeList is a library that can handle ranges quickly and appropriately.
+
 A pair of integers define a range, for example: [1, 5), this range includes integers: 1, 2, 3, and 4.
 A range list is an aggregate of these ranges: [1, 5), [10, 11), [100, 201).
 
-RangeList offers `add`, `remove`, `print`, `containsAll?`, `containsAny?` methods, and offers the `Enumerable` ability,
-you can handle ranges more easily.
+RangeList use AVL Tree processing internally, so range operations are very fast.
 
 [![Gem Version](https://badge.fury.io/rb/range_list.svg)](https://rubygems.org/gems/range_list)
 [![Documentation](https://img.shields.io/badge/docs-YARD-blue.svg)](https://rubydoc.info/gems/range_list)
 [![pipeline status](https://gitlab.com/songhuangcn/range_list/badges/main/pipeline.svg)](https://gitlab.com/songhuangcn/range_list/-/commits/main)
-[![coverage report](https://gitlab.com/songhuangcn/range_list/badges/main/coverage.svg)](https://gitlab.com/songhuangcn/range_list/-/commits/main)
 
 ## Installation
 
@@ -45,8 +45,11 @@ range_list.contains_any?([8, 10]) # false
 range_list.contains_any?([8, 11]) # true
 range_list.contains_all?([8, 11]) # false
 range_list.contains_all?([10, 11]) # true
+range_list.contains?(5) # false
+range_list.contains?(10) # true
 
-range_list.each { |range_start, range_end| puts "#{range_start} <= x < #{range_end}" } # print all range in order
+# RangeList has the `Enumerable` ability, feel free to use `each`, `map`, `to_a`, `min`, `max` etc. 
+range_list.each { |range_start, range_end| puts "#{range_start} <= x < #{range_end}" }
 
 range_list.remove([0, 100])
 range_list.print #

data/lib/range_list/avl_tree/abstract_adapter.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+class RangeList
+  # @!visibility private
+  module AvlTree
+    class AbstractAdapter
+      def put(key, value)
+        raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
+      end
+
+      def lower_entry(key)
+        raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
+      end
+
+      def sub_map(from_key, to_key)
+        raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
+      end
+
+      def remove(key)
+        raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
+      end
+
+      def each(&block)
+        raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
+      end
+    end
+  end
+end

data/lib/range_list/avl_tree/rbtree_adapter.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "rbtree"
+require_relative "abstract_adapter"
+
+class RangeList
+  # @!visibility private
+  module AvlTree
+    class RBTreeAdapter < AbstractAdapter
+      def initialize
+        @rbtree = RBTree.new
+      end
+
+      def put(key, value)
+        rbtree[key] = value
+      end
+
+      def lower_entry(key)
+        rbtree.upper_bound(key)
+      end
+
+      def sub_map(from_key, to_key)
+        rbtree.bound(from_key, to_key).to_a
+      end
+
+      def remove(key)
+        rbtree.delete(key)
+      end
+
+      def each(&block)
+        rbtree.each(&block)
+      end
+
+      private
+
+      attr_reader :rbtree
+    end
+  end
+end

data/lib/range_list/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class RangeList
-  VERSION = "1.0.0"
+  VERSION = "1.3.0"
 end

data/lib/range_list.rb

@@ -1,20 +1,21 @@
 # frozen_string_literal: true
 
-require "treemap"
 require_relative "range_list/version"
 require_relative "range_list/errors"
+require_relative "range_list/avl_tree/rbtree_adapter"
 
 class RangeList
   include Enumerable
 
   def initialize
-    @tree = TreeMap.new
+    @avl_tree = AvlTree::RBTreeAdapter.new
   end
 
   # Add range into current range list.
   # @param range [Array<Integer>] the range, first element is range start, second is range end.
   #   Range end need be greater or equal than range start.
   # @return [RangeList]
+  # @raise [ArgumentError] when argement invalid
   def add(range)
     validate_range!(range)
 
@@ -22,27 +23,27 @@ class RangeList
     return self if empty_range?(range)
 
     # Get real range start.
-    start_floor_entry = tree.floor_entry(range[0])
-    range_start = if !start_floor_entry.nil? && start_floor_entry.value >= range[0]
-      start_floor_entry.key
+    start_lower_range = avl_tree.lower_entry(range[0])
+    range_start = if !start_lower_range.nil? && start_lower_range[1] >= range[0]
+      start_lower_range[0]
     else
       range[0]
     end
 
     # Get real range end.
-    end_floor_entry = tree.floor_entry(range[1])
-    range_end = if !end_floor_entry.nil? && end_floor_entry.value >= range[1]
-      end_floor_entry.value
+    end_lower_range = avl_tree.lower_entry(range[1])
+    range_end = if !end_lower_range.nil? && end_lower_range[1] >= range[1]
+      end_lower_range[1]
     else
       range[1]
     end
 
     # Insert or replace new range.
-    tree.put(range_start, range_end)
+    avl_tree.put(range_start, range_end)
 
     # Remove keys between range, exclude start, include end.
-    between_maps = tree.sub_map(range[0], false, range[1], true)
-    between_maps.keys.each { |key| tree.remove(key) }
+    sub_range = avl_tree.sub_map(range[0] + 1, range[1])
+    sub_range.each { |range_start, _range_end| avl_tree.remove(range_start) }
 
     self
   end
@@ -50,27 +51,28 @@ class RangeList
   # Remove range from current range list.
   # @param (see #add)
   # @return [RangeList]
+  # @raise (see #add)
   def remove(range)
     validate_range!(range)
 
     # Return when range is empty.
     return self if empty_range?(range)
 
-    # Insert end lower entry
-    end_lower_entry = tree.lower_entry(range[1])
-    if !end_lower_entry.nil? && end_lower_entry.value > range[1]
-      tree.put(range[1], end_lower_entry.value)
+    # Insert end lower range, `-1` means not include.
+    end_lower_range = avl_tree.lower_entry(range[1] - 1)
+    if !end_lower_range.nil? && end_lower_range[1] > range[1]
+      avl_tree.put(range[1], end_lower_range[1])
     end
 
-    # Relace start lower entry
-    start_lower_entry = tree.lower_entry(range[0])
-    if !start_lower_entry.nil? && start_lower_entry.value > range[0]
-      tree.put(start_lower_entry.key, range[0])
+    # Relace start lower range, `-1` means not include.
+    start_lower_range = avl_tree.lower_entry(range[0] - 1)
+    if !start_lower_range.nil? && start_lower_range[1] > range[0]
+      avl_tree.put(start_lower_range[0], range[0])
     end
 
     # Remove keys between range, include start, exclude end
-    between_maps = tree.sub_map(range[0], true, range[1], false)
-    between_maps.keys.each { |key| tree.remove(key) }
+    sub_range = avl_tree.sub_map(range[0], range[1] - 1)
+    sub_range.each { |range_start, _range_end| avl_tree.remove(range_start) }
 
     self
   end
@@ -78,38 +80,57 @@ class RangeList
   # Print current range list.
   # @return [void]
   def print
-    puts to_a.map { |k, v| "[#{k}, #{v})" }.join(" ")
+    info = map { |k, v| "[#{k}, #{v})" }.join(" ")
+    puts info
   end
 
-  # Returns true if this set contains all elements of the range.
+  # Returns true if current ranges contains all elements of the range.
   # @param (see #add)
   # @return [Boolean]
   # @note return false if the argument range is empty
+  # @raise (see #add)
   def contains_all?(range)
+    validate_range!(range)
+
+    # Return false when range is empty.
     return false if empty_range?(range)
 
-    start_floor_entry = tree.floor_entry(range[0])
-    !start_floor_entry.nil? && start_floor_entry.value >= range[1]
+    start_lower_range = avl_tree.lower_entry(range[0])
+    !start_lower_range.nil? && start_lower_range[1] >= range[1]
   end
 
-  # Returns true if this set contains any element of the range.
+  # Returns true if current ranges contains any element of the range.
   # @param (see #add)
   # @return [Boolean]
   # @note return false if the argument range is empty
+  # @raise (see #add)
   def contains_any?(range)
+    validate_range!(range)
+
+    # Return false when range is empty.
     return false if empty_range?(range)
 
-    lower_floor_entry = tree.lower_entry(range[1])
-    !lower_floor_entry.nil? && lower_floor_entry.value > range[0]
+    # `-1` means not include.
+    end_lower_range = avl_tree.lower_entry(range[1] - 1)
+    !end_lower_range.nil? && end_lower_range[1] > range[0]
+  end
+
+  # Returns true if current ranges contains the element.
+  # @param element [Integer] the range element
+  # @return [Boolean]
+  # @raise (see #add)
+  def contains?(element)
+    raise ArgumentError, "`element` should be `Integer` type." unless element.is_a?(Integer)
+
+    lower_entry = avl_tree.lower_entry(element)
+    !lower_entry.nil? && lower_entry[1] > element
   end
 
   # Give RangeList iterative ability.
   # @yield [range_start, range_end] give the range element to the block
   def each(&block)
     if block
-      # Iterating an empty tree will raise an error,
-      # see https://github.com/davidkellis/treemap/issues/1
-      tree.empty? ? self : tree.each(&block)
+      avl_tree.each(&block)
     else
       enum_for(:each)
     end
@@ -120,15 +141,9 @@ class RangeList
     to_a.inspect
   end
 
-  # Return the current range as an array.
-  # @return [Array]
-  def to_a
-    tree.empty? ? [] : tree.to_a
-  end
-
   private
 
-  attr_reader :tree
+  attr_reader :avl_tree
 
   def validate_range!(range)
     raise ArgumentError, "`range` should be `Array` type." unless range.is_a?(Array)

data/range_list.gemspec

@@ -34,7 +34,7 @@ Gem::Specification.new do |spec|
 
   # Uncomment to register a new dependency of your gem
   # spec.add_dependency "example-gem", "~> 1.0"
-  spec.add_dependency "treemap", "~> 1.0"
+  spec.add_dependency "rbtree", "~> 0.4.5"
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: range_list
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Song Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-26 00:00:00.000000000 Z
+date: 2022-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: treemap
+  name: rbtree
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.4.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.4.5
 description:
 email:
 - songhuangcn@gmail.com
@@ -37,6 +37,8 @@ files:
 - README.md
 - Rakefile
 - lib/range_list.rb
+- lib/range_list/avl_tree/abstract_adapter.rb
+- lib/range_list/avl_tree/rbtree_adapter.rb
 - lib/range_list/errors.rb
 - lib/range_list/version.rb
 - range_list.gemspec