seqan3::ScoringScheme Interface Reference

A concept that requires that type be able to score two letters. More...

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

Inheritance diagram for seqan3::ScoringScheme:

Related Functions
(Note that these are not member functions.)
Requirements for seqan3::ScoringScheme
You can expect these members on all types that implement seqan3::ScoringScheme.
typedef IMPLEMENTATION_DEFINED	score_type
	The type returned by seqan3::ScoringScheme::score(), usually a seqan3::Arithmetic. More...
score_type	score (alph1_t const alph1, alph2_t const alph2)
	Compute the score of two letters. More...

Detailed Description

A concept that requires that type be able to score two letters.

Template Parameters

t	The type the concept check is performed on (the putative scoring scheme).
alphabet_t	The type of the first letter that you wish to score; must model seqan3::Alphabet.
alphabet2_t	The type of the second letter that you wish to score; must model seqan3::Alphabet; defaults to alphabet_t.

This concept makes no assumptions about configurability or assignability of the scoring scheme, only the ability to score the two letters is required.

Friends And Related Function Documentation

score()

score_type score ( alph1_t const  alph1, alph2_t const  alph2  )

related

Compute the score of two letters.

Parameters

alph1	First letter.
alph2	Second letter.

Attention

This is a concept requirement, not an actual function (however types satisfying this concept will provide an implementation).

score_type()

typedef IMPLEMENTATION_DEFINED score_type

related

The type returned by seqan3::ScoringScheme::score(), usually a seqan3::Arithmetic.

Attention

This is a concept requirement, not an actual typedef (however types satisfying this concept will provide an implementation).

---

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

• seqan3/alignment/scoring/scoring_scheme_concept.hpp