SeqAn3  3.0.3
The Modern C++ library for sequence analysis.
phred42.hpp
Go to the documentation of this file.
1 // -----------------------------------------------------------------------------------------------------
2 // Copyright (c) 2006-2020, Knut Reinert & Freie Universität Berlin
3 // Copyright (c) 2016-2020, Knut Reinert & MPI für molekulare Genetik
4 // This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License
5 // shipped with this file and also available at: https://github.com/seqan/seqan3/blob/master/LICENSE.md
6 // -----------------------------------------------------------------------------------------------------
7 
13 #pragma once
14 
16 
17 namespace seqan3
18 {
19 
44 class phred42 : public quality_base<phred42, 42>
45 {
46 private:
49 
51  friend base_t;
53  friend base_t::base_t;
55 
56 public:
60  constexpr phred42() noexcept = default;
61  constexpr phred42(phred42 const &) noexcept = default;
62  constexpr phred42(phred42 &&) noexcept = default;
63  constexpr phred42 & operator=(phred42 const &) noexcept = default;
64  constexpr phred42 & operator=(phred42 &&) noexcept = default;
65  ~phred42() noexcept = default;
66 
68  constexpr phred42(phred_type const p) : base_t{p} {}
69 
70  // Inherit converting constructor
71  using base_t::base_t;
73 
78  static constexpr phred_type offset_phred{0};
79 
81  static constexpr char_type offset_char{'!'};
83 };
84 
92 constexpr phred42 operator""_phred42(char const c) noexcept
93 {
94  return phred42{}.assign_char(c);
95 }
96 
107 inline std::vector<phred42> operator""_phred42(char const * s, std::size_t n)
108 {
110  r.resize(n);
111 
112  for (size_t i = 0; i < n; ++i)
113  r[i].assign_char(s[i]);
114 
115  return r;
116 }
118 
119 } // namespace seqan3
A CRTP-base that makes defining a custom alphabet easier.
Definition: alphabet_base.hpp:55
constexpr derived_type & assign_char(char_type const c) noexcept
Assign from a character, implicitly converts invalid characters.
Definition: alphabet_base.hpp:158
Quality type for traditional Sanger and modern Illumina Phred scores.
Definition: phred42.hpp:45
constexpr phred42() noexcept=default
Defaulted.
static constexpr phred_type offset_phred
The projection offset between Phred and rank score representation.
Definition: phred42.hpp:78
static constexpr char_type offset_char
The projection offset between char and rank score representation.
Definition: phred42.hpp:81
A CRTP-base that refines seqan3::alphabet_base and is used by the quality alphabets.
Definition: quality_base.hpp:29
int8_t phred_type
The integer representation of a quality score assignable with =operator.
Definition: quality_base.hpp:35
The main SeqAn3 namespace.
Definition: aligned_sequence_concept.hpp:29
Provides seqan3::phred42 quality scores.
T resize(T... args)