Class Specialization
PrefixSegment
First part of a sequence.
Segment
PrefixSegment
Segment<THost, PrefixSegment>
Include Headers
seqan/sequence.h
Parameters
THost
Type of the whole sequence.
Instances of Segment<THost, PrefixSegment> are prefixes of THost objects.
Remarks: Use Host to get the host type for a given class.
Remarks
Note: Since the appropriate segment type depends on the host sequence type, it is recommended to use the metafunction Prefix instead of explicitely choose a specialization of Segment.
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)
ReferenceReference type. (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 or behind an iterator. (Segment)
Member Functions
SegmentConstructor
Functions
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)
complementComplement a sequence or a StringSet in-place. (Segment)
emptyTest a container for being empty. (Segment)
endPositionEnd position of object in host. (Segment)
getObjectIdA value that identifies the underlying sequence. (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)
lengthThe number of items/characters. (Segment)
reverseComplementReverse and complement a sequence or a StringSet in-place. (Segment)
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)
toLowerConvert characters in sequence or StringSet to lower case in-place. (Segment)
toUpperConvert characters in sequence or StringSet to lower case in-place. (Segment)
valueReference to the value. (Segment)
SeqAn - Sequence Analysis Library - www.seqan.de
 

Page built @2013/07/11 09:12:19