SeqAn3  3.0.1
The Modern C++ library for sequence analysis.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 123]
 Nsdsl
 Nseqan3The main SeqAn3 namespace
 NstdSeqAn specific customisations in the standard namespace
 Caligned_sequenceThe generic concept for an aligned sequence
 Calignment_file_input_formatThe generic concept for alignment file input formats
 Calignment_file_input_traitsThe requirements a traits_type for seqan3::alignment_file_input must meet
 Calignment_file_output_formatThe generic concept for alignment file out formats
 CalphabetThe generic alphabet concept that covers most data types used in ranges
 Caminoacid_alphabetA concept that indicates whether an alphabet represents amino acids
 Cargument_parser_compatible_optionChecks whether the the type can be used in an add_(positional_)option call on the argument parser
 CarithmeticA type that satisfies std::is_arithmetic_v<t>
 Cassignable_fromThe concept std::assignable_from<LHS, RHS> specifies that an expression of the type and value category specified by RHS can be assigned to an lvalue expression whose type is specified by LHS
 Cbi_fm_index_cursor_specialisationConcept for bidirectional FM index cursors
 Cbi_fm_index_specialisationConcept for bidirectional FM indices
 CbooleanSpecifies that a type can be used in boolean contexts
 Cbuiltin_characterThis concept encompasses exactly the types char, signed char, unsigned char, wchar_t, char16_t and char32_t
 Ccereal_archiveAll archives of the Cereal library satisfy this
 Ccereal_input_archiveAll input archives of the Cereal library satisfy this
 Ccereal_output_archiveAll output archives of the Cereal library satisfy this
 Ccereal_text_archiveAll text archives of the Cereal library satisfy this
 CcerealisableSpecifies the requirements for types that are serialisable via Cereal
 Ccommon_reference_withThe concept std::common_reference_with<T, U> specifies that two types T and U share a common reference type (as computed by std::common_reference_t) to which both can be converted
 Ccommon_withThe concept std::common_with<T, U> specifies that two types T and U share a common type (as computed by std::common_type_t) to which both can be converted
 CcompatibleTwo types are "compatible" if their seqan3::dimension_v and their seqan3::innermost_value_type_t are the same
 Cconst_iterable_rangeSpecifies requirements of an input range type for which the const version of that type satisfies the same strength input range concept as the non-const version
 Cconstructible_fromThe std::constructible_from concept specifies that a variable of type T can be initialized with the given set of argument types Args...
 CcontainerThe (most general) container concept as defined by the standard library
 Cconvertible_toThe concept std::convertible_to<From, To> specifies that an expression of the type and value category specified by From can be implicitly and explicitly converted to the type To, and the two forms of conversion are equivalent
 Ccopy_constructibleThe concept std::copy_constructible is satisfied if T is an lvalue reference type, or if it is a move_constructible object type where an object of that type can constructed from a (possibly const) lvalue or const rvalue of that type in both direct- and copy-initialization contexts with the usual semantics (a copy is constructed with the source unchanged)
 CcopyableSubsumes std::movable, std::copy_constructible, and requires that the type be std::assignable_from bool from a const & of itself
 Cdefault_constructibleThe std::default_constructible concept provides a shorthand for the common case when the question is whether a type can be constructed with no arguments
 Cderived_fromThe concept std::derived_from<Derived, Base> is satisfied if and only if Base is a class type that is either Derived or a public and unambiguous base of Derived, ignoring cv-qualifiers
 CdestructibleThe concept std::destructible specifies the concept of all types whose instances can safely be destroyed at the end of their lifetime (including reference types)
 Cequality_comparableThe same as std::weakly_equality_comparable_with<t,t>
 Cequality_comparable_withRequires seqan3::detail::weakly_equality_comparable_witht<t1,t2>, but also that t1 and t2, as well as their common_reference_t satisfy std::equality_comparable
 Cexplicitly_convertible_toResolves to std::ranges::explicitly_convertible_to<type1, type2>()
 Cfloating_pointAn arithmetic type that also satisfies std::is_floating_point_v<t>
 Cfm_index_cursor_specialisationConcept for unidirectional FM index cursors
 Cfm_index_specialisationConcept for unidirectional FM indices
 Cforwarding_rangeSpecifies a range whose iterators may outlive the range and remain valid
 Cimplicitly_convertible_toResolves to std::ranges::implicitly_convertible_to<type1, type2>()
 Cinput_stream_overConcept for input streams
 CintegralThe concept integral is satisfied if and only if T is an integral type
 CinvocableSpecifies whether the given callable is invocable with the given arguments
 CmovableSubsumes std::Object, std::move_constructible, std::swappable bool and requires that the type be std::assignable_from bool from a value of itself
 Cmove_constructibleThe concept std::move_constructible is satisfied if T is a reference type, or if it is an object type where an object of that type can constructed from an rvalue of that type in both direct- and copy-initialization contexts, with the usual semantics
 Cnamed_enumerationChecks whether the free function seqan3::enumeration_names can be called on the type
 Cnucleotide_alphabetA concept that indicates whether an alphabet represents nucleotides
 Coutput_stream_overConcept for output streams
 CpredicateSpecifies whether the given callable is std::regular_invocable and returns bool
 Cpseudo_random_access_iteratorThis concept checks if an iterator type models pseudo random access
 Cpseudo_random_access_rangeThis concept checks if a type models a pseudo random access range
 Cquality_alphabetA concept that indicates whether an alphabet represents quality scores
 Crandom_access_containerA more refined container concept than seqan3::sequence_container
 CregularSubsumes std::semiregular and std::equality_comparable
 Cregular_invocableSpecifies whether the given callable is invocable with the given arguments and equality preserving (invocations change neither the callable, nor the arguments)
 CrelationSpecifies that R defines a binary relation over the set of expressions whose type and value category are those encoded by either t or u
 Creservible_containerA more refined container concept than seqan3::random_access_container
 Crna_structure_alphabetA concept that indicates whether an alphabet represents RNA structure
 Csame_asThe concept std::same_as<T, U> is satisfied if and only if T and U denote the same type
 Cscoring_schemeA concept that requires that type be able to score two letters
 CsemialphabetThe basis for seqan3::alphabet, but requires only rank interface (not char)
 CsemiregularSubsumes std::copyable and std::default_constructible
 Csequence_containerA more refined container concept than seqan3::container
 Csequence_file_input_formatThe generic concept for sequence file in formats
 Csequence_file_input_traitsThe requirements a traits_type for seqan3::sequence_file_input must meet
 Csequence_file_output_formatThe generic concept for sequence file out formats
 Csigned_integralThe concept std::signed_integral is satisfied if and only if T is an integral type and std::is_signed_v<T> is true
 Cstandard_layoutResolves to std::is_standard_layout_v<t>
 Cstream_REMOVEMEConcept for i/o streams permitting both directions
 Cstrict_weak_orderThe concept strict_weak_order<R, T, U> specifies that the relation R imposes a strict weak ordering on its arguments
 Cstructure_file_input_formatThe generic concept for structure file in formats
 Cstructure_file_input_traitsThe requirements a traits_type for seqan3::structure_file_input must meet
 Cstructure_file_output_formatThe generic concept for structure file out formats
 CswappableThe concept std::swappable specifies that lvalues of type T are swappable
 Cswappable_withThe concept std::swappable_with<T, U> specifies that expressions of the type and value category encoded by T and U are swappable with each other
 Ctotally_orderedRequires std::equality_comparable and all remaing comparison operators (<, <=, >, >=)
 Ctotally_ordered_withRequires std::equality_comparable and all remaing comparison operators (<, <=, >, >=)
 Ctransformation_traitConcept for a transformation trait
 CtrivialA type that satisfies seqan3::trivially_copyable and seqan3::trivially_destructible
 Ctrivially_copyableA type that satisfies std::is_trivially_copyable_v<t>
 Ctrivially_destructibleA type that satisfies std::is_trivially_destructible_v<t>
 Ctuple_likeWhether a type behaves like a tuple
 Cunary_type_traitConcept for a unary traits type
 Cunsigned_integralThe concept std::unsigned_integral is satisfied if and only if T is an integral type and std::is_signed_v<T> is false
 CvalidatorThe concept for option validators passed to add_option/positional_option
 Cweakly_assignable_fromResolves to std::is_assignable_v<t>
 Cwritable_alphabetRefines seqan3::alphabet and adds assignability
 Cwritable_quality_alphabetA concept that indicates whether a writable alphabet represents quality scores
 Cwritable_semialphabetA refinement of seqan3::semialphabet that adds assignability