Class ExecutionPolicy

Policy to select runtime execution mode for algorithms.

/*!
 * @class ExecutionPolicy
 * 
 * @headerfile <seqan/parallel.h>
 * 
 * @brief Policy to select runtime execution mode for algorithms.
 * 
 * @signature template<typename TThreadingMode, typename TVectorizationMode>
 *            struct ExecutionPolicy;
 * 
 * @tparam TThreadingMode Type specifying the threading model. Can be @link
 *                        ParallelismTags#Parallel @endlink or @link
 *                        ParallelismTags#Serial @endlink (default).
 * @tparam TVectorizationMode Type specifying the vectorization model. Can be
 *                            @link ParallelismTags#Vectorial @endlink or @link
 *                            ParallelismTags#Serial @endlink (default).
 * 
 * The <tt>ExecutionPolicy</tt> class is used to select different execution
 * models for certain algorithms. Depending on the specialization of the
 * template parameters 4 different modes are possible: sequential, parallel,
 * vectorized and parallel+vectorized. The number of threads for the parallel
 * execution modes can be configured via a member variable.
 * 
 * @mfn ExecutionPolicy#IsVectorized
 * 
 * @headerfile <seqan/parallel.h>
 * 
 * @brief Evaluates to @link LogicalValuesTags#True @endlink if the execution
 *        policy is specialized with @link ParallelismTags#Vectorial @endlink.
 * 
 * @signature IsVectorized<TExecPolicy>::VALUE
 * 
 * @tparam TTExecPolicy The @link ExecutionPolicy @endlink to check.
 * 
 * @return bool <tt>true</tt> if @link ExecutionPolicy @endlink is @link
 *              ParallelismTags#Vectorial @endlink, otherwise <tt>false</tt>.
 * 
 * @mfn ExecutionPolicy#IsParallel
 * 
 * @headerfile <seqan/parallel.h>
 * 
 * @brief Evaluates to @link LogicalValuesTags#True @endlink if the execution
 *        policy is specialized with @link ParallelismTags#Parallel @endlink.
 * 
 * @signature IsParallel<TExecPolicy>::VALUE
 * 
 * @tparam TTExecPolicy The @link ExecutionPolicy @endlink to check.
 * 
 * @return bool <tt>true</tt> if @link ExecutionPolicy @endlink is @link
 *              ParallelismTags#Parallel @endlink, otherwise <tt>false</tt>.
 * 
 * @mfn ExecutionPolicy#IsExecutionPolicy
 * 
 * @headerfile <seqan/parallel.h>
 * 
 * @brief Checks if a given type is an @link ExecutionPolicy @endlink.
 * 
 * @signature IsExecutionPolicy<T>::VALUE
 * 
 * @tparam T The type to check.
 * 
 * @return bool <tt>true</tt> if the <tt>T</tt> is an @link ExecutionPolicy
 *              @endlink type, otherwise <tt>false</tt>.
 * 
 * @var size_t ExecutionPolicy::numThreads;
 * 
 * @brief The number of threads to use for the parallel execution. Defaults to
 *        1.
 * 
 * @fn ExecutionPolicy#numThreads
 * 
 * @headerfile <seqan/parallel.h>
 * 
 * @brief Getter function for the thread number.
 * 
 * @signature auto numThreads(exec);
 * 
 * @param[in] exec The @link ExecutionPolicy @endlink to get the number of
 *                 threads for.
 * 
 * @return auto The number of threads.
 * 
 * @fn ExecutionPolicy#setNumThreads
 * 
 * @headerfile <seqan/parallel.h>
 * 
 * @brief Setter function for the thread number.
 * 
 * @signature void setNumThreads(exec, n);
 * 
 * @param[in,out] exec The @link ExecutionPolicy @endlink to set the number of
 *                     threads for.
 * @param[in] n The number of threads used for the parallel execution.
 */