Loading...
Searching...
No Matches
char.hpp
Go to the documentation of this file.
// SPDX-FileCopyrightText: 2006-2025 Knut Reinert & Freie Universität Berlin
// SPDX-FileCopyrightText: 2016-2025 Knut Reinert & MPI für molekulare Genetik
// SPDX-License-Identifier: BSD-3-Clause
#pragma once
#include <seqan3/alphabet/concept.hpp>
#include <seqan3/utility/detail/integer_traits.hpp>
namespace seqan3::detail
{
template <typename type>
constexpr bool is_char_adaptation_v =
std::same_as<type, char> || std::same_as<type, char8_t> || std::same_as<type, char16_t>
|| std::same_as<type, char32_t> || std::same_as<type, wchar_t>;
} // namespace seqan3::detail
namespace seqan3::custom
{
template <typename char_type>
requires detail::is_char_adaptation_v<char_type>
struct alphabet<char_type>
{
static constexpr auto alphabet_size =
detail::min_viable_uint_t<detail::size_in_values_v<char_type>>{detail::size_in_values_v<char_type>};
static constexpr char_type to_char(char_type const chr) noexcept
{
return chr;
}
static constexpr auto to_rank(char_type const chr) noexcept
{
return static_cast<detail::min_viable_uint_t<alphabet_size - 1>>(chr);
}
static constexpr char_type & assign_char_to(char_type const chr2, char_type & chr) noexcept
{
return chr = chr2;
}
static constexpr char_type & assign_rank_to(decltype(alphabet::to_rank(char_type{})) const rank,
char_type & chr) noexcept
{
return chr = rank;
}
};
} // namespace seqan3::custom
concept.hpp
Core alphabet concept and free function/type trait wrappers.
integer_traits.hpp
Provides metaprogramming utilities for integer types.
seqan3::custom
A namespace for third party and standard library specialisations of SeqAn customisation points.
Definition char.hpp:40
seqan3::custom::alphabet< char_type >::to_rank
static constexpr auto to_rank(char_type const chr) noexcept
Convert char to rank by casting to an unsigned integral type of same size.
Definition char.hpp:76
seqan3::custom::alphabet< char_type >::alphabet_size
static constexpr auto alphabet_size
The number of values the char type can take (e.g. 256 for char).
Definition char.hpp:56
seqan3::custom::alphabet< char_type >::assign_char_to
static constexpr char_type & assign_char_to(char_type const chr2, char_type &chr) noexcept
Assign a char to the char type (same as calling =).
Definition char.hpp:88
seqan3::custom::alphabet< char_type >::to_char
static constexpr char_type to_char(char_type const chr) noexcept
Converting char to char is no-op (it will just return the value you pass in).
Definition char.hpp:65
seqan3::custom::alphabet< char_type >::assign_rank_to
static constexpr char_type & assign_rank_to(decltype(alphabet::to_rank(char_type{})) const rank, char_type &chr) noexcept
Assigning a rank to a char is the same as assigning it a numeric value.
Definition char.hpp:100
seqan3::custom::alphabet
A type that can be specialised to provide customisation point implementations so that third party typ...
Definition alphabet/concept.hpp:46
Hide me