Spec
JournaledStringJournaled versions of arbitrary underlying strings.
Journaled versions of arbitrary underlying strings.
| Extends | String |
|---|---|
| All Extended | String |
| All Impl'd | AssignableConcept, ContainerConcept, DestructibleConcept, ForwardContainerConcept, RandomAccessContainerConcept, ReversibleContainerConcept, SegmentableConcept, StringConcept, TextConcept |
| Defined in | <seqan/sequence_journaled.h> |
| Signature |
template <typename TValue, typename THostSpec[, typename TJournalSpec[, typename TBufferSpec]]>
class String<TValue, Journaled<THostSpec, TJournalSpec, TBufferSpec> >;
|
Template Parameters
TValue |
The element type of the string. |
|---|---|
THostSpec |
Specialization type for the host string. |
TJournalSpec |
Specialization type for the journal. Default: SortedArray. |
TBufferSpec |
Specialization type for the buffer string. Default: Alloc<>. |
Member Function Overview
Member Functions Inherited From String
Member Functions Inherited From AssignableConcept
Member Functions Inherited From RandomAccessContainerConcept
Interface Function Overview
-
void clear(js);Remove all changes from the journal, resetting the JournaledString to its state after construction. -
void flatten(js);Apply the journal to the underlying string, modifying the underlying string. -
THost host(js);Return the host of a JournaledString. -
TPos hostToVirtualPosition(js, pos);Translates host position to virtual position. -
bool isFlat(js);Returns whether a JournaledString has modifications. -
void setHost(js, str);Set the host of a JournaledString. -
TPos virtualToHostPosition(js, pos);Translates virtual (view) position to position in host.
Interface Functions Inherited From String
Interface Functions Inherited From AssignableConcept
Interface Functions Inherited From ContainerConcept
directionIteratorbeginendlengthemptyswapwriteValuewritegetObjectIdmoveValueappendappendValueshrinkToFit
Interface Functions Inherited From RandomAccessContainerConcept
Interface Functions Inherited From SegmentableConcept
Interface Functions Inherited From StringConcept
iterappendappendValuefrontbackresizecleareraseeraseFronteraseBackcapacitycomputeGenerousCapacityinsertinsertValuereplace
Interface Functions Inherited From TextConcept
Interface Metafunction Overview
-
Host<TJournaledString>::Type;The host type. -
InsertionBuffer<TJournaledString>::Type;Return type of insertion buffer string for a journaled string. -
JournalType<TJournaledString>::Type;Query a JournaledString for its journal type.
Interface Metafunctions Inherited From ContainerConcept
DefaultGetIteratorSpecDefaultIteratorSpecDifferenceDirectionIteratorGetValueIteratorPositionReferenceSizeValue
Interface Metafunctions Inherited From SegmentableConcept
Interface Metafunctions Inherited From TextConcept
Interface Functions Detail
void clear(js);
Remove all changes from the journal, resetting the JournaledString to its state after construction.
Parameters
js
|
The JournaledString to clear. |
|---|
Data Races
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
void flatten(js);
Apply the journal to the underlying string, modifying the underlying string.
Parameters
js
|
The JournaledString to flatten. |
|---|
Data Races
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
THost host(js);
Return the host of a JournaledString.
Parameters
js
|
The JournaledString to query. |
|---|
Returns
THost |
Reference to the host of js. |
|---|
Data Races
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
TPos hostToVirtualPosition(js, pos);
Translates host position to virtual position.
Parameters
js
|
The JournaledString to translate the position for. |
|---|---|
pos
|
The host position to translate. |
Returns
TPos |
The virtual view position. Note the returned position equates to length of the journaled string if pos is greater or equal the length of the underlying host. |
|---|
Data Races
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
bool isFlat(js);
Returns whether a JournaledString has modifications.
Parameters
js
|
The JournaledString to query. |
|---|
Returns
bool |
Indicates whether the string has been modified. |
|---|
Data Races
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
void setHost(js, str);
Set the host of a JournaledString.
Parameters
js
|
The JournaledString to set the host for. |
|---|---|
str
|
The string to set as the host. |
Data Races
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
TPos virtualToHostPosition(js, pos);
Translates virtual (view) position to position in host.
Parameters
js
|
The JournaledString to translate the position for. |
|---|---|
pos
|
The virtual position to translate. |
Returns
TPos |
Position in the host. |
|---|
Data Races
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.