range_tree 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8d1823bf3fb8b7ad048e704508d6a753a05a8456
+  data.tar.gz: 707cff2d18006ca2991a63622641b84274311474
+SHA512:
+  metadata.gz: ebb2ce6159ca59749afd5242d7b0fc0106a12fa95f6d2a662e9406dccdf091ef176c2d65d123a90576ced40906b997d672795d3e6b1eca83b393ca6dc761efe4
+  data.tar.gz: afa957ed7156481bed9bb21d8f44c5bb6a08accd74d90214612e4bbd2945a603f5728b8528923aaf634ec53e04f819291444100ee82253b14c2d68d393bc49eb

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in range_tree.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Wouter Coppieters
+
+MIT License
+
+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,96 @@
+# RangeTree
+
+Range Tree provides a flexible and efficient data structure for easily querying variables indexed by ranges.
+
+With a range tree you can easily query state at a given point
+or timestamp and or all variables that overlap with a given range.
+
+You can also use it to iterate through all points or all unique configurations contained within the range tree.
+
+You can use integers, floats, dates, times or similar comparable
+objects as range keys.
+
+For small trees you can use the default settings
+which rebuild the tree every time you add a value.
+
+If you need to build a very large tree with 1000's of values
+you need to pass ```rebuild_on_add: false``` to the tree.
+Then add everything to your tree and only once it is complete
+you must call ```tree.rebuild``` to build your index.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'range_tree'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install range_tree
+
+## Usage
+
+    # Below is an example using integers (formatted as dates) as keys. You can just as easily use dates, times
+    # floats or other comparable types.
+
+    require 'range_tree'
+
+    staff_holidays = RangeTree::Tree.new
+
+    staff_holidays[2000_01_01, 2000_01_15] = "John"
+    staff_holidays[2000_01_15, 2000_01_31] = "Greig"
+    staff_holidays[2000_01_20, 2000_02_05] = "Eve"
+    staff_holidays[2000_01_03, 2000_01_08] = "Alice"
+    staff_holidays[2000_01_18, 2000_01_20] = "Bob"
+
+    # Check who is on holiday on certain dates
+    staff_holidays[2000_01_04]
+    => ["Alice", "John"]
+
+    # Check all staff members on holiday within a certain period by passing a range
+    staff_holidays[2000_01_12..2011_01_19]
+    => ["John", "Bob", "Greig", "Eve"]
+
+
+    # Iterate through all periods where the system state changes
+    staff_holidays.distinct.each do |date, staff|
+      puts "From #{date} #{staff} will be on holiday"
+    end
+
+    =>
+    From 20000101 ["John"] will be on holiday
+    From 20000103 ["John", "Alice"] will be on holiday
+    From 20000109 ["John"] will be on holiday
+    From 20000115 ["John", "Greig"] will be on holiday
+    From 20000116 ["Greig"] will be on holiday
+    From 20000118 ["Greig", "Bob"] will be on holiday
+    From 20000120 ["Greig", "Bob", "Eve"] will be on holiday
+    From 20000121 ["Greig", "Eve"] will be on holiday
+    From 20000132 ["Eve"] will be on holiday
+    From 20000206 [] will be on holiday
+
+    # Iterate though all periods in the tree.
+    staff_holidays.all.each do |date, staff|
+      puts "#{staff} is on holiday on #{date}"
+    end
+
+    =>
+    ["John"] is on holiday on 20000101
+    ["John"] is on holiday on 20000102
+    ["John", "Alice"] is on holiday on 20000103
+    ["John", "Alice"] is on holiday on 20000104
+    ["John", "Alice"] is on holiday on 20000105
+    ["John", "Alice"] is on holiday on 20000106
+    ["John", "Alice"] is on holiday on 20000107
+    ["John", "Alice"] is on holiday on 20000108
+    ["John"] is on holiday on 20000109
+    ["John"] is on holiday on 20000110
+    ["John"] is on holiday on 20000111
+    ...
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/range_tree/version.rb

@@ -0,0 +1,3 @@
+module RangeTree
+  VERSION = "0.0.1"
+end

data/lib/range_tree.rb

