range_list_rb 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 279924926180cea40ac46209691189d10dc0e0957c2277d95974d9f48881e929
+  data.tar.gz: 0e675975de6bbcf768bfbeb217c947d3ab1d0202663736673882945f0580bef8
+SHA512:
+  metadata.gz: a09f8b1b8957df0a8d486e9805355915e81cfbf9a1401b97b5cde31845b4330b3ec29ee2a4aa582e03361938f6355e296b76d7b78e4bc2dbd36b7b9300ed9a1e
+  data.tar.gz: 42494b7ec55a7c8d800d7e8263b8a4c55ffd894e61e79fbee0a8616f371fcf422d4542acc0a0deb441058580fd9da236f39e79aed85bb7b265da2e1e9f0ad479

data/.rubocop.yml

@@ -0,0 +1,21 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  Exclude:
+    - 'test/**/*'
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/AbcSize:
+  Max: 50
+
+Metrics/MethodLength:
+  Max: 70

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in range_list.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "rubocop", "~> 1.28", require: false

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    range_list_rb (0.2.0)
+      rbtree (~> 0.4.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    minitest (5.15.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rbtree (0.4.5)
+    regexp_parser (2.3.1)
+    rexml (3.2.5)
+    rubocop (1.28.2)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.17.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.17.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  range_list_rb!
+  rubocop (~> 1.28)
+
+BUNDLED WITH
+   2.3.13

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 songzheng
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,48 @@
+# RangeList
+
+RangeList is a library for fast and efficient processing of intervals.
+
+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).
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add range_list
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install range_list
+
+## Usage
+
+```ruby
+range_list = RangeList.new # create a RangeList instance
+
+range_list.add([1, 5])
+range_list.print # [1, 5)
+
+range_list.add([10, 20])
+range_list.print # [1, 5) [10, 20)
+
+range_list.add([20, 20])
+range_list.print # [1, 5) [10, 20)
+
+range_list.remove([3, 12])
+range_list.print # [1, 3) [12, 20)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and merge requests are welcome on GitLab at https://gitlab.com/songzheng1997/range_list. This project is intended to be a safe, welcoming space for collaboration.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/range_list/errors.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# errors in RangeList
+class RangeList
+  # base error define
+  class Error < StandardError; end
+
+  # raised when input arguments are illegal
+  class IllegalArgumentError < Error; end
+end

data/lib/range_list/map/sorted_map.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+class RangeList
+  module Map
+    # A Map that provides a ordering on its keys.
+    module SortedMap
+      # Returns the value to which the specified key is mapped, or nil if this map contains no mapping for the key.
+      def get(key)
+        raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
+      end
+
+      # Associates the specified value with the specified key in this map.
+      # If the map previously contained a mapping for the key, the old value is replaced by the specified value.
+      def put(key, value)
+        raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
+      end
+
+      # Removes the mapping for a key from this map if it is present.
+      def remove(key)
+        raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
+      end
+
+      # Returns a key-value mapping associated with the greatest key less than or equal to the given key,
+      # or null if there is no such key.
+      def floor_entry(key)
+        raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
+      end
+
+      # Returns a key-value mapping associated with the least key greater than or equal to the given key,
+      # or null if there is no such key.
+      def ceiling_entry(key)
+        raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
+      end
+
+      # Returns a key-value mapping associated with the greatest key strictly less than the given key,
+      # or null if there is no such key.
+      def lower_entry(key)
+        raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
+      end
+
+      # Returns a key-value mapping associated with the least key strictly greater than the given key,
+      # or null if there is no such key.
+      def higher_entry(key)
+        raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
+      end
+
+      # Returns a view of the portion of this map whose keys range from from_key, inclusive, to to_key, exclusive.
+      def sub_map(from_key, to_key)
+        raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
+      end
+
+      # Support iteration.
+      def each(&block)
+        raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
+      end
+    end
+  end
+end

data/lib/range_list/map/tree_map.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "rbtree"
+require_relative "sorted_map"
+
+class RangeList
+  module Map
+    # Sorted map implementation using red-black tree
+    class TreeMap
+      include SortedMap
+
+      def initialize
+        @rbtree = RBTree.new
+      end
+
+      def get(key)
+        @rbtree[key]
+      end
+
+      def put(key, value)
+        @rbtree[key] = value
+      end
+
+      def remove(key)
+        @rbtree.delete(key)
+      end
+
+      def floor_entry(key)
+        @rbtree.upper_bound(key)
+      end
+
+      def ceiling_entry(key)
+        @rbtree.lower_bound(key)
+      end
+
+      def sub_map(from_key, to_key)
+        @rbtree.bound(from_key, to_key).to_a
+      end
+
+      def each(&block)
+        @rbtree.each(&block)
+      end
+
+      private
+
+      attr_reader :rbtree
+    end
+  end
+end

data/lib/range_list/version.rb

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

data/lib/range_list.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require_relative "range_list/version"
+require_relative "range_list/map/tree_map"
+require_relative "range_list/errors"
+
+# range list
+class RangeList
+  include Enumerable
+
+  def initialize
+    @tree_map = Map::TreeMap.new
+  end
+
+  # Add specified range into current RangeList
+  # @param range [Array<Integer>] Two integer element such as [left, right], include left, exclude right.
+  # @return [RangeList]
+  # @raise [IllegalArgumentError] when range is invalid
+  def add(range)
+    validate_range!(range)
+    self if validate_empty_range?(range)
+
+    # 1. Compute the range of the merged interval
+    left_bound = range[0]
+    left_floor_range = @tree_map.floor_entry(range[0])
+    if !left_floor_range.nil? && left_floor_range[1] >= range[0]
+      # left_floor_range and range has overlapping interval
+      left_bound = left_floor_range[0]
+    end
+
+    right_bound = range[1]
+    right_floor_range = @tree_map.floor_entry(range[1])
+    if !right_floor_range.nil? && right_floor_range[1] >= range[1]
+      # right_floor_range and range has overlapping interval
+      right_bound = right_floor_range[1]
+    end
+
+    # 2. Remove overlapping intervals
+    overlapping_ranges = @tree_map.sub_map(left_bound, right_bound)
+    overlapping_ranges.each { |left, _right| @tree_map.remove(left) }
+
+    # 3. Insert new range
+    @tree_map.put(left_bound, right_bound)
+
+    self
+  end
+
+  # Remove specified range from current range
+  # @param range [Array<Integer>] Two integer element such as [left, right], include left, exclude right.
+  # @return [RangeList]
+  # @raise [IllegalArgumentError] when range is invalid
+  def remove(range)
+    validate_range!(range)
+    self if validate_empty_range?(range)
+
+    # 1. Remove overlapping intervals
+    right_lower_range = @tree_map.floor_entry(range[1] - 1)
+    if !right_lower_range.nil? && right_lower_range[1] > range[1]
+      # right_lower_range and range has overlapping interval
+      # insert new range after remove overlapping interval
+      @tree_map.put(range[1], right_lower_range[1])
+    end
+
+    left_lower_range = @tree_map.floor_entry(range[0] - 1)
+    if !left_lower_range.nil? && left_lower_range[1] > range[0]
+      # left_lower_range and range has overlapping interval
+      # insert new range after remove overlapping interval
+      @tree_map.put(left_lower_range[0], range[0])
+    end
+
+    # 2. Remove ranges completely covered by input range
+    # to_key is range[1] - 1 because right bound is exclusive
+    overlapping_ranges = @tree_map.sub_map(range[0], range[1] - 1)
+    overlapping_ranges.each { |left, _right| @tree_map.remove(left) }
+
+    self
+  end
+
+  # Print RangeList to stdout
+  def print
+    Kernel.print to_s
+  end
+
+  def each(&block)
+    @tree_map.each(&block)
+  end
+
+  def to_s
+    map { |k, v| "[#{k}, #{v})" }.join(" ")
+  end
+
+  private
+
+  attr_reader :tree_map
+
+  def validate_range!(range)
+    raise IllegalArgumentError, "range cannot be nil" if range.nil?
+    raise IllegalArgumentError, "range must be Array type" unless range.is_a?(Array)
+    unless range.size == 2 && range.all? { |elem| elem.is_a?(Integer) }
+      raise IllegalArgumentError, "range can only contain two Integer elements"
+    end
+    raise IllegalArgumentError, "range's left element must less equal than right element" unless range[0] <= range[1]
+  end
+
+  def validate_empty_range?(range)
+    range[0] >= range[1]
+  end
+end

data/range_list.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/range_list/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "range_list_rb"
+  spec.version = RangeList::VERSION
+  spec.authors = ["songzheng"]
+  spec.email = ["zhenran.sz@gmail.com"]
+
+  spec.summary = "A library for fast and efficient processing of intervals."
+  spec.description = "A library for fast and efficient processing of intervals."
+  spec.homepage = "https://gitlab.com/songzheng1997/range_list"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://gitlab.com/songzheng1997/range_list"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  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
+end

data/sig/range_list.rbs

@@ -0,0 +1,4 @@
+module RangeList
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: range_list_rb
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- songzheng
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rbtree
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.5
+description: A library for fast and efficient processing of intervals.
+email:
+- zhenran.sz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/range_list.rb
+- lib/range_list/errors.rb
+- lib/range_list/map/sorted_map.rb
+- lib/range_list/map/tree_map.rb
+- lib/range_list/version.rb
+- range_list.gemspec
+- sig/range_list.rbs
+homepage: https://gitlab.com/songzheng1997/range_list
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://gitlab.com/songzheng1997/range_list
+  source_code_uri: https://gitlab.com/songzheng1997/range_list
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: A library for fast and efficient processing of intervals.
+test_files: []