range_list 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f27b8cd8551942e4ff09f2cc32c525e7fd5724cdbea8e322203cd01df681fb46
-  data.tar.gz: c24ffbe52e439561c2010fccdf67f68d9700703b23c4ed45d34c143ba5e6de46
+  metadata.gz: cbae62498893749767a5138f59caacd3de650bf62f566859d2ff16fc69e04a73
+  data.tar.gz: b5317ec465420963e3d392f89f22e2bf3a7a662a569c82084b4cbe5383eaab32
 SHA512:
-  metadata.gz: 62a1a66f4607c3e17424d8bd76cd8371626e8ff0d64961f189f09534fb33cc6e60537e821b3bb743389057db0c76a4e5e83cd7cbe8d3a6872c6c808891237f16
-  data.tar.gz: 9fb515423d8048f124e15a88cb3c5b718e7d273694bb8e9fe128ce2e37ebda636ba1da330af406abfc57d8566686fa71eff91d88c7af1eee55cd9b5b4ad75ad1
+  metadata.gz: 9f39a299e682ca947eeb1518cdba35eaad08b806433a849f1651ead445a7602fcb7c290611b8c3fa2601994003b74f3edbbe7909967d02064316db27d0d03a46
+  data.tar.gz: 286f03c1ecc1de6b5d0b5d4d271b0fcb2d3ea2f56c5a146d26e66b68a0fe168e0a8d093e781bb7c4a4551501682e8ea4534495a86f669470b73db52aa48a2028

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    range_list (1.0.0)
+    range_list (1.1.0)
       treemap (~> 1.0)
 
 GEM

data/README.md

@@ -1,10 +1,11 @@
 # 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)
@@ -45,8 +46,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/version.rb

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

data/lib/range_list.rb

@@ -15,6 +15,7 @@ class RangeList
   # @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)
 
@@ -50,6 +51,7 @@ class RangeList
   # Remove range from current range list.
   # @param (see #add)
   # @return [RangeList]
+  # @raise (see #add)
   def remove(range)
     validate_range!(range)
 
@@ -78,29 +80,48 @@ class RangeList
   # Print current range list.
   # @return [void]
   def print
-    puts to_a.map { |k, v| "[#{k}, #{v})" }.join(" ")
+    puts map { |k, v| "[#{k}, #{v})" }.join(" ")
   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]
   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]
+    end_lower_entry = tree.lower_entry(range[1])
+    !end_lower_entry.nil? && end_lower_entry.value > 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)
+
+    floor_entry = tree.floor_entry(element)
+    !floor_entry.nil? && floor_entry.value > element
   end
 
   # Give RangeList iterative ability.
@@ -120,12 +141,6 @@ 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: range_list
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Song Huang