a set of Segments More...
#include <yat/utility/SegmentSet.h>
Inheritance diagram for theplu::yat::utility::SegmentSet< T, Compare >:
Public Types | |
| typedef std::set< Segment< T, Compare >, SegmentCompare< T, Compare > > ::key_type | key_type |
key type is same as Container 's key_type. More... | |
| typedef std::set< Segment< T, Compare >, SegmentCompare< T, Compare > > ::value_type | value_type |
value type is same as Container 's value_type. More... | |
| typedef key_type::value_type | element_type |
element type is same as key_type 's value_type. More... | |
| typedef std::set< Segment< T, Compare >, SegmentCompare< T, Compare > > ::key_compare | key_compare |
| key compare | |
| typedef std::set< Segment< T, Compare >, SegmentCompare< T, Compare > > ::value_compare | value_compare |
| value compare | |
| typedef Compare | element_compare |
| element compare | |
| typedef std::set< Segment< T, Compare >, SegmentCompare< T, Compare > > ::pointer | pointer |
| pointer | |
| typedef std::set< Segment< T, Compare >, SegmentCompare< T, Compare > > ::reference | reference |
| reference | |
| typedef std::set< Segment< T, Compare >, SegmentCompare< T, Compare > > ::const_reference | const_reference |
| const reference | |
| typedef std::set< Segment< T, Compare >, SegmentCompare< T, Compare > > ::size_type | size_type |
| size_type | |
| typedef std::set< Segment< T, Compare >, SegmentCompare< T, Compare > > ::difference_type | difference_type |
| difference_type | |
| typedef std::set< Segment< T, Compare >, SegmentCompare< T, Compare > > ::iterator | iterator |
| iterator | |
| typedef std::set< Segment< T, Compare >, SegmentCompare< T, Compare > > ::const_iterator | const_iterator |
| const_iterator | |
Public Member Functions | |
| SegmentSet (void) | |
| creates a set with no segments | |
| me::const_iterator | insert_merge (const Segment< T, Compare > &segment) |
| me::const_iterator | insert_merge (Segment< T, Compare > &&segment) |
| me::iterator | insert_merge (typename me::iterator hint, const Segment< T, Compare > &segment) |
| insert with a hint More... | |
| me::iterator | insert_merge (typename me::iterator hint, Segment< T, Compare > &&segment) |
| template<typename Iterator > | |
| void | insert_merge (Iterator first, Iterator last) |
| const_iterator | begin (void) const |
| iterator | begin (void) |
| void | clear (void) |
| erases all values | |
| size_type | count (const element_type &element) const |
| bool | empty (void) const |
| const_iterator | end (void) const |
| iterator | end (void) |
| void | erase (iterator first, iterator last) |
| erase values in range [first, last) More... | |
| void | erase (iterator pos) |
| iterator | find (const element_type &element) |
| const_iterator | find (const element_type &element) const |
| std::pair< iterator, bool > | insert (const value_type &value) |
| insert value More... | |
| std::pair< iterator, bool > | insert (value_type &&value) |
| key_compare | key_comp (void) const |
| iterator | lower_bound (const element_type &element) |
| similar to lower_bound in std::set and std::map More... | |
| const_iterator | lower_bound (const element_type &element) const |
| similar to lower_bound in std::set and std::map More... | |
| size_type | size (void) const |
| iterator | upper_bound (const element_type &element) |
| const_iterator | upper_bound (const element_type &element) const |
| similar to upper_bound in std::set and std::map More... | |
| value_compare | value_comp (void) const |
Protected Member Functions | |
| std::pair< iterator, iterator > | overlap_range (const key_type &segment) |
Protected Attributes | |
| std::set< Segment< T, Compare >, SegmentCompare< T, Compare > > | container_ |
| underlying container | |
Detailed Description
template<typename T, class Compare = std::less<T>>
class theplu::yat::utility::SegmentSet< T, Compare >
a set of Segments
A container that holds a set of Segment. The Segments cannot overlap.
- Since
- new in yat 0.7
Member Typedef Documentation
◆ element_type
|
inherited |
element type is same as key_type 's value_type.
If the key held is Segment<T>, value_type is T.
◆ key_type
|
inherited |
key type is same as Container 's key_type.
Typically Segment<element_type>.
◆ value_type
|
inherited |
value type is same as Container 's value_type.
Typically a Segment<element_type> or pair<const Segment<element_type>, Data>.
Member Function Documentation
◆ begin() [1/2]
|
inlineinherited |
- Returns
- const iterator pointing to beginning of container
◆ begin() [2/2]
|
inlineinherited |
- Returns
- iterator pointing to beginning of container
◆ count()
|
inherited |
- Returns
- 1 if there is a Segment that overlaps with element
◆ empty()
|
inlineinherited |
- Returns
trueif size is zero
◆ end() [1/2]
|
inlineinherited |
- Returns
- a const_iterator pointing to the end of container
◆ end() [2/2]
|
inlineinherited |
- Returns
- end of container
◆ erase() [1/2]
|
inlineinherited |
erase values in range [first, last)
- Since
- New in yat 0.8
◆ erase() [2/2]
|
inlineinherited |
erase value pointed to by pos
- Since
- New in yat 0.8
◆ find() [1/2]
|
inherited |
- Returns
- iterator pointing to value containing element
If no value contains element, end() is returned.
◆ find() [2/2]
|
inherited |
◆ insert() [1/2]
|
inherited |
insert value
if value does not overlap with container, insert segment; otherwise do nothing.
- Returns
- a pair where pair.first points to the inserted value or if value was not inserted it points to a value in container that overlaps with value; pair.second is true if value was inserted.
◆ insert() [2/2]
|
inherited |
Same as insert(const&) but move value rather than copy.
- Since
- New in yat 0.19
◆ insert_merge() [1/5]
template<typename T , class Compare = std::less<T>>
|
inline |
insert segment into set. If there is no gap between segment and neighboring segments the segments are merged.
◆ insert_merge() [2/5]
template<typename T , class Compare = std::less<T>>
|
inline |
insert segment into set. If there is no gap between segment and neighboring segments the segments are merged.
- Since
- New in yat 0.19
◆ insert_merge() [3/5]
template<typename T , class Compare = std::less<T>>
|
inline |
insert with a hint
Similar to insert_merge(1) but hint help to find where to insert segment. For the hint to be useful, segment should not be greater than element hint points to and not smaller than element –hint points to.
- Since
- New in yat 0.13
◆ insert_merge() [4/5]
template<typename T , class Compare = std::less<T>>
|
inline |
- Since
- New in yat 0.19
◆ insert_merge() [5/5]
template<typename T , class Compare = std::less<T>>
template<typename Iterator >
|
inline |
Insert range [first, last). Same result as inserting them individually, but inserting a range is potentially faster, especially if range is sorted and set is sparse compared to range.
- Since
- new in yat 0.13
◆ key_comp()
|
inlineinherited |
- Returns
- Comparison functor to compare two keys (Segment)
◆ lower_bound() [1/2]
|
inherited |
similar to lower_bound in std::set and std::map
- Returns
- iterator pointing to first value whose key overlaps with element or is greater than element.
◆ lower_bound() [2/2]
|
inherited |
similar to lower_bound in std::set and std::map
- Returns
- const iterator pointing to first value whose key overlaps with element or is greater than element.
◆ overlap_range()
|
inlineprotectedinherited |
pair.first first (smallest) segment that overlaps with segment and pair.second first (smallest) segment that does not overlap with segment.
◆ size()
|
inlineinherited |
- Returns
- number of values in container
◆ upper_bound() [1/2]
|
inherited |
- Returns
- iterator pointing to first segment that is greater than segment.
◆ upper_bound() [2/2]
|
inherited |
similar to upper_bound in std::set and std::map
- Returns
- iterator pointing to first value whose key is greater than element.
◆ value_comp()
|
inlineinherited |
- Returns
- the
value_compareobject used by the class to sortvalues
The documentation for this class was generated from the following file:
- yat/utility/SegmentSet.h
