►Nsdsl | |
Cplain_byte_alphabet | Byte alphabet that does no mapping of char_type to comp_char_type and vice versa |
►Nseqan3 | The main SeqAn3 namespace |
►Nalign_cfg | A special sub namespace for the alignment configurations |
Caligned_ends | The configuration for aligned sequence ends |
Cband | Configuration element for setting the band |
Cgap | A configuration element for the gap scheme |
Cmax_error | Sets the maximal errors allowed during an edit distance computation |
Cmode | Sets the alignment mode |
Cresult | Sets the result of the alignment computation |
Cscoring | Sets the scoring scheme for the alignment algorithm |
►Ncustom | A namespace for third party and standard library specialisations of SeqAn customisation points |
Calphabet | A type that can be specialised to provide customisation point implementations so that third party types model alphabet concepts |
Calphabet< char_type > | Alphabet specific customisations for builtin char types |
Calphabet< uint_type > | Alphabet specific customisations for unsigned integral types |
Cargument_parsing | A type that can be specialised to provide customisation point implementations for the seqan3::argument_parser such that third party types may be adapted |
►Nsearch_cfg | A special sub namespace for the search configurations |
Cdeletion | A strong type of underlying type uint8_t or double that represents the number or rate of deletions |
Cinsertion | A strong type of underlying type uint8_t or double that represents the number or rate of insertions |
Cmax_error | A configuration element for the maximum number of errors across all error types (mismatches, insertions, deletions). This is an upper bound of errors independent from error numbers of specific error types |
Cmax_error_rate | A configuration element for the maximum number of errors in percent of the query length across all error types (mismatches, insertions, deletions). This is an upper bound of errors independent from error rates of specific error types |
Cmode | Configuration element to determine the search mode |
Coutput | Configuration element to determine the output type of hits |
Cstrata | Configuration element to receive all hits with the best number of errors plus the strata value. A strong type of underlying type uint8_t that represents the number or errors for strata. All hits are found with the fewest numbererrors plus 'value' |
Csubstitution | A strong type of underlying type uint8_t or double that represents the number or rate of substitutions |
Ctotal | A strong type of underlying type uint8_t or double that represents the number or rate of total errors |
►Nviews | The SeqAn namespace for views |
Cdeep | A wrapper type around an existing view adaptor that enables "deep view" behaviour for that view |
Caa10li | The reduced Li amino acid alphabet |
Caa10murphy | The reduced Murphy amino acid alphabet |
Caa20 | The canonical amino acid alphabet |
Caa27 | The twenty-seven letter amino acid alphabet |
►Caligned_allocator | Allocates uninitialized storage whose memory-alignment is specified by alignment |
Crebind | The aligned_allocator member template class aligned_allocator::rebind provides a way to obtain an allocator for a different type |
Calignment_coordinate | Represents the begin/end of the pairwise alignment in the respective sequences |
►Calignment_file_header | Stores the header information of alignment files |
Cprogram_info_t | Stores information of the program/tool that was used to create the file |
Calignment_file_input | A class for reading alignment files, e.g. SAM, BAM, BLAST .. |
Calignment_file_input_default_traits | The default traits for seqan3::alignment_file_input |
Calignment_file_input_options | The options type defines various option members that influence the behaviour of all or some formats |
Calignment_file_output | A class for writing alignment files, e.g. SAM, BAL, BLAST, .. |
Calignment_file_output_options | The options type defines various option members that influence the behavior of all or some formats |
►Calignment_range | An input range over the alignment results generated by the underlying alignment executor |
Calignment_range_iterator | The iterator of seqan3::detail::alignment_range |
Calignment_result | Stores the alignment results and gives access to score, alignment and the front and back coordinates |
Calphabet_base | A CRTP-base that makes defining a custom alphabet easier |
Calphabet_base< derived_type, 1ul, char_t > | Specialisation of seqan3::alphabet_base for alphabets of size 1 |
Calphabet_proxy | A CRTP-base that eases the definition of proxy types returned in place of regular alphabets |
Calphabet_tuple_base | The CRTP base for a combined alphabet that contains multiple values of different alphabets at the same time |
Calphabet_variant | A combined alphabet that can hold values of either of its alternatives |
Caminoacid_base | A CRTP-base that refines seqan3::alphabet_base and is used by the amino acids |
Caminoacid_empty_base | This is an empty base class that can be inherited by types that shall model seqan3::aminoacid_alphabet |
Caminoacid_scoring_scheme | A data structure for managing and computing the score of two amino acids |
Cargument_parser | The SeqAn command line parser |
Cargument_parser_meta_data | Stores all parser related meta information of the seqan3::argument_parser |
Carithmetic_range_validator | A validator that checks whether a number is inside a given range |
Cback_end_first | The penalty configuration for aligning the back of the first sequence with a gap |
Cback_end_second | The penalty configuration for aligning the back of the second sequence with a gap |
Cbi_fm_index | The SeqAn Bidirectional FM Index |
Cbi_fm_index_cursor | The SeqAn Bidirectional FM Index Cursor |
Cbin_literal | A strong type of underlying type uint64_t that represents the shape in binary representation |
Cbitcompressed_vector | A space-optimised version of std::vector that compresses multiple letters into a single byte |
Ccigar | The cigar semialphabet pairs a counter with a seqan3::cigar_op letter |
Ccigar_op | The (extended) cigar operation alphabet of M,D,I,H,N,P,S,X,= |
Cconcatenated_sequences | Container that stores sequences concatenated internally |
Cconfiguration | Collection of elements to configure an algorithm |
Cconst_reference | Exposes the const_reference of another type |
Cconst_reference< rng_t > | Exposes the const_reference of another type |
Cdebug_stream_type | A "pretty printer" for most SeqAn data structures and related types |
Cdifference_type | Exposes the difference_type of another type |
Cdifference_type< it_t > | Exposes the difference_type of another type |
Cdifference_type< rng_t > | Exposes the difference_type of another type |
Cdna15 | The 15 letter DNA alphabet, containing all IUPAC smybols minus the gap |
Cdna3bs | The three letter reduced DNA alphabet for bisulfite sequencing mode (A,G,T(=C)) |
Cdna4 | The four letter DNA alphabet of A,C,G,T |
Cdna5 | The five letter DNA alphabet of A,C,G,T and the unknown character N |
Cdot_bracket3 | The three letter RNA structure alphabet of the characters ".()" |
Cdssp9 | The protein structure alphabet of the characters "HGIEBTSCX" |
Cdynamic_bitset | A constexpr bitset implementation with dynamic size at compile time |
Cend_gaps | Wraps the sequence end-gap specifiers and provides ordered access to the respective values |
Cfields | A class template that holds a choice of seqan3::field |
Cfile_open_error | Thrown if there is an unspecified filesystem or stream error while opening, e.g. permission problem |
Cfile_validator_base | An abstract base class for the file and directory validators |
Cfm_index | The SeqAn FM Index |
Cfm_index_cursor | The SeqAn FM Index Cursor |
Cformat_bam | The BAM format |
Cformat_embl | The EMBL format |
Cformat_error | Thrown if information given to output format didn't match expectations |
Cformat_fasta | The FastA format |
Cformat_fastq | The FastQ format |
Cformat_genbank | The GenBank format |
Cformat_sam | The SAM format (tag) |
Cformat_vienna | The Vienna format (dot bracket notation) for RNA sequences with secondary structure |
Cfront_end_first | The penalty configuration for aligning the front of the first sequence with a gap |
Cfront_end_second | The penalty configuration for aligning the front of the second sequence with a gap |
Cgap | The alphabet of a gap character '-' |
►Cgap_decorator | A gap decorator allows the annotation of sequences with gap symbols while leaving the underlying sequence unmodified |
Cgap_decorator_iterator | The iterator type over a seqan3::gap_decorator |
Cgap_erase_failure | Thrown in function seqan3::erase_gap, if a position does not contain a gap |
Cgap_open_score | A strong type of underlying type score_type that represents an additional score (usually negative) that is incurred once additionaly per stretch of consecutive gaps |
Cgap_scheme | A scheme for representing and computing scores against gap characters |
Cgap_score | A strong type of underlying type score_type that represents the score of any character against a gap character |
Cinnermost_value_type | Recursively determines the value_type on containers and/or iterators |
Cinput_directory_validator | A validator that checks if a given path is a valid input directory |
Cinput_file_validator | A validator that checks if a given path is a valid input file |
Cinvalid_alignment_configuration | Thrown if the configuration of the alignment algorithm is invalid |
Cinvalid_char_assignment | An exception typically thrown by seqan3::alphabet::assign_char_strict |
Cio_error | Thrown if there is an io error in low level io operations such as in std::basic_streambuf operations |
Cis_constexpr_default_constructible | Whether a type std::is_default_constructible in constexpr -context |
Cis_constexpr_default_constructible< t > | Whether a type std::is_default_constructible in constexpr -context (unary_type_trait specialisation) |
Cis_execution_policy | Test whether a class represents an execution policy |
Citerator_tag | Exposes the iterator_category from the modelled concept |
Clower_bound | Type for a lower boundary |
Cmask | Implementation of a masked alphabet to be used for tuple composites |
Cmasked | Implementation of a masked composite, which extends a given alphabet with a mask |
Cmatch_score | A strong type of underlying type score_type that represents the score of two matching characters |
Cmismatch_score | A strong type of underlying type score_type that represents the score two different characters |
Cnucleotide_base | A CRTP-base that refines seqan3::alphabet_base and is used by the nucleotides |
Cnucleotide_scoring_scheme | A data structure for managing and computing the score of two nucleotides |
Coption_declared_multiple_times | Argument parser exception thrown when a non-list option is declared multiple times |
Coutput_directory_validator | A validator that checks if a given path is a valid output directory |
Coutput_file_validator | A validator that checks if a given path is a valid output file |
Coverflow_error_on_conversion | Argument parser exception thrown when an argument could not be casted to the according type |
Cparallel_policy | Parallel execution policy |
Cparallel_unsequenced_policy | Parallel and unsequenced execution policy |
Cparse_error | Thrown if there is a parse error, such as reading an unexpected character from an input stream |
Cparser_design_error | Argument parser exception that is thrown whenever there is an design error directed at the developer of the application (e.g. Reuse of option) |
Cparser_invalid_argument | Argument parser exception that is thrown whenever there is an error while parsing the command line arguments |
Cphred42 | Quality type for traditional Sanger and modern Illumina Phred scores (typical range) |
Cphred63 | Quality type for traditional Sanger and modern Illumina Phred scores (full range) |
Cphred68legacy | Quality type for Solexa and deprecated Illumina formats |
Cpipeable_config_element | Adds pipe interface to configuration elements |
Cpod_tuple | Cond |
Cpod_tuple< type0 > | Recursion anchor for pod_tuple |
Cpod_tuple< type0, types... > | Behaves like std::tuple but is an aggregate PODType |
Cqualified | Joins an arbitrary alphabet with a quality alphabet |
Cquality_base | A CRTP-base that refines seqan3::alphabet_base and is used by the quality alphabets |
Crecord | The class template that file records are based on; behaves like an std::tuple |
Cref_info_not_given | Type tag which indicates that no reference information has been passed to the alignment file on construction |
Creference | Exposes the reference of another type |
Creference< it_t > | Exposes the reference type of another type |
Creference< rng_t > | Exposes the reference of another type |
Cregex_validator | A validator that checks if a matches a regular expression pattern |
Cremove_rvalue_reference | Return the input type with && removed, but lvalue references preserved |
Crequired_option_missing | Argument parser exception thrown when a required option is missing |
Crna15 | The 15 letter RNA alphabet, containing all IUPAC smybols minus the gap |
Crna4 | The four letter RNA alphabet of A,C,G,U |
Crna5 | The five letter RNA alphabet of A,C,G,U and the unknown character N |
Crvalue_reference | Exposes the rvalue_reference of another type |
Crvalue_reference< it_t > | Exposes the rvalue_reference type of another type |
Crvalue_reference< rng_t > | Exposes the rvalue_reference of another type |
Csam_dna16 | A 16 letter DNA alphabet, containing all IUPAC symbols minus the gap and plus an equality sign ('=') |
Csam_tag_dictionary | The SAM tag dictionary class that stores all optional SAM fields |
Csam_tag_type | The generic base class |
Cscoring_scheme_base | A CRTP base class for scoring schemes |
Csemialphabet_any | A semi-alphabet that type erases all other semi-alphabets of the same size |
Csequence_end_gap_specifier_base | A mixin class which can maintain a static or a dynamic bool state |
Csequence_file_input | A class for reading sequence files, e.g. FASTA, FASTQ .. |
Csequence_file_input_default_traits_aa | A traits type that specifies input as amino acids |
Csequence_file_input_default_traits_dna | The default traits for seqan3::sequence_file_input |
Csequence_file_input_options | The options type defines various option members that influence the behaviour of all or some formats |
Csequence_file_output | A class for writing sequence files, e.g. FASTA, FASTQ .. |
Csequence_file_output_options | The options type defines various option members that influence the behaviour of all or some formats |
Csequenced_policy | Sequenced execution policy |
Cshape | A class that defines what positions of a pattern to hash |
Csize_type | Exposes the size_type of another type |
Csize_type< it_t > | Exposes the size_type of another type |
Csize_type< rng_t > | Exposes the size_type of another type |
Csmall_string | Implements a small string that can be used for compile time computations |
Csmall_vector | A constexpr vector implementation with dynamic size at compile time |
Cstatic_band | Data structure for a static band |
Cstructure_file_input | A class for reading structured sequence files, e.g. Stockholm, Connect, Vienna, ViennaRNA bpp matrix .. |
Cstructure_file_input_default_traits_aa | A traits type that specifies input as amino acids |
Cstructure_file_input_default_traits_rna | The default traits for seqan3::structure_file_input |
Cstructure_file_input_options | The options type defines various option members that influence the behaviour of all or some formats |
Cstructure_file_output | A class for writing structured sequence files, e.g. Stockholm, Connect, Vienna, ViennaRNA bpp matrix .. |
Cstructure_file_output_options | The options type defines various option members that influence the behaviour of all or some formats |
Cstructured_aa | A seqan3::alphabet_tuple_base that joins an aminoacid alphabet with a protein structure alphabet |
Cstructured_rna | A seqan3::alphabet_tuple_base that joins a nucleotide alphabet with an RNA structure alphabet |
Ctoo_few_arguments | Argument parser exception thrown when too few arguments are provided |
Ctoo_many_arguments | Argument parser exception thrown when too many arguments are provided |
Ctype_conversion_failed | Argument parser exception thrown when an argument could not be casted to the according type |
Cunexpected_end_of_input | Thrown if I/O was expecting more input (e.g. a delimiter or a new line), but the end of input was reached |
Cungapped | A strong type of underlying type uint8_t that represents the ungapped shape size |
Cunhandled_extension_error | Thrown if there is no format that accepts a given file extension |
Cunknown_option | Argument parser exception thrown when encountering unknown option |
Cunsequenced_policy | Unsequenced execution policy |
Cupper_bound | Type for an upper boundary |
Cvalidation_failed | Argument parser exception thrown when an argument could not be casted to the according type |
Cvalue_list_validator | A validator that checks whether a value is inside a list of valid values |
Cvalue_type | Exposes the value_type of another type |
Cvalue_type< it_t > | Exposes the value_type of another type |
Cvalue_type< rng_t > | Exposes the value_type of another type |
Cwuss | The WUSS structure alphabet of the characters .<>:,-_~;()[]{}AaBbCcDd .. |
►Nstd | SeqAn specific customisations in the standard namespace |
Cfrom_chars_result | Result type of std::from_chars |
Chash< alphabet_t > | Struct for hashing a character |
Chash< seqan3::dynamic_bitset< cap > > | Struct for hashing a seqan3::dynamic_bitset |
Chash< urng_t > | Struct for hashing a range of characters |
Cto_chars_result | Result type of std::to_chars |
Ctuple_element< elem_no, seqan3::alignment_file_input< traits_type, selected_field_ids, valid_formats > > | Obtains the type of the specified element |
Ctuple_element< elem_no, seqan3::record< field_types, field_ids > > | Obtains the type of the specified element |
Ctuple_element< i, tuple_t > | Obtains the type of the specified element |
Ctuple_size< seqan3::alignment_file_input< traits_type, selected_field_ids, valid_formats > > | Provides access to the number of elements in a tuple as a compile-time constant expression |
Ctuple_size< seqan3::record< field_types, field_ids > > | Provides access to the number of elements in a tuple as a compile-time constant expression |
Ctuple_size< tuple_t > | Provides access to the number of elements in a tuple as a compile-time constant expression |
Caligned_sequence | The generic concept for an aligned sequence |
Calignment_file_input_format | The generic concept for alignment file input formats |
Calignment_file_input_traits | The requirements a traits_type for seqan3::alignment_file_input must meet |
Calignment_file_output_format | The generic concept for alignment file out formats |
Calphabet | The generic alphabet concept that covers most data types used in ranges |
Caminoacid_alphabet | A concept that indicates whether an alphabet represents amino acids |
Cargument_parser_compatible_option | Checks whether the the type can be used in an add_(positional_)option call on the argument parser |
Carithmetic | A type that satisfies std::is_arithmetic_v<t> |
Cassignable_from | The 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_specialisation | Concept for bidirectional FM index cursors |
Cbi_fm_index_specialisation | Concept for bidirectional FM indices |
Cboolean | Specifies that a type can be used in boolean contexts |
Cbuiltin_character | This concept encompasses exactly the types char , signed char , unsigned char , wchar_t , char16_t and char32_t |
Ccereal_archive | All archives of the Cereal library satisfy this |
Ccereal_input_archive | All input archives of the Cereal library satisfy this |
Ccereal_output_archive | All output archives of the Cereal library satisfy this |
Ccereal_text_archive | All text archives of the Cereal library satisfy this |
Ccerealisable | Specifies the requirements for types that are serialisable via Cereal |
Ccommon_reference_with | The 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_with | The 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 |
Ccompatible | Two types are "compatible" if their seqan3::dimension_v and their seqan3::innermost_value_type_t are the same |
Cconst_iterable_range | Specifies 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_from | The std::constructible_from concept specifies that a variable of type T can be initialized with the given set of argument types Args... |
Ccontainer | The (most general) container concept as defined by the standard library |
Cconvertible_to | The 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_constructible | The 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) |
Ccopyable | Subsumes std::movable, std::copy_constructible, and requires that the type be std::assignable_from bool from a const & of itself |
Cdefault_constructible | The 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_from | The 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 |
Cdestructible | The 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_comparable | The same as std::weakly_equality_comparable_with<t,t> |
Cequality_comparable_with | Requires 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_to | Resolves to std::ranges::explicitly_convertible_to<type1, type2>() |
Cfloating_point | An arithmetic type that also satisfies std::is_floating_point_v<t> |
Cfm_index_cursor_specialisation | Concept for unidirectional FM index cursors |
Cfm_index_specialisation | Concept for unidirectional FM indices |
Cforwarding_range | Specifies a range whose iterators may outlive the range and remain valid |
Cimplicitly_convertible_to | Resolves to std::ranges::implicitly_convertible_to<type1, type2>() |
Cinput_stream_over | Concept for input streams |
Cintegral | The concept integral is satisfied if and only if T is an integral type |
Cinvocable | Specifies whether the given callable is invocable with the given arguments |
Cmovable | Subsumes std::Object, std::move_constructible, std::swappable bool and requires that the type be std::assignable_from bool from a value of itself |
Cmove_constructible | The 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_enumeration | Checks whether the free function seqan3::enumeration_names can be called on the type |
Cnucleotide_alphabet | A concept that indicates whether an alphabet represents nucleotides |
Coutput_stream_over | Concept for output streams |
Cpredicate | Specifies whether the given callable is std::regular_invocable and returns bool |
Cpseudo_random_access_iterator | This concept checks if an iterator type models pseudo random access |
Cpseudo_random_access_range | This concept checks if a type models a pseudo random access range |
Cquality_alphabet | A concept that indicates whether an alphabet represents quality scores |
Crandom_access_container | A more refined container concept than seqan3::sequence_container |
Cregular | Subsumes std::semiregular and std::equality_comparable |
Cregular_invocable | Specifies whether the given callable is invocable with the given arguments and equality preserving (invocations change neither the callable, nor the arguments) |
Crelation | Specifies 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_container | A more refined container concept than seqan3::random_access_container |
Crna_structure_alphabet | A concept that indicates whether an alphabet represents RNA structure |
Csame_as | The concept std::same_as<T, U> is satisfied if and only if T and U denote the same type |
Cscoring_scheme | A concept that requires that type be able to score two letters |
Csemialphabet | The basis for seqan3::alphabet, but requires only rank interface (not char) |
Csemiregular | Subsumes std::copyable and std::default_constructible |
Csequence_container | A more refined container concept than seqan3::container |
Csequence_file_input_format | The generic concept for sequence file in formats |
Csequence_file_input_traits | The requirements a traits_type for seqan3::sequence_file_input must meet |
Csequence_file_output_format | The generic concept for sequence file out formats |
Csigned_integral | The concept std::signed_integral is satisfied if and only if T is an integral type and std::is_signed_v<T> is true |
Cstandard_layout | Resolves to std::is_standard_layout_v<t> |
Cstream_REMOVEME | Concept for i/o streams permitting both directions |
Cstrict_weak_order | The concept strict_weak_order<R, T, U> specifies that the relation R imposes a strict weak ordering on its arguments |
Cstructure_file_input_format | The generic concept for structure file in formats |
Cstructure_file_input_traits | The requirements a traits_type for seqan3::structure_file_input must meet |
Cstructure_file_output_format | The generic concept for structure file out formats |
Cswappable | The concept std::swappable specifies that lvalues of type T are swappable |
Cswappable_with | The 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_ordered | Requires std::equality_comparable and all remaing comparison operators (< , <= , > , >= ) |
Ctotally_ordered_with | Requires std::equality_comparable and all remaing comparison operators (< , <= , > , >= ) |
Ctransformation_trait | Concept for a transformation trait |
Ctrivial | A type that satisfies seqan3::trivially_copyable and seqan3::trivially_destructible |
Ctrivially_copyable | A type that satisfies std::is_trivially_copyable_v<t> |
Ctrivially_destructible | A type that satisfies std::is_trivially_destructible_v<t> |
Ctuple_like | Whether a type behaves like a tuple |
Cunary_type_trait | Concept for a unary traits type |
Cunsigned_integral | The concept std::unsigned_integral is satisfied if and only if T is an integral type and std::is_signed_v<T> is false |
Cvalidator | The concept for option validators passed to add_option/positional_option |
Cweakly_assignable_from | Resolves to std::is_assignable_v<t> |
Cwritable_alphabet | Refines seqan3::alphabet and adds assignability |
Cwritable_quality_alphabet | A concept that indicates whether a writable alphabet represents quality scores |
Cwritable_semialphabet | A refinement of seqan3::semialphabet that adds assignability |