Metafunctions
Metafunctions - also known as "traits" or "trait classes" - return types, constants or functions for a set of given types or constants. They can be seen as part of a (meta-)program that is evaluated at compile time to produce a C++ program.
Read here an introduction to metafunctions and how to use them.
Metafunctions

AllowsFastRandomAccess | Determines whether a sequence efficiently supports random access.
Alphabet | Access to the Alphabet type.
BitsPerValue | Number of bits needed to store a value.
BytesPerValue | Number of bytes needed to store a value.
Cargo | Type of additional data stored in an object.
Col | Type of a column in an alignment.
Cols | Type of column container of an alignment.
Comparator | Type of comparator object
CompareType | Type to convert other types for comparisons.
Container | Type of the container given an iterator.
Convert | Return type of a conversion.
DeepestSpec | The deepest spec of a class with nested template arguments.
DefaultFindBeginPatternSpec | Type of the default findBegin pattern specialization, given a score.
Difference | Type of an object that stores the difference between two iterators.
EdgeDescriptor | Type of an object that represents an edge descriptor.
EdgeIdHandler | Type of an object that represents an Id Manager.
EdgeType | Edge type of a graph object.
GappedValueType | Returns a value type that contains a blank value '-'.
GetSource | The type returned by the source function.
GetValue | Type for reading values.
Hit | Blast Hit type of a Blast object.
Host | Type of the object a given object depends on.
Hsp | Blast HSP type of a Blast object.
Id | Type of an object that represents an id.
Infix | Infix sequence type.
InsertionBuffer | Return type of insertion buffer string for a journaled string.
IntegralForValue | Returns an itegral type that provides sufficient space to store a value.
IsContiguous | Determines whether a container stores its elements in a contiguous array.
IsIntegral | Tests for a type to be of integral value.
IsSequence | Determines whether a container stores its elements in sequential order.
IsSimple | Tests type to be simple.
Iterator | Type of iterator objects that are used to traverse the container.
JournalType | Metafunction for returning the type of the journal of a Journaled String.
Key | Key type of a key to cargo mapping.
LENGTH | Number of elements in a fixed-size container.
Motif | The string type of the finder.
PexMultiFinder | Determines the multiple exact string matching algorithm used by the Pex algorithm.
Position | Type of an object that represents a position in a container.
Prefix | Prefix sequence type.
Reference | Reference type.
Row | Type of a row in an alignment.
Rows | Type of row container of an alignment.
Size | Type of an object that is suitable to hold size information.
Source | The underlying sequence for alignments or gaps data structures.
Spec | The spec of a class.
StdContainerIterator | Returns type of the STL container iterator.
StringSetType | Return type of stringSet function.
Suffix | Suffix sequence type.
Value | Type of the items in the container.
ValueSize | Number of different values a value type object can have.
VertexDescriptor | Type of an object that represents a vertex descriptor.
VertexIdHandler | Type of an object that represents an Id Manager.
WEIGHT | Number of relevant positions in a shape.
Weight | Type of the weight of an item.

Basic

IterComplementConst | Complement the "constness" of the container of an iterator.
IterMakeConst | Make the container of an Iter const.

Index

DefaultIndexCreator | Default algorithm to create a demanded and not yet existing Fibre.
DefaultIndexSpec | Default Index specialization type.
DefaultIndexStringSpec | Default String specialization type of the Fibre of an Index.
Fibre | Type of a specific index member (fibre).
GetVSTreeIteratorTraits | Default behaviour of goNext when no second parameter is given.
SAValue | The default alphabet type of a suffix array, i.e. the type to store a position of a string or string set.

Map

MapValue | Type of the map value type.

Miscellaneous

ListType | Type of lists in tree nodes.
MaxValue | Supremum for a given type.
MinValue | Infimum for a given type.

Searching

DefaultFinder | Default Finder specialization type.
DefaultPattern | Default Pattern specialization type.
Haystack | Returns the haystack type of a Finder type.
Needle | Returns the needle type of a Pattern type.
ScoringScheme | Returns the scoring scheme of an approximate searching algorithm.

Sequences

Concatenator | Returns the type of the concatenation sequence of all sequences in a StringSet.

SeqAn - Sequence Analysis Library - www.seqan.de

Page built @2012/03/14 16:34:44