matrix_concept.hpp

Go to the documentation of this file.

// -----------------------------------------------------------------------------------------------------
// Copyright (c) 2006-2020, Knut Reinert & Freie Universität Berlin
// Copyright (c) 2016-2020, Knut Reinert & MPI für molekulare Genetik
// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License
// shipped with this file and also available at: https://github.com/seqan/seqan3/blob/master/LICENSE.md
// -----------------------------------------------------------------------------------------------------
 
#pragma once
 
#include <cstddef>
#include <limits>
 
#include <seqan3/alignment/matrix/detail/matrix_coordinate.hpp>
#include <seqan3/std/concepts>
 
namespace seqan3::detail
{
 
template <typename score_type>
constexpr score_type matrix_inf = std::numeric_limits<score_type>::max();
 
template <typename matrix_t>
SEQAN3_CONCEPT matrix = requires(std::remove_cvref_t<matrix_t> m)
{
 
    typename std::remove_cvref_t<matrix_t>::value_type;
    typename std::remove_cvref_t<matrix_t>::reference;
    typename std::remove_cvref_t<matrix_t>::size_type;
 
    SEQAN3_RETURN_TYPE_CONSTRAINT(m.cols(), std::same_as, typename std::remove_cvref_t<matrix_t>::size_type);
 
    SEQAN3_RETURN_TYPE_CONSTRAINT(m.rows(), std::same_as, typename std::remove_cvref_t<matrix_t>::size_type);
 
    SEQAN3_RETURN_TYPE_CONSTRAINT(m.at(matrix_coordinate{}),
                                  std::same_as, typename std::remove_cvref_t<matrix_t>::reference);
 
};
 
template <matrix matrix1_t, matrix matrix2_t>
    requires std::equality_comparable_with<typename matrix1_t::reference, typename matrix2_t::reference>
inline bool operator==(matrix1_t const & lhs, matrix2_t const & rhs) noexcept
{
    if (lhs.rows() != rhs.rows())
        return false;
 
    if (lhs.cols() != rhs.cols())
        return false;
 
    for (size_t row = 0u; row < lhs.rows(); ++row)
        for (size_t col = 0u; col < lhs.cols(); ++col)
            if (matrix_coordinate co{row_index_type{row}, column_index_type{col}}; lhs.at(co) != rhs.at(co))
                return false;
 
    return true;
}
 
template <matrix matrix1_t, matrix matrix2_t>
    requires std::equality_comparable_with<typename matrix1_t::reference, typename matrix2_t::reference>
inline bool operator!=(matrix1_t const & lhs, matrix2_t const & rhs) noexcept
{
    return !(lhs == rhs);
}
 
} // namespace seqan3::detail