SeqAn3
mask.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 
42 #include <cassert>
45 
46 namespace seqan3
47 {
61 class mask : public alphabet_base<mask, 2, void>
62 {
63 private:
66 
68  friend base_t;
69 
70 public:
74  constexpr mask() : base_t{} {}
75  constexpr mask(mask const &) = default;
76  constexpr mask(mask &&) = default;
77  constexpr mask & operator=(mask const &) = default;
78  constexpr mask & operator=(mask &&) = default;
79  ~mask() = default;
81 
86  static const mask UNMASKED;
88  static const mask MASKED;
90 };
91 
92 mask constexpr mask::UNMASKED{mask{}.assign_rank(0)};
93 mask constexpr mask::MASKED {mask{}.assign_rank(1)};
94 } // namespace seqan3
The main SeqAn3 namespace.
Definition: aligned_sequence_concept.hpp:58
seqan3::alphabet_concept metafunction base classes.
Provides seqan3::alphabet_base.
semi_alphabet_concept && assign_rank(semi_alphabet_concept &&alph, rank_type const rank)
Returns the alphabet letter&#39;s value in rank representation.
A CRTP-base that makes defining a custom alphabet easier.
Definition: alphabet_base.hpp:77
Implementation of a masked alphabet to be used for cartesian compositions.
Definition: mask.hpp:61