@@ -0,0 +1,107 @@
+require "range_tree/version"
+
+module RangeTree
+  class Tree
+    require 'set'
+    attr_accessor :children, :root, :starts, :ends, :rebuild_on_add
+
+    MAX_REBUILD_SIZE = 500
+
+    def initialize(rebuild_on_add: true)
+      self.children = []
+      self.rebuild_on_add = rebuild_on_add
+      self.starts   = Hash.new{|h,k| h[k] = []}
+      self.ends     = Hash.new{|h,k| h[k] = []}
+    end
+
+    def add(min, max, value)
+      node =  Node.new(min, max, value)
+      self.children                                          << node
+      self.starts[min]                                       << node
+      self.ends[max.respond_to?(:succ) ? max.succ : max + 1] << node
+      self.rebuild if self.rebuild_on_add
+    end
+
+    def []=(min, max, value)
+      add(min, max, value)
+    end
+
+    def >>(value)
+      remove(value)
+    end
+
+    def remove(value)
+      return unless node_to_remove = self.children.find{|child| child.value == value}
+      self.children.delete(node_to_remove)
+      self.starts[node_to_remove.min].delete(node_to_remove)
+      self.ends[node_to_remove.max].delete(node_to_remove)
+      self.rebuild if self.rebuild_on_add
+      return node_to_remove.min..node_to_remove.max
+    end
+
+    def rebuild
+      current_level = self.children.sort_by(&:mid_point)
+      current_level = current_level.each_slice(2).map do |pair|
+        Node.new(pair.map(&:min).min, pair.map(&:max).max, pair)
+      end while current_level.length > 1
+      self.root = current_level.first
+    end
+
+
+    def distinct &block
+      iterate([*self.starts.keys, *self.ends.keys].uniq.sort).each(&block)
+    end
+
+    def all &block
+      iterate(self.starts.keys.min..self.ends.keys.max).each(&block)
+    end
+
+    def [](index)
+      return nil unless self.root
+      case index
+      when Range
+        self.root.search_range(index).map(&:value)
+      when Fixnum
+        self.root.search(index).map(&:value)
+      else
+        raise "Unexpected index type #{index.class}"
+      end
+    end
+
+    private
+    def iterate(range)
+      return [] unless self.root
+      collection = Set.new(self.root.search(range.first))
+      Enumerator.new do |enum|
+        range.each do |current_point|
+          self.ends[current_point].each{|node| collection.delete(node)} if self.ends.include?(current_point)
+          self.starts[current_point].each{|node| collection << node }   if self.starts.include?(current_point)
+          enum.yield current_point, collection.map(&:value)
+        end
+      end
+    end
+
+  end
+
+  class Node
+    attr_accessor :min, :max, :value, :mid_point
+    def initialize(min, max, value)
+      self.min, self.max, self.value = min, max, value
+      self.mid_point = self.min + (self.max - self.min) / 2.0
+    end
+
+    def search(index)
+      return [] unless (min..max) === index
+      Array === value && value.map{|v| v.search(index)}.flatten || [self]
+    end
+
+    def search_range(range)
+      return [] unless intersect((self.min..self.max),range)
+      Array === value && value.map{|v| v.search_range(range)}.flatten || [self]
+    end
+
+    def intersect(r1, r2)
+      !(r2.end < r1.first || r2.first > r1.end)
+    end
+  end
+end

data/range_tree.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'range_tree/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "range_tree"
+  spec.version       = RangeTree::VERSION
+  spec.authors       = ["Wouter Coppieters"]
+  spec.email         = ["wouter.coppieters@youdo.co.nz"]
+  spec.summary       = %q{An efficient tree structure for querying on data with overlapping ranges}
+  spec.description   = %q{An efficient tree structure for querying on data with overlapping ranges}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: range_tree
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Wouter Coppieters
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: An efficient tree structure for querying on data with overlapping ranges
+email:
+- wouter.coppieters@youdo.co.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/range_tree.rb
+- lib/range_tree/version.rb
+- range_tree.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: An efficient tree structure for querying on data with overlapping ranges
+test_files: []
+has_rdoc: