concept.hpp

Go to the documentation of this file.

// -----------------------------------------------------------------------------------------------------
// Copyright (c) 2006-2019, Knut Reinert & Freie Universität Berlin
// Copyright (c) 2016-2019, 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 <seqan3/alphabet/concept.hpp>
#include <seqan3/std/concepts>

// ============================================================================
// forwards
// ============================================================================

namespace seqan3::custom
{

void complement();

} // namespace seqan3::custom

// ============================================================================
// complement()
// ============================================================================

namespace seqan3::detail::adl::only
{

struct complement_fn
{
private:
    SEQAN3_CPO_IMPL(2, complement(v)                     ) // ADL
    SEQAN3_CPO_IMPL(1, seqan3::custom::complement(v)     ) // customisation namespace
    SEQAN3_CPO_IMPL(0, v.complement()                    ) // member

public:
    template <typename nucleotide_t>
        requires requires (nucleotide_t const nucl) { { impl(priority_tag<2>{}, nucl) }; }
    constexpr auto operator()(nucleotide_t const nucl) const noexcept
    {
        static_assert(noexcept(impl(priority_tag<2>{}, nucl)),
            "Only overloads that are marked noexcept are picked up by seqan3::complement().");
        static_assert(std::Same<nucleotide_t, decltype(impl(priority_tag<2>{}, nucl))>,
            "The return type of your complement() implementation must be 'nucleotide_t'.");

        return impl(priority_tag<2>{}, nucl);
    }
};

} // namespace seqan3::detail::adl::only

namespace seqan3
{

inline constexpr auto complement = detail::adl::only::complement_fn{};

// ============================================================================
// NucleotideAlphabet concept
// ============================================================================

template <typename t>
SEQAN3_CONCEPT NucleotideAlphabet = Alphabet<t> && requires (t val)
{
    { seqan3::complement(val) };
};

} // namespace seqan3