yet_another_range_list 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 380dd1f35360cdee97a14273f566eb744efdec0c1b5ff7ffeb02d977eb6c2127
+  data.tar.gz: b710ede01dbf42129ca3220c478e01c9bf988a195b9e32e4b56c1a026d4a411c
+SHA512:
+  metadata.gz: ff66046a6c6a22e3e3f14fdd7c5f53295772cc53c3c65de0fb4b58d61b7b5ab1ccf073b4afc35a932030654e2eeb58e8bbfbef719a11565187c39ace0897444e
+  data.tar.gz: fcf35b4ff4082186377b775b59e060b22faec04b61ad1015c645189bbe13dba14e82523e1bfcb7ba4dbcf97a31fa852b93682f1868a2e4745eb44400b4cb6885

data/.ruby-version

@@ -0,0 +1 @@
+3.3.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Bran Liang
+
+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,92 @@
+# YARL (Yet Another Range List)
+
+YARL is a Ruby gem that provides efficient functionality for managing and manipulating range lists using a [segment tree](https://en.wikipedia.org/wiki/Segment_tree) data structure.
+
+## Features
+
+- Add and remove ranges with ease
+- Efficient range manipulation using segment trees
+- Configurable maximum and minimum values
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yet_another_range_list'
+```
+
+And then execute:
+
+```
+$ bundle install
+```
+
+Or install it yourself as:
+
+```
+$ gem install yet_another_range_list
+```
+
+## Usage
+
+### Basic Operations
+
+```ruby
+require 'yet_another_range_list'
+
+rl = YARL::RangeList.new
+
+# Add ranges
+rl.add([1, 5])
+rl.add([3, 8])
+rl << [10, 20]
+
+# Remove ranges
+rl.remove([10, 11])
+rl.delete([15, 17])
+
+# Print the current range list (Left bound inclusive, and right bound exclusive)
+rl.print
+# => [1, 8) [11, 15) [17, 20)
+
+# Get current ranges (Both bound inclusively)
+rl.to_a
+# => [[1, 7], [11, 14], [17, 19]]
+```
+
+### Configuration
+
+By default the support integer range is between `0` and `4294967295` (The max number for unsigned 32bit integer), you can customize the limit when initializing a `RangeList`:
+
+```ruby
+rl = YARL::RangeList.new(-1000, 1000)
+```
+
+## Performance and Complexity
+
+YARL uses a segment tree data structure to efficiently manage range operations. This allows for better performance compared to naive implementations, especially for large datasets or frequent operations.
+
+### Time Complexity
+
+- **Initialization**: O(1).
+- **Add/Remove Range**: O(log n) per operation, where n is the range of possible values (max_n - min_n).
+- **Print/To Array**: O(log n).
+
+### Space Complexity
+
+- O(m), where m is the number of distinct intervals that have been added or removed. This is because new nodes in the tree are only created when a range is modified.
+
+## 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).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the YARL project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://jihulab.com/branliang1/yarl/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+task default: :test

data/lib/YARL/constants.rb

@@ -0,0 +1,7 @@
+module YARL
+  module Constants
+    # The maximum value of a 32-bit unsigned integer
+    DEFAULT_MAX_N = (1 << 32) - 1
+    DEFAULT_MIN_N = 0
+  end
+end

data/lib/YARL/node.rb

@@ -0,0 +1,27 @@
+module YARL
+  class Node
+    attr_reader :l, :r
+    attr_accessor :left, :right, :covered, :lazy_op
+    def initialize(l, r)
+      # l and r are the left and right bounds of the range
+      @l = l
+      @r = r
+
+      # left and right are the children of the node
+      @left = nil
+      @right = nil
+
+      # covered is true if the range is completely covered in the segment tree
+      @covered = false
+
+      # lazy_op is the operation to be applied to the node
+      @lazy_op = nil
+    end
+
+    def print(indent = 0)
+      puts "#{' ' * indent}[#{l}, #{r}] #{covered ? '(Y)' : ''} #{lazy_op ? '(LZ)' : ''}"
+      left&.print(indent + 2)
+      right&.print(indent + 2)
+    end
+  end
+end

data/lib/YARL/operation.rb

@@ -0,0 +1,6 @@
+module YARL
+  module Operation
+    ADDING = 1
+    REMOVING = 2
+  end
+end

data/lib/YARL/range_list.rb

@@ -0,0 +1,61 @@
+module YARL
+  class RangeList
+    include Enumerable
+
+    def initialize(min = Constants::DEFAULT_MIN_N, max = Constants::DEFAULT_MAX_N)
+      @tree = SegmentTree.new(min, max)
+      @min = min
+      @max = max
+    end
+
+    # Add a range to the list
+    #
+    # @param range [Array<Integer>] the range to add
+    # @return [Self]
+    # @raise [RangeError] if the range is out of bounds
+    # @raise [RangeError] if the left bound is greater than the right bound
+    def add(range)
+      if range[0] < @min || range[1] > @max
+        raise RangeError, "Range [#{range[0]}, #{range[1]}) out of bounds. Valid range: [#{@min}, #{@max}]"
+      end
+
+      if range[0] > range[1]
+        raise RangeError, "Left bound must be less than or equal to right bound"
+      end
+
+      @tree.update(range[0], range[1] - 1, Operation::ADDING)
+      self
+    end
+    alias_method :<<, :add
+
+    # Remove a range from the list
+    #
+    # @param range [Array<Integer>] the range to remove
+    # @return [Self]
+    def remove(range)
+      @tree.update(range[0], range[1] - 1, Operation::REMOVING)
+      self
+    end
+    alias_method :delete, :remove
+
+    def each(&block)
+      @tree.ranges.each do |range|
+        block.call(range)
+      end
+    end
+
+    # Print the ranges in the list, separated by a space
+    # Left bound is inclusive, right bound is exclusive
+    #
+    # @return [void]
+    def print
+      ranges_str = @tree.ranges.map do |range|
+        "[#{range[0]}, #{range[1] + 1})"
+      end.join(" ")
+
+      puts ranges_str
+    end
+    alias_method :to_s, :print
+    alias_method :inspect, :print
+  end
+end

data/lib/YARL/segment_tree.rb

@@ -0,0 +1,76 @@
+module YARL
+  class SegmentTree
+    attr_reader :root
+    def initialize(min, max)
+      @root = Node.new(min, max)
+    end
+
+    def update(start, finish, operation = Operation::ADDING, node = @root)
+      if start <= node.l && finish >= node.r
+        node.lazy_op = operation
+        node.left = nil
+        node.right = nil
+        case operation
+        when Operation::ADDING
+          node.covered = true
+        when Operation::REMOVING
+          node.covered = false
+        else
+          raise ArgumentError, "Invalid operation"
+        end
+        return
+      end
+
+      # Push down the operation to the children
+      mid = (node.l + node.r) >> 1
+      node.left ||= Node.new(node.l, mid)
+      node.right ||= Node.new(mid + 1, node.r)
+      if node.lazy_op
+        [node.left, node.right].each do |child|
+          child.lazy_op = node.lazy_op
+          case node.lazy_op
+          when Operation::ADDING
+            child.covered = true
+          when Operation::REMOVING
+            child.covered = false
+          else
+            raise ArgumentError, "Invalid operation"
+          end
+        end
+        node.lazy_op = nil
+      end
+
+      if start <= mid
+        update(start, finish, operation, node.left)
+      end
+
+      if finish > mid
+        update(start, finish, operation, node.right)
+      end
+
+      # Push up the operation to the parent
+      node.covered = node.left.covered && node.right.covered
+      nil
+    end
+
+    def ranges(node = @root, acc = [])
+      if node.covered
+        last = acc.last
+        # Merge the ranges if they are adjacent
+        if last && last[1] + 1 == node.l
+          last[1] = node.r
+        else
+          acc << [node.l, node.r]
+        end
+      else
+        ranges(node.left, acc) if node.left
+        ranges(node.right, acc) if node.right
+      end
+      acc
+    end
+
+    def print
+      @root.print
+    end
+  end
+end

data/lib/YARL/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module YARL
+  VERSION = "0.1.0"
+end

data/lib/YARL.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "YARL/version"
+require_relative "YARL/constants"
+require_relative "YARL/operation"
+require_relative "YARL/node"
+require_relative "YARL/segment_tree"
+require_relative "YARL/range_list"
+
+module YARL
+  class Error < StandardError; end
+  class RangeError < Error; end
+end

data/sig/YARL.rbs

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

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: yet_another_range_list
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bran Liang
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-07-18 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- lby89757@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/YARL.rb
+- lib/YARL/constants.rb
+- lib/YARL/node.rb
+- lib/YARL/operation.rb
+- lib/YARL/range_list.rb
+- lib/YARL/segment_tree.rb
+- lib/YARL/version.rb
+- sig/YARL.rbs
+homepage: https://jihulab.com/branliang1/yarl
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://jihulab.com/branliang1/yarl
+  source_code_uri: https://jihulab.com/branliang1/yarl
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.15
+signing_key:
+specification_version: 4
+summary: Yet Another Range List library to handle integer ranges.
+test_files: []