Skip to content

Latest commit

 

History

History
389 lines (319 loc) · 16.4 KB

README.md

File metadata and controls

389 lines (319 loc) · 16.4 KB
Raw

interval-tree

A C++ header only interval tree implementation, which takes a red black tree as its base to inhibit degeneration to linked lists.

How an interval tree looks like:

ExampleTree

Example

// #include <interval-tree/draw.hpp> // to draw tree. this is not header only anymore.
#include <interval-tree/interval_tree.hpp>

int main()
{
  using namespace lib_interval_tree;

  // interval_tree<interval<int>>; // closed by default
  // interval_tree<interval<int, open>>;
  // interval_tree<interval<int, closed>>;
  // interval_tree<interval<int, left_open>>;
  // interval_tree<interval<int, right_open>>;
  // interval_tree<interval<int, closed_adjacent>>; // counts adjacent intervals as overlapping
  interval_tree_t<int> tree;

  tree.insert(make_safe_interval<int>(21, 16)); // make_safe_interval swaps low and high if not in right order.
  tree.insert({8, 9});
  tree.insert({25, 30});
  tree.insert({5, 8});
  tree.insert({15, 23});
  tree.insert({17, 19});
  tree.insert({26, 26});
  tree.insert({0, 3});
  tree.insert({6, 10});
  tree.insert({19, 20});

  tree.deoverlap();
  
  for (auto const& i : tree)
  {
    std::cout << "[" << i.low() << ", " << i.high() << "]\n";
  }

  // dynamic has some logic overhead.
  interval_tree<interval<int, dynamic>> dynamicIntervals;
  dynamicIntervals.insert({0, 1, interval_border::closed, interval_border::open});
  dynamicIntervals.insert({7, 5, interval_border::open, interval_border::closed_adjacent});
}

Compile & Run Testing

Having googletest (find here on github) installed / built is a requirement to run the tests. Create a build folder, navigate there, run cmake and build the tree-tests target. You might have to adapt the linker line for gtest, if you built it yourself and didn't install it into your system. If you want to generate the pretty drawings, install cairo, pull the submodule and pass INT_TREE_DRAW_EXAMPLES=on to the cmake command line to generate a drawings/make_drawings executeable.

Free Functions

interval<NumericT, Kind> make_safe_interval(NumericT border1, NumericT border2)

Creates an interval where the borders are sorted so the lower border is the first one.

Members of IntervalTree

iterator insert(interval_type const& ival)

Adds an interval into the tree.

Parameters

  • ival An interval

Returns: An iterator to the inserted element.

iterator insert_overlap(interval_type const& ival)

Inserts an interval into the tree if no other interval overlaps it. Otherwise merge the interval with the one being overlapped.

Parameters

  • ival An interval
  • exclusive Exclude borders from overlap check. Defaults to false.
  • mergeSetOverlapping If the result of interval::join is a collection of intervals, shall each be inserted with more overlap searches? Defaults to false

Returns: An iterator to the inserted element.

iterator erase(iterator iter)

Removes the interval given by iterator from the tree. (does not invalidate iterators).

Parameters

  • iter A valid non-end iterator

Returns: An iterator to the next element.

size_type size() const

Returns the amount of nodes in the tree.

Returns: The amount of tree nodes.

(const)iterator find(interval_type const& ival)

Finds the first interval in the interval tree that has an exact match. WARNING: There is no special handling for floats.

Parameters

  • ival The interval to find.

Returns: An iterator to the found element, or std::end(tree).

(const)iterator find(interval_type const& ival, CompareFunctionT const& compare)

Finds the first interval in the interval tree that has the following statement evaluate to true: compare(interval_in_tree, ival); Allows for propper float comparisons.

Parameters

  • ival The interval to find.
  • compare The compare function to compare intervals with. Function is called like so: compare(interval_in_tree, ival).

Returns: An iterator to the found element, or std::end(tree).

(const)iterator find_all(interval_type const& ival, OnFindFunctionT const& on_find)

Find all intervals in the tree matching ival.

Parameters

  • ival The interval to find.
  • on_find A function of type bool(iterator) that is called when an interval was found. Return true to continue, false to preemptively abort search.

Example

tree.insert({3, 7});
tree.insert({3, 7});
tree.insert({8, 9});
tree.find_all({3, 7}, [](auto iter) /* iter will be const_iterator if tree is const */ {
  // will find all intervals that are exactly {3,7} here.
  return true; // continue
});

Returns: An iterator to the found element, or std::end(tree).

(const)iterator find_all(interval_type const& ival, OnFindFunctionT const& on_find, CompareFunctionT const& compare)

Find all intervals in the tree that the compare function returns true for.

Parameters

  • ival The interval to find.
  • compare The compare function to compare intervals with. Function is called like so: compare(interval_in_tree, ival).
  • on_find A function of type bool(iterator) that is called when an interval was found. Return true to continue, false to preemptively abort search.

Returns: An iterator to the found element, or std::end(tree).

(const)iterator find_next_in_subtree(iterator from, interval_type const& ival)

Finds the next exact match EXCLUDING from in the subtree originating from "from". You cannot find all matches this way, use find_all for that.

Parameters

  • from The iterator to start from. (including this iterator!)
  • ival The interval to find.

Returns: An iterator to the found element, or std::end(tree).

