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 <type_traits>
 
#include <seqan3/alphabet/concept.hpp>
#include <seqan3/core/type_traits/template_inspection.hpp>
 
// ============================================================================
// aminoacid_empty_base
// ============================================================================
 
namespace seqan3
{
 
struct aminoacid_empty_base
{};
 
} // namespace seqan3
 
// ============================================================================
// enable_aminoacid
// ============================================================================
 
namespace seqan3::detail::adl_only
{
 
template <typename ...args_t>
void enable_aminoacid(args_t ...) = delete;
 
struct enable_aminoacid_dispatcher
{
public:
    // explicit customisation
    SEQAN3_CPO_IMPL(2, std::bool_constant<seqan3::custom::alphabet<strip_type_identity_t<t>>::enable_aminoacid>::value)
    // ADL
    SEQAN3_CPO_IMPL(1, std::bool_constant<enable_aminoacid(t{})>::value)
    // default: derived from base class or not (valid for any type)
    SEQAN3_CPO_IMPL(0, (std::is_base_of_v<seqan3::aminoacid_empty_base, strip_type_identity_t<t>>))
 
    
    template <typename alph_t>
    static constexpr bool dispatch() noexcept
    {
        if constexpr (std::is_nothrow_default_constructible_v<alph_t> &&
                      seqan3::is_constexpr_default_constructible_v<alph_t>)
        {
            return impl(priority_tag<2>{}, alph_t{});
        }
        else
        {
            return impl(priority_tag<2>{}, std::type_identity<alph_t>{});
        }
    }
};
 
} // namespace seqan3::detail::adl_only
 
namespace seqan3
{
 
template <typename t>
inline constexpr bool enable_aminoacid = detail::adl_only::enable_aminoacid_dispatcher::dispatch<std::remove_cvref_t<t>>();
 
// ============================================================================
// concept
// ============================================================================
 
template <typename type>
SEQAN3_CONCEPT aminoacid_alphabet = alphabet<type> && enable_aminoacid<type>;
 
} // namespace seqan3