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.
Aggregates
MakePackedReturn the corresponding packed type of a type.
Alignments
ColType of a column in an alignment.
ColsType of column container of an alignment.
GappedValueTypeReturns a value type that contains a blank value '-'.
RowType of a row in an alignment.
RowsType of row container of an alignment.
SequenceEntryForScore (Score)Returns representation type for a character of a position in a sequence.
SourceReturn underlying sequence of Gaps/Alignments.
SourceReturn underlying sequence of Gaps/Alignments.
StringSetTypeReturn type of stringSet function.
Alphabets
ConvertReturn type of a conversion.
HasQualitiesReturn whether the given type stores qualities besides the alphabet.
IsCharTypeReturn whether the argument is char, wchar_t, char const, or wchar_t const.
QualityValueSizeReturn the number of quality values in characters from alphabet with qualities.
SourceValueReturns underlying value for ProfileChar.
Basic
BitsPerValueNumber of bits needed to store a value.
BytesPerValueNumber of bytes needed to store a value.
CargoType of additional data stored in an object.
ComparatorType of comparator object
CompareTypeType to convert other types for comparisons.
CompareTypeImplImplementation of CompareType.
FindA metafunction to retrieve the index of a tag in the TagList.
FindA metafunction to retrieve the index of a tag in the TagList.
HostType of the object a given object depends on.
IntegralForValueReturns an itegral type that provides sufficient space to store a value.
IsIntegerTests for a type to be of integral aue.
IsIntegralTests for a type to be of integral aue.
IsSignedIntegerTests for a type to be of signed integral aue.
IsSimpleTests type to be simple.
IsUnsignedIntegerTests for a type to be of unsigned integral aue.
IterComplementConstComplement the "constness" of the container of an iterator.
IterMakeConstMake the container of an Iter const.
LENGTHNumber of elements in a fixed-size container.
MakeSignedConverts an integral value into a signed integral value.
MakeUnsignedConverts an integral value into an unsigned integral value.
PointerReturns pointer to an object, required for operator->, for example.
RemoveConstConverts a (const) type into the corresponding non-const type.
RemoveReferenceConverts a (reference) type into the same type without reference.
TagListValueA metafunction to retrieve a tag from a TagList.
TagListValueA metafunction to retrieve a tag from a TagList.
ValueSizeNumber of different values a value type object can have.
Concepts
IsReturns whether a concept is fulfilled.
Content Manipulation
HasMoveConstructorQuery whether a class has a move constructor.
Fundamental
DeepestSpecThe deepest spec of a class with nested template arguments.
DifferenceType of an object that stores the difference between two iterators.
GetValueType for reading values.
PositionType of an object that represents a position in a container.
ReferenceReference type.
SizeType of an object that is suitable to hold size information.
SpecThe spec of a class.
ValueType of the items in the container or behind an iterator.
Graph
AlphabetAccess to the Alphabet type.
CargoType of additional data stored in an object.
EdgeDescriptorType of an object that represents an edge descriptor.
EdgeIdHandlerType of an object that represents an Id Manager.
EdgeTypeEdge type of a graph object.
IdType of an object that represents an id.
KeyKey type of a key to cargo mapping.
VertexDescriptorType of an object that represents a vertex descriptor.
VertexIdHandlerType of an object that represents an Id Manager.
Index
DefaultIndexCreatorDefault algorithm to create a demanded and not yet existing Fibre.
DefaultIndexSpecDefault Index specialization type.
DefaultIndexStringSpecDefault String specialization type of the Fibre of an Index.
FibreType of a specific container member (fibre).
GetVSTreeIteratorTraitsDefault behaviour of goNext when no second parameter is given.
SAValueThe default alphabet type of a suffix array, i.e. the type to store a position of a string or string set.
WEIGHTNumber of relevant positions in a shape.
Input/Output
HasStreamFeatureQuery features of a stream type.
Position (RecordReader)Returns the position type to use in position and setPosition.
Iteration
ContainerType of the container given an iterator.
IteratorType of iterator objects that are used to traverse the container.
Map
MapValueType of the map value type.
Metaprogramming
AndMetaprogramming "and" operator.
AndCMetaprogramming boolean "and" operatand, value variant.
EvalConvert from bool values to types (True and False).
IfMetaprogramming "if".
IfCMetaprogramming "if", value based version.
IsSameTypeMetaprogramming type comparison.
Log2Compute ceiled logarithm to base 2 using metaprogramming.
Log2FloorCompute floored logarithm to base 2 using metaprogramming.
LoopMetafunction returning a function that iterates over a static integer range.
LoopReverseMetafunction returning a function that iterates over a static integer range in reverse order.
NotMetaprogramming boolean "not" operator.
NotCMetaprogramming boolean "not" operator, value variant.
OrMetaprogramming boolean "or" operator.
OrCMetaprogramming boolean "or" operator, value variant.
PowerCompute power of a number.
SwitchMetaprogramming switch expression.
Miscellaneous
ListTypeType of lists in tree nodes.
MaxValueSupremum for a given type.
MinValueInfimum for a given type.
ResultReturn the result of a computation.
Motif Search
MotifThe string type of the finder.
Random
GetDefaultRngReturn the default Random Number Generator to use in a given class, spezialiation or algorithm.
Searching
DefaultFindBeginPatternSpecType of the default findBegin pattern specialization, given a score.
DefaultFinderDefault Finder specialization type.
DefaultPatternDefault Pattern specialization type.
HaystackReturns the haystack type of a Finder type.
NeedleReturns the needle type of a Pattern type.
PexMultiFinderDetermines the multiple exact string matching algorithm used by the Pex algorithm.
ScoringSchemeReturns the scoring scheme of an approximate searching algorithm.
Seed Handling
Diagonal (Seed)Returns type of the value for the diagonal of a seed.
Iterator (Chained Seed)The seed diagonal iterator type.
Position (Seed)The position type of a Seed.
Position (SeedDiagonal)The position type of a SeedDiagonal.
Reference (Chained Seed)The seed diagonal reference type.
SeedScore (Seed)Returns type of the value for the score of a seed.
Size (Seed)The size type of a Seed.
Size (SeedDiagonal)The position type of a SeedDiagonal.
Value (Chained Seed)The seed diagonal type.
Segments
InfixInfix sequence type.
PrefixPrefix sequence type.
SuffixSuffix sequence type.
Sequences
AllowsFastRandomAccessDetermines whether a sequence efficiently supports random access.
ConcatenatorReturns the type of the concatenation sequence of all sequences in a StringSet.
InsertionBufferReturn type of insertion buffer string for a journaled string.
IsContiguousDetermines whether a container stores its elements in a contiguous array.
IsSequenceDetermines whether a container stores its elements in sequential order.
JournalTypeMetafunction for returning the type of the journal of a Journaled String.
StdContainerIteratorReturns type of the STL container iterator.
SeqAn - Sequence Analysis Library - www.seqan.de
 

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