Class
SimpleType
Implementation for "simple" types.

Simple Type

SimpleType

AminoAcid | Dna | Dna5 | Dna5Q | DnaQ | Finite
Iupac | Rna | Rna5 | TraceBack

SimpleType<TValue, TSpec>
Include Headers
seqan/basic.h
Parameters

TValue | Type that stores the values of an instance. Metafunctions: Value Remarks: TValue must be a simple type.
TSpec | Specialization tag. Metafunctions: Spec

Remarks
A "simple type" is a C++ type that can be constructed without constructor, destructed without destructor and copied without copy constructor or assignment operator. All basic types (like char, int or float) are simple. Pointers, references and arrays of simple types are simple. POD types ("plain old data types"), that are - simplified spoken - C++-types that already existed in C, are simple too.
Arrays of simple types can be copied very fast by memory manipulation routines, but the default implementation of functions like arrayCopyForward and arrayCopy are not optimized for simple types this way. But for classes derived from SimpleType, optimized variants of array manipulation functions are applied.
Note that simple types need not to be derived or specialized from SimpleType, but it could be convenient to do so.
Implements
Simple Type
Specializations

AminoAcid | Iupac code for amino acids.
Dna | Alphabet for DNA.
Dna5 | Alphabet for DNA including 'N' character.
Dna5Q | Alphabet for DNA plus phred quality including 'N' character.
DnaQ | Alphabet for DNA plus phred quality.
Finite | A finite alphabet of a fixed size.
Iupac | Iupac code for DNA.
Rna | Alphabet for RNA.
Rna5 | Alphabet for RNA including 'N' character.
TraceBack | Trace back values.

Metafunctions

IsSimple | Tests type to be simple.
Spec | The spec of a class.
Value | Type of the items in the container.

Functions

assign | Assigns one object to another object.
assign | Assigns one object to another object.
ordValue | Maps an alphabet 1-to-1 to the interval [0..ValueSize).

See Also
arrayConstruct, Simple Type, arrayCopyBackward, arrayCopyForward, arrayMove, IsSimple, arrayClearSpace, arrayMoveBackward, arrayDestruct, arrayMoveForward, arrayCopy
SeqAn - Sequence Analysis Library - www.seqan.de

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