Class Specialization
SuffixSegment
End part segment of a sequence.

Segment

SuffixSegment

Segment<THost, SuffixSegment>
Include Headers
seqan/sequence.h
Parameters

THost | Type of the whole sequence. Instances of Segment<THost, SuffixSegment> are suffixes 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 Suffix 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)
IsLightWeight | Determines whether an object can efficiently be passed by copy. (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)
Reference | Reference type. (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 or behind an iterator. (Segment)

Member Functions

Segment | Constructor

Functions

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)
beginPosition | Begin position of object in host. (Segment)
capacity | The maximal length. (Segment)
complement | Complement a sequence or a StringSet in-place. (Segment)
empty | Test a container for being empty. (Segment)
endPosition | End position of object in host. (Segment)
getObjectId | A value that identifies the underlying sequence. (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)
length | The number of items/characters. (Segment)
reverseComplement | Reverse and complement a sequence or a StringSet in-place. (Segment)
setBegin | Sets begin of object in host.
setBeginPosition | 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)
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)

Examples
File "suffix.cpp"

1 | #include <seqan/basic.h>
2 | #include <seqan/sequence.h>
3 | #include <seqan/file.h> // for I/O
4 |
5 |
6 | using namespace seqan;
7 |
8 | int main()
9 | {
10 | String<Dna> dnaSeq = "TATACGCGAAAA";
11 | Infix<String<Dna> >::Type suf = suffix(dnaSeq, 8);
12 | std::cout << "Suffix: " << suf << std::endl;
13 |
14 | return 0;
15 | }

The output is as follows:
Suffix: AAAA
See Also
PrefixSegment, InfixSegment, Suffix
SeqAn - Sequence Analysis Library - www.seqan.de

Page built @2014/10/13 16:13:00