BioC++ core-0.7.0
The Modern C++ libraries for Bioinformatics.
 
Loading...
Searching...
No Matches
concept.hpp File Reference

Core alphabet concept and free function/type trait wrappers. More...

+ Include dependency graph for concept.hpp:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Concepts

concept  bio::alphabet::semialphabet
 The basis for bio::alphabet::alphabet, but requires only rank interface (not char).
 
concept  bio::alphabet::writable_semialphabet
 A refinement of bio::alphabet::semialphabet that adds assignability.
 
concept  bio::alphabet::alphabet
 The generic alphabet concept that covers most data types used in ranges.
 
concept  bio::alphabet::writable_alphabet
 Refines bio::alphabet::alphabet and adds assignability.
 

Namespaces

namespace  bio
 The main BioC++ namespace.
 
namespace  bio::alphabet
 The alphabet module's namespace.
 

Typedefs

template<typename alphabet_type >
using bio::alphabet::char_t = decltype(bio::alphabet::to_char(std::declval< alphabet_type const >()))
 The char_type of the alphabet; defined as the return type of bio::alphabet::to_char.
 
template<typename semi_alphabet_type >
using bio::alphabet::rank_t = decltype(bio::alphabet::to_rank(std::declval< semi_alphabet_type >()))
 The rank_type of the semi-alphabet; defined as the return type of bio::alphabet::to_rank.
 

Variables

template<typename alph_t , typename wrap_t = meta::default_initialisable_wrap_t<alph_t>>
constexpr auto bio::alphabet::size
 A type trait that holds the size of a (semi-)alphabet.
 
Function objects
constexpr auto bio::alphabet::assign_char_strictly_to
 Assign a character to an alphabet object, throw if the character is not valid.
 
constexpr auto bio::alphabet::assign_char_to
 Assign a char to an alphabet object.
 
constexpr auto bio::alphabet::assign_rank_to
 Assign a rank to an alphabet object.
 
template<typename alph_t >
constexpr auto bio::alphabet::char_is_valid_for
 Returns whether a character is in the valid set of a bio::alphabet::alphabet (usually implies a bijective mapping to an alphabet value).
 
constexpr auto bio::alphabet::to_char
 Return the char representation of an alphabet object.
 
constexpr auto bio::alphabet::to_rank
 Return the rank representation of a (semi-)alphabet object.
 

Detailed Description

Core alphabet concept and free function/type trait wrappers.

Author
Hannes Hauswedell <hannes.hauswedell AT decode.is>