Macros
Assertions

SEQAN_ASSERT | Test that the given expression can be coerced to true.
SEQAN_ASSERT_EQ | Test that two given expressions are equal, as defined by the matching call to the operator=(,).
SEQAN_ASSERT_GEQ | Test that the two given expressions are in the greater-than-or-equal relation as defined by the matching call to operator>=(,).
SEQAN_ASSERT_GT | Test that the two given expressions are in the greather-than relation as defined by the matching call to operator>(,).
SEQAN_ASSERT_IN_DELTA | Test that the given expression can be coerced to true.
SEQAN_ASSERT_LEQ | Test that the two given expressions are in the less-than-or-equal relation as defined by the matching call to operator<=(,).
SEQAN_ASSERT_LT | Test that the two given expressions are in the less-than relation as defined by the matching call to operator<(,).
SEQAN_ASSERT_NEQ | Test that two given expressions are not equal, as defined by the matching call to the operator!=(,).
SEQAN_ASSERT_NOT | Test that the given expression can be coerced to false.
SEQAN_CHECK | Force abortion of program if a condition is not met, regardless of debugging settings.
SEQAN_FAIL | Force abortion of program, regardless of debugging settings.

Concepts

SEQAN_CONCEPT | Defines a new concept.
SEQAN_CONCEPT_ASSERT | Perform a concept check.
SEQAN_CONCEPT_IMPL | Defines which concepts a model fulfills.
SEQAN_CONCEPT_REFINE | Defines a new concept as a refinement of existing concepts.
SEQAN_CONCEPT_USAGE | Define valid expressions.
SEQAN_CTOR_DISABLE_IF | Bind the visibility of a constructor to an expression.
SEQAN_CTOR_ENABLE_IF | Bind the visibility of a constructor to an expression.
SEQAN_FUNC_DISABLE_IF | Bind the visibility of a function to an expression.
SEQAN_FUNC_ENABLE_IF | Bind the visibility of a function to an expression.

From Outside

SEQAN_HAS_BZIP2 | If set to 1 then bzlib2 is available, i.e. including <bzlib.h> and linking against libbzip2 works.
SEQAN_HAS_ZLIB | If set to 1 then zlib is available, i.e. including <zlib.h> and linking against libz works.

Input/Output

SEQAN_HAS_BZIP2 | If set to 1 then bzlib2 is available, i.e. including <bzlib.h> and linking against libbzip2 works.
SEQAN_HAS_ZLIB | If set to 1 then zlib is available, i.e. including <zlib.h> and linking against libz works.

Parallelism

SEQAN_ENABLE_PARALLELISM | Indicates whether parallelism is enabled with value 0/1.
SEQAN_OMP_PRAGMA | Portable conditional #pragma issuing if OpenMP is enabled.

Testing & Debugging

SEQAN_BEGIN_TESTSUITE | Expand to a test suite beginning.
SEQAN_CALL_TEST | Expand to calling a test.
SEQAN_CHECKPOINT | Generate a check point.
SEQAN_DEFINE_TEST | Expand to test definition.
SEQAN_ENABLE_CHECKPOINTS | Indicates whether checkpoints are enabled.
SEQAN_ENABLE_DEBUG | Indicates whether debugging is enabled.
SEQAN_ENABLE_TESTING | Indicates whether testing is enabled.
SEQAN_END_TESTSUITE | Expand to a test suite ending.
SEQAN_PATH_TO_ROOT | Return path to the checkout root directory (i.e. containing core/extras).
SEQAN_SKIP_TEST | Force the test to return without failing and mark it as skipped.
SEQAN_TEMP_FILENAME | Generates the name to a temporary file.
SEQAN_TYPEDEF_FOR_DEBUG | When using typedefs that are only used in debug mode then they have to be marked with macro.
SEQAN_VERIFY_CHECKPOINTS | Verify check points for the given file name.

Versioning

SEQAN_VERSION_MAJOR | Major SeqAn revision number.
SEQAN_VERSION_MINOR | Minor SeqAn revision number.
SEQAN_VERSION_PATCH | SeqAn patch revision number.
SEQAN_VERSION_PRE_RELEASE | Flag (0/1) to indicate whether this is a pre-release (i.e. SVN version).

SeqAn - Sequence Analysis Library - www.seqan.de

Page built @2014/10/13 16:12:56