Skip to content

Commit bd1b359

Browse files
author
Tim Ebbeke
committed
fixes documentation.
1 parent d79d5c9 commit bd1b359

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Creates an interval where the borders are sorted so the lower border is the firs
6767
- [Example](#example-1)
6868
- [(const)iterator find_all(interval_type const& ival, OnFindFunctionT const& on_find, CompareFunctionT const& compare)](#constiterator-find_allinterval_type-const-ival-onfindfunctiont-const-on_find-comparefunctiont-const-compare)
6969
- [(const)iterator find_next_in_subtree(iterator from, interval_type const& ival)](#constiterator-find_next_in_subtreeiterator-from-interval_type-const-ival)
70-
- [(const)iterator find_next(iterator from, interval_type const& ival, CompareFunctionT const& compare)](#constiterator-find_nextiterator-from-interval_type-const-ival-comparefunctiont-const-compare)
70+
- [(const)iterator find_next_in_subtree(iterator from, interval_type const& ival, CompareFunctionT const& compare)](#constiterator-find_next_in_subtreeiterator-from-interval_type-const-ival-comparefunctiont-const-compare)
7171
- [(const)iterator overlap_find(interval_type const& ival, bool exclusive)](#constiterator-overlap_findinterval_type-const-ival-bool-exclusive)
7272
- [(const)iterator overlap_find_all(interval_type const& ival, OnFindFunctionT const& on_find, bool exclusive)](#constiterator-overlap_find_allinterval_type-const-ival-onfindfunctiont-const-on_find-bool-exclusive)
7373
- [Example](#example-2)
@@ -127,11 +127,11 @@ Finds the first interval in the interval tree that has an exact match.
127127

128128
---
129129
### (const)iterator find(interval_type const& ival, CompareFunctionT const& compare)
130-
Finds the first interval in the interval tree that has the following statement evaluate to true: compare(ival, interval_in_tree);
130+
Finds the first interval in the interval tree that has the following statement evaluate to true: compare(interval_in_tree, ival);
131131
Allows for propper float comparisons.
132132
#### Parameters
133133
* `ival` The interval to find.
134-
* `compare` The compare function to compare intervals with.
134+
* `compare` The compare function to compare intervals with. Function is called like so: compare(interval_in_tree, ival).
135135

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

@@ -160,7 +160,7 @@ tree.find_all({3, 7}, [](auto iter) /* iter will be const_iterator if tree is co
160160
Find all intervals in the tree that the compare function returns true for.
161161
#### Parameters
162162
* `ival` The interval to find.
163-
* `compare` The compare function to compare intervals with.
163+
* `compare` The compare function to compare intervals with. Function is called like so: compare(interval_in_tree, ival).
164164
* `on_find` A function of type bool(iterator) that is called when an interval was found.
165165
Return true to continue, false to preemptively abort search.
166166

@@ -177,13 +177,13 @@ You cannot find all matches this way, use find_all for that.
177177
**Returns**: An iterator to the found element, or std::end(tree).
178178

179179
---
180-
### (const)iterator find_next(iterator from, interval_type const& ival, CompareFunctionT const& compare)
180+
### (const)iterator find_next_in_subtree(iterator from, interval_type const& ival, CompareFunctionT const& compare)
181181
Finds the next exact match EXCLUDING from in the subtree originating from "from".
182182
You cannot find all matches this way, use find_all for that.
183183
#### Parameters
184184
* `from` The iterator to start from (including this iterator!)
185185
* `ival` The interval to find.
186-
* `compare` The compare function to compare intervals with.
186+
* `compare` The compare function to compare intervals with. Function is called like so: compare(interval_in_tree, ival).
187187

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

0 commit comments

Comments
 (0)