PrefixSegment

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

Segment

Metafunctions

DefaultOverflowExplicit	The default overflow strategy for explicit resize. (Segment)
DefaultOverflowImplicit	The default overflow strategy for implicit resize. (Segment)
GetValue	Type for reading values. (Segment)
Host	Type of the object a given object depends on. (Segment)
IsContiguous	Determines whether a container stores its elements in a contiguous array. (Segment)
IsSequence	Determines whether a container stores its elements in sequential order. (Segment)
Iterator	Type of iterator objects that are used to traverse the container. (Segment)
Size	Type of an object that is suitable to hold size information. (Segment)
Spec	The spec of a class. (Segment)
Value	Type of the items in the container. (Segment)

Member Functions

Segment

Constructor

Functions

append	Concatenate two containers. (Segment)
append	Concatenate two containers. (Segment)
assign	Assigns one object to another object. (Segment)
assign	Assigns one object to another object. (Segment)
atBegin	Determines whether an iterator is at the beginning position. (Segment)
atEnd	Determines whether an iterator is at the end position. (Segment)
begin	The begin of a container. (Segment)
begin	The begin of a container. (Segment)
beginPosition	Begin position of object in host. (Segment)
capacity	The maximal length. (Segment)
clear	Resets an object. (Segment)
complement	Complement a sequence or a StringSet in-place. (Segment)
endPosition	End position of object in host. (Segment)
goBegin	Iterates to the first position of a container. (Segment)
goDown	Iterates down one edge or a path in a tree. (Segment)
goEnd	Iterates to the last position of a container. (Segment)
goNext	Iterates to next position. (Segment)
goPrevious	Iterates to pevious position. (Segment)
host	The object a given object depends on. (Segment)
id	A value that identifies the underlying sequence. (Segment)
length	The number of items/characters. (Segment)
replace	Replaces a part of a container with another container. (Segment)
replace	Replaces a part of a container with another container. (Segment)
resize	Resizes a container. If the new length exceeds the old length the new elements are filled with copies of value. (Segment)
reverseComplement	Reverse and complement a sequence or a StringSet in-place. (Segment)
setEnd	Sets end of object in host.
setEndPosition	Sets begin position of object in host.
setHost	Sets the host of an object. (Segment)
shareResources	Determines whether two sequences share the same resource. (Segment)
sourceSegment	The used part of the source. (Segment)
toLower	Convert characters in sequence or StringSet to lower case in-place. (Segment)
toUpper	Convert characters in sequence or StringSet to lower case in-place. (Segment)
value	Reference to the value. (Segment)