cusbf::Alphabet Concept Reference

Concept for alphabet-like types used to encode bytes as symbol indices. More...

Concept definition

template<typename T>
concept cusbf::Alphabet =  requires(const char* input) {
    { T::symbolCount } -> std::convertible_to<uint64_t>;
    { T::symbolWidth } -> std::convertible_to<uint64_t>;
    { T::invalidSymbol } -> std::convertible_to<uint8_t>;
    { T::separator } -> std::convertible_to<uint8_t>;
    { T::validBytes } -> std::convertible_to<const char*>;
    { T::encode(input) } -> std::same_as<uint8_t>;
} && requires {
    requires T::symbolCount > 0 && T::symbolCount <= 255;
    requires T::symbolWidth > 0;
    requires detail::validByteCount<T>() > 0;
    requires detail::separatorByteAlwaysEncodesInvalid<T>();
}

Detailed Description

Concept for alphabet-like types used to encode bytes as symbol indices.

A type satisfies Alphabet if it provides:

• T::symbolCount: number of encoded symbols in the alphabet.
• T::symbolWidth: number of input bytes consumed per encoded symbol.
• T::invalidSymbol: sentinel value for invalid symbols.
• T::separator: sentinel value for separators when concatenating sequences.
• T::validBytes: null-terminated representative valid input bytes.
• T::encode(const char*): maps symbolWidth input bytes to a symbol index, or invalidSymbol if the input bytes are not valid in the alphabet.

Template Parameters

T	Alphabet type to validate.

Definition at line 95 of file Alphabet.cuh.