char.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 <limits>

#include <seqan3/core/detail/int_types.hpp>
#include <seqan3/std/concepts>

namespace seqan3::detail
{

template <typename type, typename type_no_ref = std::remove_reference_t<type>>
constexpr bool is_char_adaptation_v = std::Same<type_no_ref, char>     ||
                                      std::Same<type_no_ref, char16_t> ||
                                      std::Same<type_no_ref, char32_t> ||
                                      std::Same<type_no_ref, wchar_t>;
} // namespace seqan3::detail

namespace seqan3::custom
{

template <typename char_type>
    requires seqan3::detail::is_char_adaptation_v<char_type>
constexpr auto alphabet_size(char_type const & SEQAN3_DOXYGEN_ONLY(chr)) noexcept
{
    return detail::min_viable_uint_t<detail::size_in_values_v<char_type>>{detail::size_in_values_v<char_type>};
}

template <typename char_type>
    requires seqan3::detail::is_char_adaptation_v<char_type>
constexpr char_type to_char(char_type const chr) noexcept
{
    return chr;
}

template <typename char_type>
    requires seqan3::detail::is_char_adaptation_v<char_type>
constexpr auto to_rank(char_type const chr) noexcept
{
    return static_cast<::seqan3::detail::min_viable_uint_t<alphabet_size(char_type{}) - 1>>(chr);
}

template <typename char_type>
    requires detail::is_char_adaptation_v<char_type>
constexpr char_type & assign_char_to(char_type const chr2, char_type & chr) noexcept
{
    return chr = chr2;
}

template <typename char_type>
    requires detail::is_char_adaptation_v<char_type>
constexpr char_type & assign_rank_to(decltype(to_rank(char_type{})) const rank, char_type & chr) noexcept
{
    return chr = rank;
}

} // namespace seqan3::custom