SeqAn3
phred42.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 
40 #pragma once
41 
43 
44 // ------------------------------------------------------------------
45 // phred42
46 // ------------------------------------------------------------------
47 
48 namespace seqan3
49 {
50 
69 class phred42 : public quality_base<phred42, 42>
70 {
71 private:
74 
76  friend base_t;
78  friend base_t::base_t;
80 
81 public:
85  constexpr phred42() : base_t{} {}
86  constexpr phred42(phred42 const &) = default;
87  constexpr phred42(phred42 &&) = default;
88  constexpr phred42 & operator=(phred42 const &) = default;
89  constexpr phred42 & operator=(phred42 &&) = default;
90  ~phred42() = default;
91 
93  constexpr phred42(phred_type const p) : base_t{p} {}
94 
95  // Inherit converting constructor
96  using base_t::base_t;
98 
102  static constexpr phred_type offset_phred{0};
104 
106  static constexpr char_type offset_char{'!'};
108 };
109 
110 } // namespace seqan3
char char_type
The type of the alphabet when converted to char (e.g. via to_char()).
Definition: alphabet_base.hpp:87
int8_t phred_type
The integer representation of a quality score assignable with =operator.
Definition: quality_base.hpp:62
The main SeqAn3 namespace.
Definition: aligned_sequence_concept.hpp:58
A CRTP-base that refines seqan3::alphabet_base and is used by the quality alphabets.
Definition: quality_base.hpp:55
static constexpr char_type offset_char
The projection offset between char and rank score representation.
Definition: phred42.hpp:106
constexpr phred42(phred_type const p)
Construct from phred value.
Definition: phred42.hpp:93
Contains seqan3::phred42 quality scores.
Quality type for traditional Sanger and modern Illumina Phred scores (typical range).
Definition: phred42.hpp:69
static constexpr phred_type offset_phred
The projection offset between phred and rank score representation.
Definition: phred42.hpp:103