SeqAn3
matrix_concept.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 <cstddef>
43 
44 #include <seqan3/std/concepts>
45 
46 namespace seqan3::detail
47 {
48 
59 template <typename matrix_t>
61 concept matrix_concept = requires(matrix_t m)
62 {
64 
68  typename matrix_t::entry_type;
69 
74  { m.cols() } -> size_t;
75 
80  { m.rows() } -> size_t;
81 
86  { m.at(size_t{0u}, size_t{0u}) } -> typename matrix_t::entry_type;
88 };
91 
102 template <matrix_concept matrix1_t, matrix_concept matrix2_t>
106 inline bool operator==(matrix1_t const & lhs, matrix2_t const & rhs) noexcept
107 {
108  if (lhs.rows() != rhs.rows())
109  return false;
110 
111  if (lhs.cols() != rhs.cols())
112  return false;
113 
114  for (size_t row = 0u; row < lhs.rows(); ++row)
115  for (size_t col = 0u; col < lhs.cols(); ++col)
116  if (lhs.at(row, col) != rhs.at(row, col))
117  return false;
118 
119  return true;
120 }
121 
129 template <matrix_concept matrix1_t, matrix_concept matrix2_t>
133 inline bool operator!=(matrix1_t const & lhs, matrix2_t const & rhs) noexcept
134 {
135  return !(lhs == rhs);
136 }
138 
139 } // namespace seqan3
The Concepts library.
Definition: aligned_sequence_concept.hpp:288
Requires std::detail::WeaklyEqualityComparableWitht<t1,t2>, but also that t1 and t2, as well as their common_reference_t satisfy std::EqualityComparable.