alphabet_base.hpp

Go to the documentation of this file.

// -----------------------------------------------------------------------------------------------------
// Copyright (c) 2006-2021, Knut Reinert & Freie Universität Berlin
// Copyright (c) 2016-2021, 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 <cassert>
#include <seqan3/std/concepts>
#include <seqan3/std/type_traits>
 
#include <seqan3/alphabet/concept.hpp>
#include <seqan3/utility/detail/integer_traits.hpp>
 
#ifdef SEQAN3_DEPRECATED_310
namespace seqan3::detail
{
// helper concept to deprecate old rank_to_char lookup tables
template <typename alphabet_t>
SEQAN3_CONCEPT has_rank_to_char_table = requires()
{
    { alphabet_t::rank_to_char[0] };
};
 
// helper concept to deprecate old char_to_rank lookup tables
template <typename alphabet_t>
SEQAN3_CONCEPT has_char_to_rank_table = requires()
{
    { alphabet_t::char_to_rank[0] };
};
 
} // namespace seqan3::detail
#endif // SEQAN3_DEPRECATED_310
 
namespace seqan3
{
 
template <typename derived_type, size_t size, typename char_t = char>
class alphabet_base
{
protected:
    static_assert(size != 0, "alphabet size must be >= 1"); // == 1 is handled below in separate specialisation
 
    using char_type = std::conditional_t<std::same_as<char_t, void>, char, char_t>;
 
    using rank_type = detail::min_viable_uint_t<size - 1>;
 
public:
    constexpr alphabet_base()                                   noexcept = default; 
    constexpr alphabet_base(alphabet_base const &)              noexcept = default; 
    constexpr alphabet_base(alphabet_base &&)                   noexcept = default; 
    constexpr alphabet_base & operator=(alphabet_base const &)  noexcept = default; 
    constexpr alphabet_base & operator=(alphabet_base &&)       noexcept = default; 
    ~alphabet_base()                                            noexcept = default; 
 
 
    constexpr char_type to_char() const noexcept
        requires (!std::same_as<char_t, void>)
    {
#ifdef SEQAN3_DEPRECATED_310
        if constexpr (detail::has_rank_to_char_table<derived_type>)
            return rank_to_char_table(rank);
        else
            return derived_type::rank_to_char(rank);
#else // ^^^ before 3.1.0 release / after 3.1.0 release vvv
        return derived_type::rank_to_char(rank);
#endif // SEQAN3_DEPRECATED_310
    }
 
#ifdef SEQAN3_DEPRECATED_310
private:
 
    SEQAN3_DEPRECATED_310 static constexpr char_type rank_to_char_table(rank_type const rank) noexcept
    {
        return derived_type::rank_to_char[rank];
    }
 
public:
#endif // SEQAN3_DEPRECATED_310
 
    constexpr rank_type to_rank() const noexcept
    {
        return rank;
    }
 
    constexpr derived_type & assign_char(char_type const chr) noexcept
        requires (!std::same_as<char_t, void>)
    {
#ifdef SEQAN3_DEPRECATED_310
        if constexpr (detail::has_char_to_rank_table<derived_type>)
            rank = char_to_rank_table(chr);
        else
            rank = derived_type::char_to_rank(chr);
#else // ^^^ before 3.1.0 release / after 3.1.0 release vvv
        rank = derived_type::char_to_rank(chr);
#endif // SEQAN3_DEPRECATED_310
 
        return static_cast<derived_type &>(*this);
    }
 
#ifdef SEQAN3_DEPRECATED_310
private:
 
    SEQAN3_DEPRECATED_310 static constexpr rank_type char_to_rank_table(char_type const chr) noexcept
    {
        using index_t = std::make_unsigned_t<char_type>;
#if SEQAN3_WORKAROUND_GCC_99318
#   pragma GCC diagnostic ignored "-Wdeprecated-declarations"
#endif // SEQAN3_WORKAROUND_GCC_99318
        return derived_type::char_to_rank[static_cast<index_t>(chr)];
    }
 
public:
#endif // SEQAN3_DEPRECATED_310
 
    constexpr derived_type & assign_rank(rank_type const c) noexcept
    {
        assert(static_cast<size_t>(c) < static_cast<size_t>(alphabet_size));
        rank = c;
        return static_cast<derived_type &>(*this);
    }
 
    static detail::min_viable_uint_t<size> constexpr alphabet_size = size;
 
 
    friend constexpr bool operator==(derived_type const lhs, derived_type const rhs) noexcept
    {
        return seqan3::to_rank(lhs) == seqan3::to_rank(rhs);
    }
 
    friend constexpr bool operator!=(derived_type const lhs, derived_type const rhs) noexcept
    {
        return seqan3::to_rank(lhs) != seqan3::to_rank(rhs);
    }
 
    friend constexpr bool operator<(derived_type const lhs, derived_type const rhs) noexcept
    {
        return seqan3::to_rank(lhs) < seqan3::to_rank(rhs);
    }
 
    friend constexpr bool operator>(derived_type const lhs, derived_type const rhs) noexcept
    {
        return seqan3::to_rank(lhs) > seqan3::to_rank(rhs);
    }
 
    friend constexpr bool operator<=(derived_type const lhs, derived_type const rhs) noexcept
    {
        return seqan3::to_rank(lhs) <= seqan3::to_rank(rhs);
    }
 
    friend constexpr bool operator>=(derived_type const lhs, derived_type const rhs) noexcept
    {
        return seqan3::to_rank(lhs) >= seqan3::to_rank(rhs);
    }
 
private:
    rank_type rank{};
};
 
} // namespace seqan3