Concept StringConceptSequences are dense linear containers that have positions.
Sequences are dense linear containers that have positions.
| Extends | RandomAccessContainerConcept |
|---|---|
| All Extended | AssignableConcept, ContainerConcept, DestructibleConcept, ForwardContainerConcept, RandomAccessContainerConcept, ReversibleContainerConcept |
| Defined in | <seqan/basic.h> |
| Signature |
StringConcept<T>
|
Member Function Overview
Member Functions Inherited From AssignableConcept
Member Functions Inherited From RandomAccessContainerConcept
Interface Function Overview
-
void append(seq, other);Append a sequence to another one. -
void appendValue(seq, val);Append a value to a sequence. -
TReference back(seq);Return reference to the last element. -
TSize capacity(seq);Returns the capacity of a sequence. -
void clear(seq);Remove all elements from the sequences. -
TSize computeGenerousCapacity(seq, capacity);Capacity for generous expansion. -
void erase(seq, pos[, posEnd)Erase an element or a range of elements from a sequence. -
void eraseBack(seq);Erase last element in a sequence. -
void eraseFront(seq);Erase first element in a sequence. -
TReference front(seq);Return reference to the first element. -
void insert(seq, pos, src[, tag]);Inserts a sequence into another sequence. -
void insertValue(seq, pos, val[, tag]);Inserts an element into a sequence. -
TIterator iter(seq, pos[, tag]);Iterator to the item at the given position in a container. -
void replace(target, posBegin, posEnd, source[, limit][, resizeTag]);Replaces a part of a sequence with another sequence. -
void resize(seq, len[, val]);Resize a sequence.
Interface Functions Inherited From AssignableConcept
Interface Functions Inherited From ContainerConcept
appendappendValuebegindirectionIteratoremptyendgetObjectIdlengthmoveValueshrinkToFitswapwritewriteValue
Interface Functions Inherited From RandomAccessContainerConcept
Interface Metafunction Overview
Interface Metafunctions Inherited From ContainerConcept
Interface Functions Detail
void append(seq, other);
Append a sequence to another one.
Parameters
seq
|
The sequence to append the other sequence to. |
|---|---|
other
|
The other sequence to append to seq. Of same type as seq. |
Data Races
Thread safety unknown!
void appendValue(seq, val);
Append a value to a sequence.
Parameters
seq
|
The sequence to append a value to (type TSequence). |
|---|---|
val
|
A value to append to the sequence. Convertible to Value<TSequence>::Type. |
Data Races
Thread safety unknown!
TReference back(seq);
Return reference to the last element.
Parameters
seq
|
The sequence to get the last element of. |
|---|
Returns
TReference |
A reference to the last element of seq. |
|---|
Data Races
Thread safety unknown!
TSize capacity(seq);
Returns the capacity of a sequence.
Parameters
seq
|
The sequence to query for its capacity. |
|---|
Returns
TSize |
Returns the capacity of the sequence. TSize is the result of Size<TSequence>::type where TSequence is the type of seq. |
|---|
The size of a sequence can never exceed its capacity but some container support resizing of the capacity. Some functions do that implicitely if they are called with a suitable tag. The function reserve can be used to change the capacity explicitely.
Data Races
Thread safety unknown!
void clear(seq);
Remove all elements from the sequences.
Parameters
seq
|
Sequence to clear. |
|---|
Data Races
Thread safety unknown!
TSize computeGenerousCapacity(seq, capacity);
Capacity for generous expansion.
Parameters
seq
|
The sequence to compute the generous capacity for. |
|---|---|
capacity
|
The minimal required capacity. |
Returns
TSize |
A value larger than capacity that should be used as the new capacity for container when it is expanded using the Generous overflow strategy. |
|---|
Data Races
Thread safety unknown!
void erase(seq, pos[, posEnd)
Erase an element or a range of elements from a sequence.
Parameters
seq
|
Sequence to remove range from. |
|---|---|
pos
|
Begin position of the range to remove. |
posEnd
|
Optional end position of the range to remove. If omitted, pos + 1 is used. |
Data Races
Thread safety unknown!
void eraseBack(seq);
Erase last element in a sequence.
Parameters
seq
|
The sequence to remove the last element from. |
|---|
Data Races
Thread safety unknown!
void eraseFront(seq);
Erase first element in a sequence.
Parameters
seq
|
The sequence to remove the first element from. |
|---|
Data Races
Thread safety unknown!
TReference front(seq);
Return reference to the first element.
Parameters
seq
|
The sequence to get the first element of. |
|---|
Returns
TReference |
A reference to the first element of seq. |
|---|
Data Races
Thread safety unknown!
void insert(seq, pos, src[, tag]);
Inserts a sequence into another sequence.
Parameters
seq
|
The sequence to insert element sinto. |
|---|---|
pos
|
The position to start inserting at. |
src
|
The sequence to insert at pos. |
tag
|
The resize tag, defaults to what OverflowStrategyImplicit returns. |
Data Races
Thread safety unknown!
void insertValue(seq, pos, val[, tag]);
Inserts an element into a sequence.
Parameters
seq
|
The sequence to insert element into. |
|---|---|
pos
|
The position to insert at. |
val
|
The value to insert at pos into seq. |
tag
|
The resize tag, defaults to what OverflowStrategyImplicit returns. |
Data Races
Thread safety unknown!
TIterator iter(seq, pos[, tag]);
Iterator to the item at the given position in a container.
Parameters
seq
|
The sequence to get the iterator for. |
|---|---|
pos
|
The position to get the iterator for. |
tag
|
The tag to pick the type of the iterator. |
Returns
TIterator |
The resulting iterator. If TTag is the type of tag and TSequence the type of seq then TIterator is of the type Iterator<TSequence, TTag>::Type. |
|---|
Remarks
If pos is out of range then the iterator is invalid.
Data Races
Thread safety unknown!
void replace(target, posBegin, posEnd, source[, limit][, resizeTag]);
Replaces a part of a sequence with another sequence.
Parameters
target
|
The sequence to modify. |
|---|---|
posBegin
|
The begin position of the range to replace. |
posEnd
|
The end position of the range to replace. |
source
|
The source sequence to replace [posBegin, posEnd) with. |
limit
|
Largest size of target after the operation. |
resizeTag
|
Specify the resizing behaviour. Defaults to what DefaultOverflowImplicit returns. |
Data Races
Thread safety unknown!
void resize(seq, len[, val]);
Resize a sequence.
Parameters
seq
|
Sequence to resize. |
|---|---|
len
|
Length to resize seq to. |
val
|
When increasing the size, val is used to fill new entries. When omitted, TValue() is used where TValue is the Value type of the sequence. |
Data Races
Thread safety unknown!