Loading...
Searching...
No Matches
scoring_scheme_for Interface Reference
Sequence Alignment » Scoring

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

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

## Related Symbols

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

## 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 Symbol 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::scoring_scheme_for::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:

- scoring_scheme_concept.hpp

Hide me