seqan3::align_cfg::result< with_type > Class Template Reference

Sets the result of the alignment computation. More...

#include <seqan3/alignment/configuration/align_config_result.hpp>

Inheritance diagram for seqan3::align_cfg::result< with_type >:

Public Attributes
with_type	value
	The stored config value.

Related Functions
(Note that these are not member functions.)
constexpr detail::with_alignment_type	with_alignment {}
	Helper Variable used to select trace computation. More...
constexpr detail::with_back_coordinate_type	with_back_coordinate {}
	Helper variable used to select end-position computation. More...
constexpr detail::with_front_coordinate_type	with_front_coordinate {}
	Helper variable used to select begin position computation. More...
constexpr detail::with_score_type	with_score {}
	Helper variable used to select score-only computation. More...
Type deduction guides
	result () -> result< detail::with_score_type >
	The default constructor defaults to score-only computation.
template<typename with_type >
	result (with_type) -> result< remove_cvref_t< with_type >>
	Deduces the alignment result from the given constructor argument.

Detailed Description

template<typename with_type = detail::with_score_type>
class seqan3::align_cfg::result< with_type >

Sets the result of the alignment computation.

Template Parameters

with_type

The type used to specify which feature should be computed during the pairwise alignment. Defaults to seqan3::detail::with_score_type.

The output of the pairwise alignment can be configured using the result configuration element. Depending on the settings, the most efficient implementation is chosen to compute the result. Currently four different modes can be configured: computing only the score, computing in addition the end position, computing in addition the begin position, and finally also computing the alignment. These settings will directly affect the contents of the seqan3::alignment_result object which is returned by the alignment algorithm.

Example

    using namespace seqan3;

    // Compute only the score.
    align_cfg::result cfg_score{with_score};

    // Compute the score and the back coordinate.
    align_cfg::result cfg_end{with_back_coordinate};

    // Compute the score, the back coordinate and the front coordinate.
    align_cfg::result cfg_begin{with_front_coordinate};

    // Compute the score, the back coordinate, the front coordinate and the alignment.
    align_cfg::result cfg_alignment{with_alignment};

Friends And Related Function Documentation

with_alignment

template<typename with_type = detail::with_score_type>

constexpr detail::with_alignment_type with_alignment {}

related

Helper Variable used to select trace computation.

with_back_coordinate

template<typename with_type = detail::with_score_type>

constexpr detail::with_back_coordinate_type with_back_coordinate {}

related

Helper variable used to select end-position computation.

with_front_coordinate

template<typename with_type = detail::with_score_type>

constexpr detail::with_front_coordinate_type with_front_coordinate {}

related

Helper variable used to select begin position computation.

with_score

template<typename with_type = detail::with_score_type>

constexpr detail::with_score_type with_score {}

related

Helper variable used to select score-only computation.

---

The documentation for this class was generated from the following file:

• seqan3/alignment/configuration/align_config_result.hpp