SeqAn3 3.4.0-rc.1
The Modern C++ library for sequence analysis.
Loading...
Searching...
No Matches
seqan3::match_score< score_type > Struct Template Reference

A strong type of underlying type score_type that represents the score of two matching characters. More...

#include <seqan3/alignment/scoring/scoring_scheme_base.hpp>

+ Inheritance diagram for seqan3::match_score< score_type >:

Related Symbols

(Note that these are not member symbols.)

Template argument type deduction guides
template<arithmetic score_type>
 match_score (score_type) -> match_score< score_type >
 Deduce the score type from the provided argument.
 

Additional Inherited Members

- Public Types inherited from seqan3::detail::strong_type< score_type, match_score< score_type >, detail::strong_type_skill::convert >
using value_type = score_type
 The underlying value type.
 
- Public Member Functions inherited from seqan3::detail::strong_type< score_type, match_score< score_type >, detail::strong_type_skill::convert >
constexpr strong_type () noexcept=default
 Defaulted.
 
constexpr strong_type (strong_type const &) noexcept=default
 Defaulted.
 
constexpr strong_type (strong_type &&) noexcept=default
 Defaulted.
 
constexpr strong_type (score_type _value)
 Construction from underlying value type.
 
constexpr strong_typeoperator= (strong_type const &) noexcept=default
 Defaulted.
 
constexpr strong_typeoperator= (strong_type &&) noexcept=default
 Defaulted.
 
 ~strong_type () noexcept=default
 Defaulted.
 
constexpr score_type & get () &noexcept
 Returns the underlying value.
 
constexpr score_type const & get () const &noexcept
 Returns the underlying value.
 
constexpr score_type && get () &&noexcept
 Returns the underlying value as rvalue.
 
constexpr score_type const && get () const &&noexcept
 Returns the underlying value as rvalue.
 
constexpr match_score< score_type > operator+ (strong_type const &other)
 Adds addition operator to the strong type.
 
constexpr match_score< score_type > operator- (strong_type const &other)
 Adds subtraction operator to the strong type.
 
constexpr match_score< score_type > operator* (strong_type const &other)
 Adds multiplication operator to the strong type.
 
constexpr match_score< score_type > operator/ (strong_type const &other)
 Adds division operator to the strong type.
 
constexpr match_score< score_type > operator% (strong_type const &other)
 Adds modulo operator to the strong type.
 
constexpr match_score< score_type > operator& (strong_type const &other)
 Adds bitwise and operator to the strong type.
 
constexpr match_score< score_type > operator| (strong_type const &other)
 Adds bitwise or operator to the strong type.
 
constexpr match_score< score_type > operator^ (strong_type const &other)
 Adds bitwise xor operator to the strong type.
 
constexpr match_score< score_type > operator~ ()
 Adds bitwise not operator to the strong type.
 
constexpr match_score< score_type > operator<< (strong_type const &other)
 Adds bitwise left shift operator to the strong type.
 
constexpr match_score< score_type > operator<< (integral_t const shift)
 Adds bitwise left shift operator to the strong type.
 
constexpr match_score< score_type > operator>> (strong_type const &other)
 Adds bitwise right shift operator to the strong type.
 
constexpr match_score< score_type > operator>> (integral_t const shift)
 Adds bitwise right shift operator to the strong type.
 
constexpr bool operator&& (strong_type const &other)
 Adds logical and operator to the strong type.
 
constexpr bool operator|| (strong_type const &other)
 Adds logical or operator to the strong type.
 
constexpr bool operator! ()
 Adds logical not operator to the strong type.
 
constexpr match_score< score_type > & operator++ ()
 Adds pre-increment operator to the strong type.
 
constexpr match_score< score_type > operator++ (int)
 Adds post-increment operator to the strong type.
 
constexpr match_score< score_type > & operator-- ()
 Adds pre-decrement operator to the strong type.
 
constexpr match_score< score_type > operator-- (int)
 Adds post-decrement operator to the strong type.
 
constexpr bool operator== (strong_type const &rhs) const
 Return whether this instance is equal to rhs.
 
constexpr bool operator!= (strong_type const &rhs) const
 Return whether this instance is not equal to rhs.
 
constexpr operator score_type () const
 Adds explicit conversion to it's underlying type.
 
- Static Public Attributes inherited from seqan3::detail::strong_type< score_type, match_score< score_type >, detail::strong_type_skill::convert >
static constexpr strong_type_skill skills
 The selected skills for this type.
 

Detailed Description

template<arithmetic score_type>
struct seqan3::match_score< score_type >

A strong type of underlying type score_type that represents the score of two matching characters.

Template Parameters
score_typeThe underlying type.
See also
scoring_scheme_base::set_simple_scheme

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