Concept SegmentableConceptA concept for containers that can be used as the host of a segment.
A concept for containers that can be used as the host of a segment.
| Extends | ContainerConcept |
|---|---|
| All Extended | AssignableConcept, ContainerConcept, DestructibleConcept |
| Defined in | <seqan/sequence.h> |
| Signature |
concept Segmentable;
|
Interface Function Overview
-
TInfix infix(s, beginPos, endPos);Returns the infix of a Segmentable type. -
TInfix infixWithLength(s, beginPos, len);Returns the infix of a Segmentable type. -
TPrefix prefix(s, endPos);Returns the prefix of a Segmentable type. -
TSuffix suffix(s, beginPos);Returns the suffix of a Segmentable type.
Interface Functions Inherited From AssignableConcept
Interface Functions Inherited From ContainerConcept
Interface Metafunction Overview
-
Infix<TSeq>::TypeReturns infix type in a flattening fashion. -
Prefix<TSeq>::TypeReturn prefix type in a flattening fashion. -
Suffix<TSeq>::TypeReturns suffix type in a flattening fashion.
Interface Metafunctions Inherited From ContainerConcept
Interface Functions Detail
TInfix infix(s, beginPos, endPos);
Returns the infix of a Segmentable type.
Parameters
s
|
Segmentable sequence to return the infix for (type TSeq). |
|---|---|
beginPos
|
Begin position must be convertible to Position<TSeq>::Type. |
endPos
|
End position must be convertible to Position<TSeq>::Type. |
Data Races
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
TInfix infixWithLength(s, beginPos, len);
Returns the infix of a Segmentable type.
Parameters
s
|
Segmentable sequence to return the infix for (type TSeq). |
|---|---|
beginPos
|
Begin position must be convertible to Position<TSeq>::Type. |
len
|
Length of the prefix, must be convertible to Size<TSeq>::Type. |
Equivalent to infix(s, beginPos, beginPos + len).
Data Races
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
TPrefix prefix(s, endPos);
Returns the prefix of a Segmentable type.
Parameters
s
|
Segmentable sequence to return the prefix for (type TSeq). |
|---|---|
endPos
|
End position must be convertible to Position<TSeq>::Type. |
Returns
TPrefix |
The prefix of length endPos. Type as returned by Prefix for TSeq. |
|---|
Data Races
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
TSuffix suffix(s, beginPos);
Returns the suffix of a Segmentable type.
Parameters
s
|
The segmentable type to get the suffix of. |
|---|---|
beginPos
|
Begin position must be convertible to Position<TSeq>::Type. |
Returns
TSuffix |
The suffix type as returned by Suffix. |
|---|
Data Races
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.