Class Specialization
InfixSegment
An arbitrary segment.
Segment
InfixSegment
Segment<THost, InfixSegment>
Parameters
THost
Type of the whole sequence.
Instances of Segment<THost, InfixSegment> are infixes of THost objects.
Remarks: Use Host to get the host type for a given class.
Specialization of
Metafunctions
DefaultOverflowExplicitThe default overflow strategy for explicit resize. (Segment)
DefaultOverflowImplicitThe default overflow strategy for implicit resize. (Segment)
GetValueType for reading values. (Segment)
HostType of the object a given object depends on. (Segment)
IsContiguousDetermines whether a container stores its elements in a contiguous array. (Segment)
IsSequenceDetermines whether a container stores its elements in sequential order. (Segment)
IteratorType of iterator objects that are used to traverse the container. (Segment)
SizeType of an object that is suitable to hold size information. (Segment)
SpecThe spec of a class. (Segment)
ValueType of the items in the container. (Segment)
Member Functions
SegmentConstructor
Functions
appendConcatenate two containers. (Segment)
assignAssigns one object to another object. (Segment)
atBeginDetermines whether an iterator is at the beginning position. (Segment)
atEndDetermines whether an iterator is at the end position. (Segment)
beginThe begin of a container. (Segment)
beginPositionBegin position of object in host. (Segment)
capacityThe maximal length. (Segment)
clearResets an object. (Segment)
endPositionEnd position of object in host. (Segment)
goBeginIterates to the first position of a container. (Segment)
goDownIterates down one edge or a path in a tree. (Segment)
goEndIterates to the last position of a container. (Segment)
goNextIterates to next position. (Segment)
goPreviousIterates to pevious position. (Segment)
hostThe object a given object depends on. (Segment)
idA value that identifies the underlying sequence. (Segment)
lengthThe number of items/characters. (Segment)
replaceReplaces a part of a container with another container. (Segment)
resizeChanges the length. (Segment)
setBeginSets begin of object in host.
setBeginPositionSets begin position of object in host.
setEndSets end of object in host.
setEndPositionSets begin position of object in host.
setHostSets the host of an object. (Segment)
shareResourcesDetermines whether two sequences share the same resource. (Segment)
sourceSegmentThe used part of the source. (Segment)
valueReference to the value. (Segment)
Remarks
Note: Since the appropriate segment type depends on the host sequence type, it is recommended to use the metafunction Infix instead of explicitely choose a specialization of Segment.
SeqAn - Sequence Analysis Library - www.seqan.de