SeqAn3
seqan3::align_result< output_type_list_t > Struct Template Reference

Stores the alignment results and offers a tuple-like interface. More...

#include <seqan3/alignment/pairwise/align_result.hpp>

Inheritance diagram for seqan3::align_result< output_type_list_t >:
[legend]

Public Types

using base_type = detail::transfer_template_args_onto_t< output_type_list_t, std::tuple >
 The base tuple type.
 

Public Member Functions

Access functions

Convenience helper functions to access elements of the alignment result type.

constexpr std::tuple_element_t< 0, base_typeid () const noexcept
 Returns the id.
 
constexpr std::tuple_element_t< 1, base_typescore () const noexcept
 Returns the score.
 
decltype(auto) constexpr end_coordinate () const &noexcept
 Returns the end coordinate of the alignment if requested by the algorithm configuration, otherwise std::ignore.
 
decltype(auto) constexpr end_coordinate () const &&noexcept
 
decltype(auto) constexpr begin_coordinate () const &noexcept
 Returns the begin coordinate of the alignment if requested by the algorithm configuration, otherwise std::ignore.
 
decltype(auto) constexpr begin_coordinate () const &&noexcept
 
decltype(auto) constexpr trace () const &noexcept
 Returns the traceback of the alignment if requested by the algorithm configuration, otherwise std::ignore.
 
decltype(auto) constexpr trace () const &&noexcept
 

Related Functions

(Note that these are not member functions.)

Tuple-like get interface
template<align_result_key e, typename output_type_list_t >
constexpr auto & get (align_result< output_type_list_t > &align_res) noexcept
 Returns the specified element using seqan3::align_result_key as specifier. More...
 
template<align_result_key e, typename output_type_list_t >
constexpr auto const & get (align_result< output_type_list_t > const &align_res) noexcept
 
template<align_result_key e, typename output_type_list_t >
constexpr auto && get (align_result< output_type_list_t > &&align_res) noexcept
 
template<align_result_key e, typename output_type_list_t >
constexpr auto const && get (align_result< output_type_list_t > const &&align_res) noexcept
 

Detailed Description

template<typename output_type_list_t>
struct seqan3::align_result< output_type_list_t >

Stores the alignment results and offers a tuple-like interface.

Template Parameters
output_type_list_tseqan3::type_list over the contained results.

Member Function Documentation

◆ begin_coordinate()

template<typename output_type_list_t >
decltype(auto) constexpr seqan3::align_result< output_type_list_t >::begin_coordinate ( ) const &&
inlinenoexcept

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ end_coordinate()

template<typename output_type_list_t >
decltype(auto) constexpr seqan3::align_result< output_type_list_t >::end_coordinate ( ) const &&
inlinenoexcept

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ trace()

template<typename output_type_list_t >
decltype(auto) constexpr seqan3::align_result< output_type_list_t >::trace ( ) const &&
inlinenoexcept

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Friends And Related Function Documentation

◆ get() [1/4]

template<align_result_key e, typename output_type_list_t >
constexpr auto & get ( align_result< output_type_list_t > &  align_res)
related

Returns the specified element using seqan3::align_result_key as specifier.

Template Parameters
eThe enum value of seqan3::align_result_key.
Parameters
[in]align_resThe seqan3::align_result to get the specified value for.
Returns
The value associated with the enum value e.

◆ get() [2/4]

template<align_result_key e, typename output_type_list_t >
constexpr auto const & get ( align_result< output_type_list_t > const &  align_res)
related

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ get() [3/4]

template<align_result_key e, typename output_type_list_t >
constexpr auto && get ( align_result< output_type_list_t > &&  align_res)
related

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ get() [4/4]

template<align_result_key e, typename output_type_list_t >
constexpr auto const && get ( align_result< output_type_list_t > const &&  align_res)
related

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.


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