two_dimensional_matrix_iterator_concept.hpp

Go to the documentation of this file.

// -----------------------------------------------------------------------------------------------------
// Copyright (c) 2006-2022, Knut Reinert & Freie Universität Berlin
// Copyright (c) 2016-2022, 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 <concepts>
#include <iterator>
#include <type_traits>
 
#include <seqan3/alignment/matrix/detail/matrix_coordinate.hpp>
 
namespace seqan3::detail
{
 
template <typename iter_t>
concept two_dimensional_matrix_iterator =
    std::random_access_iterator<iter_t>
    && requires (std::remove_reference_t<iter_t> it, std::remove_reference_t<iter_t> const cit, matrix_offset offset) {
           {
               it += offset
           };
           {
               it + offset
           };
           {
               offset + it
           };
           {
               cit + offset
           };
           {
               offset + cit
           };
           {
               it -= offset
           };
           {
               it - offset
           };
           {
               cit - offset
           };
           {
               it.coordinate()
           };
           {
               cit.coordinate()
           };
 
           {
               it += offset
               } -> std::same_as<std::remove_reference_t<iter_t> &>;
           {
               it + offset
               } -> std::same_as<std::remove_reference_t<iter_t>>;
           {
               offset + it
               } -> std::same_as<std::remove_reference_t<iter_t>>;
           {
               it -= offset
               } -> std::same_as<std::remove_reference_t<iter_t> &>;
           {
               it - offset
               } -> std::same_as<std::remove_reference_t<iter_t>>;
           {
               cit - offset
               } -> std::same_as<std::remove_reference_t<iter_t>>;
           {
               it.coordinate()
               } -> std::same_as<matrix_coordinate>;
           {
               cit.coordinate()
               } -> std::same_as<matrix_coordinate>;
       };
} // namespace seqan3::detail