Skip to content

Commit eb01eb5

Browse files
authored
Merge pull request #24 from 5cript/feat/reverse-iterator-docs
Added documentation for rbegin etc.
2 parents 0c2ae27 + 720c053 commit eb01eb5

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,10 @@ Creates an interval where the borders are sorted so the lower border is the firs
8484
- [iterator end()](#iterator-end)
8585
- [iterator cbegin()](#iterator-cbegin)
8686
- [iterator cend()](#iterator-cend)
87+
- [iterator rbegin()](#iterator-rbegin)
88+
- [iterator rend()](#iterator-rend)
89+
- [iterator crbegin()](#iterator-crbegin)
90+
- [iterator crend()](#iterator-crend)
8791

8892
### iterator insert(interval_type const& ival)
8993
Adds an interval into the tree.
@@ -287,6 +291,32 @@ Returns a past the end const_iterator.
287291

288292
---
289293

294+
---
295+
### iterator rbegin()
296+
Returns the iterator of the interval with the highest lower_bound.
297+
298+
**Returns**: rbegin iterator.
299+
300+
---
301+
### iterator rend()
302+
Returns a past the end iterator in reverse.
303+
304+
**Returns**: past the end iterator.
305+
306+
---
307+
### iterator crbegin()
308+
Returns the const_iterator of the interval with the highest lower_bound.
309+
310+
**Returns**: begin iterator.
311+
312+
---
313+
### iterator crend()
314+
Returns a past the end const_iterator in reverse.
315+
316+
**Returns**: past the end const_iterator.
317+
318+
---
319+
290320
## Members of Interval
291321
___You can implement your own interval if you provide all the same functions.___
292322

0 commit comments

Comments
 (0)