Concept SegmentableConcept
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;

Member Function Overview

Member Functions Inherited From AssignableConcept

Interface Function Overview

Interface Functions Inherited From AssignableConcept

Interface Functions Inherited From ContainerConcept

Interface Metafunction Overview

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

Thread safety unknown!

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

Thread safety unknown!

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

Thread safety unknown!

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

Thread safety unknown!

Interface Metafunctions Detail

Infix<TSeq>::Type

Returns infix type in a flattening fashion.

Template Parameters

TSeq The segmentable sequence type to get infix type for.

Returns

Type The infix type.

The infix any segment is an infix.

Prefix<TSeq>::Type

Return prefix type in a flattening fashion.

Template Parameters

TSeq The segmentable sequence type to get prefix type for.

Returns

Type The prefix type.

The prefix type of a prefix is a suffix, the prefix of any other segment type is an infix.

Suffix<TSeq>::Type

Returns suffix type in a flattening fashion.

Template Parameters

TSeq The segmentable sequence type to get suffix type for.

Returns

Type The suffix type.

The suffix type of a suffix is a suffix, the suffix of any other segment type is an infix.