Interface Functions Detail
TIterator begin(deltaMap, tag)
Returns an iterator pointing to the beginning of the map.
Parameters
Returns
TIterator |
An iterator of type Iterator pointing to the beginning of the map. |
Data Races
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
clear(deltaMap)
Parameters
deltaMap
|
The map to be cleared. |
Data Races
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
TSize count(deltaMap, pos, type)
Counts the number of elements that compare equal to the specified key.
Parameters
deltaMap
|
The delta map that is searched for the element. |
pos
|
The delta position to be searched for. |
type
|
The type of the delta operation. Must be of type DeltaTypeTags. |
Returns
TSize |
the number of elements with the specified key. Of type Size. |
@remark The runtime is logarithmic in the size of the map.
Data Races
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
bool empty(deltaMap)
Checks if the delta map is empty.
Parameters
deltaMap
|
The map to be checked for. |
Returns
bool |
true if empty, otherwise false |
Data Races
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
TIterator end(deltaMap, tag)
Returns an iterator pointing to the end of the map.
Parameters
Returns
TIterator |
An iterator of type Iterator pointing to the end of the map. |
Data Races
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
Pair<TIterator> equalRange(deltaMap, pos, type)
Returns the range over all elements comparing equal to the specified key.
Parameters
deltaMap
|
The delta map that is searched for the element. |
pos
|
The delta position to be searched for. |
type
|
The type of the delta operation. Must be of type DeltaTypeTags. |
Returns
Pair<TIterator> |
A Pair of iterator types Iterator. The first value points
to the first element that compares not less than the specified key or to the end if such an elment could not be found.
The second value points to the first element that does not compare less than or equal to the specified key or to the end if such an elment could not be found. |
@remark The runtime is logarithmic in the size of the map.
Data Races
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
bool erase(deltaMap, pos, type);
Erases an existing delta entry.
Parameters
deltaMap
|
The map to erase the delta from. Of type DeltaMap. |
pos
|
The position of the targeted delta entry. |
type
|
The type of the targeted delta entry. One of DeltaTypeTags. |
Returns
bool |
false<\tt> if such an entry does not exist, true<\tt> otherwise. |
@remark The map is implemented as a vector and the insertion time is linear in worst case.
Data Races
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
TIterator find(deltaMap, pos, type)
Finds the element specified by the given delta position and delta type.
Parameters
deltaMap
|
The delta map that is searched for the element. |
pos
|
The delta position to be searched for. |
type
|
The type of the delta operation. Must be of type DeltaTypeTags. |
Returns
TIterator |
An Iterator pointing to the corresponding element.
If the key is not contained end is returned. |
@remark The runtime is logarithmic in the size of the map.
Data Races
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
bool insert(deltaMap, pos, val, cov, type);
Inserts a new delta entry.
Parameters
deltaMap
|
The map to insert the new delta operation. Of type DeltaMap. |
pos
|
The position of the inserted delta entry. |
deltaVal
|
The value of the delta operation. |
cov
|
The coverage of the delta operation. |
type
|
A specifier to select the correct delta type. One of DeltaTypeTags. |
@remark The map is implemented as a vector and the insertion time is linear in worst case.
Data Races
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
TIterator lowerBound(deltaMap, pos, type)
Finds the first element that compares not less than the specified key.
Parameters
deltaMap
|
The delta map that is searched for the element. |
pos
|
The delta position to be searched for. |
type
|
The type of the delta operation. Must be of type DeltaTypeTags. |
Returns
TIterator |
An Iterator pointing to the corresponding element.
If the key is not contained end is returned. |
@remark The runtime is logarithmic in the size of the map.
Data Races
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
TSize size(deltaMap)
Returns the number of mapped delta events.
Parameters
deltaMap
|
The map to get the size for. |
Returns
TSize |
The number of delta events stored in the map. |
Data Races
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
TSize size(deltaMap)
Returns the number of mapped delta events.
Parameters
deltaMap
|
The map to get the size for. |
Returns
TSize |
The number of delta events stored in the map. |
Data Races
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
TIterator upperBound(deltaMap, pos, type)
Finds the first element that compares not less or equal to the specified key.
Parameters
deltaMap
|
The delta map that is searched for the element. |
pos
|
The delta position to be searched for. |
type
|
The type of the delta operation. Must be of type DeltaTypeTags. |
Returns
TIterator |
An Iterator pointing to the corresponding element.
If the key is not contained end is returned. |
@remark The runtime is logarithmic in the size of the map.
Data Races
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.