Loading...
Searching...
No Matches
seqan3::views Namespace Reference

The SeqAn namespace for views. More...

## Classes

class | deep
| A wrapper type around an existing view adaptor that enables "deep view" behaviour for that view. More...

## Typedefs

using | chunk = seqan::stl::views::chunk

A view adaptor that divides a range into chunks.

This entity is not part of the SeqAn API. Do not rely on it in your applications. This is a implementation of the C++23 chunk_view. It will be replaced with std::views::chunk.

.

using | join_with = seqan::stl::views::join_with

A view adaptor that represents view consisting of the sequence obtained from flattening a view of ranges, with every element of the delimiter inserted in between elements of the view. The delimiter can be a single element or a view of elements.

This entity is not part of the SeqAn API. Do not rely on it in your applications. This is a implementation of the C++23 join_with_view. It will be replaced with ::std::views::join_with.

.

using | zip = seqan::stl::views::zip

A view adaptor that takes several views and returns tuple-like values from every i-th element of each view.

This entity is not part of the SeqAn API. Do not rely on it in your applications. This is a implementation of the C++23 zip_view. It will be replaced with std::views::zip.

.

## Variables

constexpr auto | async_input_buffer
| A view adapter that returns a concurrent-queue-like view over the underlying range.
template<alphabet alphabet_type>
auto const | char_strictly_to
| A view over an alphabet, given a range of characters.
template<alphabet alphabet_type>
auto const | char_to
| A view over an alphabet, given a range of characters.
auto const | complement
| A view that converts a range of nucleotides to their complement.
template<typename out_t>
constexpr auto | convert
| A view that converts each element in the input range (implicitly or via static_cast).
template<auto index>
constexpr auto | elements
| A view calling get on each element in a range.
constexpr auto | enforce_random_access
| A view adaptor that converts a pseudo random access range to a std::ranges::random_access_range.
constexpr auto | interleave
| A view that interleaves a given range into another range at regular intervals.
constexpr auto | kmer_hash
| Computes hash values for each position of a range via a given shape.
constexpr auto | minimiser
| Computes minimisers for a range of comparable values. A minimiser is the smallest value in a window.
constexpr auto | pairwise_combine
| A view adaptor that generates all pairwise combinations of the elements of the underlying range.
template<typename alphabet_type>
auto const | rank_to
| A view over an alphabet, given a range of ranks.
constexpr detail::repeat_fn | repeat
| A view factory that repeats a given value infinitely.
constexpr auto | repeat_n
| A view factory that repeats a given value n times.
constexpr auto | single_pass_input
| A view adapter that decays most of the range properties and adds single pass behavior.
constexpr auto | slice
| A view adaptor that returns a half-open interval on the underlying range.
auto const | to_char
| A view that calls seqan3::to_char() on each element in the input range.
auto const | to_rank
| A view that calls seqan3::to_rank() on each element in the input range.
constexpr auto | translate
| A view that translates nucleotide into aminoacid alphabet with 1, 2, 3 or 6 frames.
constexpr auto | translate_join
| A view that translates nucleotide into aminoacid alphabet with 1, 2, 3 or 6 frames. Input and output range are always two-dimensional.
constexpr auto | trim_quality
| A view that does quality-threshold trimming on a range of seqan3::quality_alphabet.
constexpr auto | type_reduce
| A view adaptor that behaves like std::views::all, but type erases certain ranges.
template<alphabet alphabet_type>
auto const | validate_char_for
| An identity view that throws if an encountered character is not valid for the given alphabet.
Alphabet related views
constexpr auto | translate_single
| A view that translates nucleotide into aminoacid alphabet for one of the six frames.
constexpr auto | minimiser_hash
| Computes minimisers for a range with a given shape, window size and seed.

## Detailed Description

The SeqAn namespace for views.

[adaptor_def]

Since views often have name clashes with regular functions and ranges they are implemented in the sub namespace view.

See the views submodule of the range module for more details.

Hide me