(const)iterator find_next_in_subtree(iterator from, interval_type const& ival, CompareFunctionT const& compare)

Finds the next exact match EXCLUDING from in the subtree originating from "from". You cannot find all matches this way, use find_all for that.

Parameters

  • from The iterator to start from (including this iterator!)
  • ival The interval to find.
  • compare The compare function to compare intervals with. Function is called like so: compare(interval_in_tree, ival).

Returns: An iterator to the found element, or std::end(tree).

(const)iterator overlap_find(interval_type const& ival, bool exclusive)

Finds the first interval in the interval tree that overlaps the given interval.

Parameters

  • ival The interval to find an overlap for.
  • exclusive Exclude borders from overlap check. Defaults to false.

Returns: An iterator to the found element, or std::end(tree).

(const)iterator overlap_find_all(interval_type const& ival, OnFindFunctionT const& on_find, bool exclusive)

Finds all intervals in the interval tree that overlaps the given interval.

Parameters

  • ival The interval to find an overlap for.
  • on_find A function of type bool(iterator) that is called when an interval was found. Return true to continue, false to preemptively abort search.
  • exclusive Exclude borders from overlap check. Defaults to false.

Example

tree.insert({0, 5});
tree.insert({5, 10});
tree.insert({10, 15});
tree.overlap_find_all({5, 5}, [](auto iter) /* iter will be const_iterator if tree is const */ {
  // called with {0, 5} and {5, 10} in unspecified order.
  return true; // continue
});

Returns: An iterator to the found element, or std::end(tree).

(const)iterator overlap_find_next_in_subtree(interval_type const& ival, bool exclusive)

Finds the next interval in the subtree originating in ival that overlaps the given interval. You cannot find all matches this way, use overlap_find_all for that.

Parameters

  • ival The interval to find an overlap for.
  • exclusive Exclude borders from overlap check. Defaults to false.

Returns: An iterator to the found element, or std::end(tree).

interval_tree& deoverlap()

Merges all overlapping intervals within the tree. After calling deoverlap, the tree will only contain disjoint intervals.

Returns: *this

After deoverlap

AfterDeoverlap

interval_tree deoverlap_copy()

Same as deoverlap, but not inplace

interval_tree punch(interval_type const& ival)

Removes all intervals from ival and produces a tree that contains the remaining intervals. The tree must be deoverlapped, or the result is undefined. ival is expected to encompass the entire interval range.

Returns: A new interval_tree containing the gaps.

After punching (with [0, 50])

AfterPunch

interval_tree punch()

Same as punch(interval_type const& ival), but with ival = [lowest_lower_bound, highest_upper_bound], resulting in only the gaps between existing intervals.

bool empty() const noexcept

Returns whether or not the tree is empty.

Returns: Is this tree empty?

iterator begin()

Returns the iterator of the interval with the lowest lower_bound.

Returns: begin iterator.

iterator end()

Returns a past the end iterator.

Returns: past the end iterator.

iterator cbegin()

Returns the const_iterator of the interval with the lowest lower_bound.

Returns: begin iterator.

iterator cend()

Returns a past the end const_iterator.

Returns: past the end const_iterator.

reverse_iterator rbegin()

Returns the iterator of the interval with the highest lower_bound.

Returns: rbegin iterator.

reverse_iterator rend()

Returns a past the end iterator in reverse.

Returns: past the end iterator.

reverse_iterator crbegin()

Returns the const_iterator of the interval with the highest lower_bound.

Returns: begin iterator.

reverse_iterator crend()

Returns a past the end const_iterator in reverse.

Returns: past the end const_iterator.

Members of Interval

You can implement your own interval if you provide the same functions, except (within, operator-, size, operator!=).

There are 6 types of intervals:

  • open: (a, b)
  • left_open: (a, b]
  • right_open: [a, b)
  • closed: [a, b]
  • closed_adjacent: [a, b] (counts adjacent intervals as overlapping)
  • dynamic: Can be any of the above, depending on the input. Not supported for floating point.

Which can be picked with the second template parameter of interval: lib_interval_tree::interval<int, lib_interval_tree::open>

using value_type

The underlying interval numerical type

using interval_kind

The interval kind. You dont need to provides this typedef in your interval class.

friend bool operator==(interval const& lhs, interval const& other)

Comparison operator.

friend bool operator!=(interval const& lhs, interval const& other)

Comparison operator.

value_type low() const

Lower bound.

value_type high() const

Upper bound.

[[deprecated]] bool overlaps(value_type l, value_type h) const

Overlap these bounds with this interval? Is deprecated because the overlapping does not work with the dynamic interval type.

bool overlaps_exclusive(value_type l, value_type h) const

Overlap these bounds with this interval excluding borders?

bool overlaps(interval const& other) const

Like overlaps with lower and upper bound.

bool overlaps_exclusive(interval const& other) const

Like overlaps with lower and upper bound.

bool within(value_type value) const

Is the value within the interval?

bool within(interval const& other) const

Is the interval within the interval?

value_type operator-(interval const& other) const

Calculates the distance between the two intervals. Overlapping intervals have 0 distance.

value_type size() const

Returns The amount of elements in the interval when integral, or the distance between the 2 bounds when floating point.

interval join(interval const& other) const

Joins 2 intervals and whatever is inbetween.