Skip to content

Commit

Permalink
README.rdoc update2
Browse files Browse the repository at this point in the history
  • Loading branch information
misshie committed Jul 11, 2011
1 parent 6bbf149 commit aa89d47
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions lib/README.rdoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
= IntervalTree

Title:: the IntervalTree module using "argumanted tree"
Author:: MISHIMA, Hiroyuki ( https://github.com/misshie )
Copyright:: The MIT/X11 license

== see also
*description in Wikipedia http://en.wikipedia.org/wiki/Interval_tree
*an implementstion in Python by Tyler Kahn http://forrst.com/posts/Interval_Tree_implementation_in_python-e0K

== usage
require "interval_tree"

itv = [(0...3), (1...4), (3...5),]
t = IntervalTree::Tree.new(itv)
p t.search(2) => [0...3, 1...4]
p t.search(1...3) => [0...3, 1...4, 3...5]

== note
result intervals are always returned
in the "left-closed and right-open" style that can be expressed
by three-dotted Range object literals (first...last)

Full-closed intervals "(first..last)" for tree are internally
converted to half-closed intervals.

0 comments on commit aa89d47

Please sign in to comment.