SeqAn3
nucleotide_scoring_scheme.hpp
Go to the documentation of this file.
1 // ============================================================================
2 // SeqAn - The Library for Sequence Analysis
3 // ============================================================================
4 //
5 // Copyright (c) 2006-2018, Knut Reinert & Freie Universitaet Berlin
6 // Copyright (c) 2016-2018, Knut Reinert & MPI Molekulare Genetik
7 // All rights reserved.
8 //
9 // Redistribution and use in source and binary forms, with or without
10 // modification, are permitted provided that the following conditions are met:
11 //
12 // * Redistributions of source code must retain the above copyright
13 // notice, this list of conditions and the following disclaimer.
14 // * Redistributions in binary form must reproduce the above copyright
15 // notice, this list of conditions and the following disclaimer in the
16 // documentation and/or other materials provided with the distribution.
17 // * Neither the name of Knut Reinert or the FU Berlin nor the names of
18 // its contributors may be used to endorse or promote products derived
19 // from this software without specific prior written permission.
20 //
21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 // ARE DISCLAIMED. IN NO EVENT SHALL KNUT REINERT OR THE FU BERLIN BE LIABLE
25 // FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 // DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27 // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28 // CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 // LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 // OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
31 // DAMAGE.
32 //
33 // ============================================================================
34 
41 #pragma once
42 
45 
46 namespace seqan3
47 {
48 
70 template <arithmetic_concept score_type = int8_t>
71 class nucleotide_scoring_scheme : public scoring_scheme_base<nucleotide_scoring_scheme<score_type>, dna15, score_type>
72 {
73 private:
76 public:
80  //NOTE(h-2): unfortunately these are not inherited in the documentation
82  SEQAN3_DOXYGEN_ONLY(( constexpr nucleotide_scoring_scheme() noexcept {} ))
84  SEQAN3_DOXYGEN_ONLY((
85  template <arithmetic_concept score_arg_t>
87  ))
89  SEQAN3_DOXYGEN_ONLY(( constexpr nucleotide_scoring_scheme(matrix_type const & _matrix) noexcept {} ))
91 
94  using base_t::base_t;
95 };
96 
102 
106 template <arithmetic_concept score_arg_type>
109 
110 template <arithmetic_concept score_arg_type>
111 nucleotide_scoring_scheme(std::array<std::array<score_arg_type, 15>, 15>) -> nucleotide_scoring_scheme<score_arg_type>;
113 
114 } // namespace seqan3
A CRTP base class for scoring schemes.
Definition: scoring_scheme_base.hpp:119
The main SeqAn3 namespace.
Definition: aligned_sequence_concept.hpp:58
A strong type of underlying type score_type that represents the score of two matching characters...
Definition: scoring_scheme_base.hpp:68
A strong type of underlying type score_type that represents the score two different characters...
Definition: scoring_scheme_base.hpp:91
A data structure for managing and computing the score of two nucleotides.
Definition: nucleotide_scoring_scheme.hpp:71
constexpr nucleotide_scoring_scheme() noexcept
The default constructor (delegates to set_hamming_distance()).
Definition: nucleotide_scoring_scheme.hpp:82
Provides seqan3::scoring_scheme_base.
std::array< std::array< score_type, matrix_size >, matrix_size > matrix_type
Type of the internal matrix (a two-dimensional array).
Definition: scoring_scheme_base.hpp:138
Contains seqan3::dna15, container aliases and string literals.