SeqAn3
seqan3::view Namespace Reference

The SeqAn3 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

template<std::Iterator it_t, std::Sentinel< it_t > sen_t>
using subrange = std::ranges::iterator_range< it_t, sen_t >
 Create a view from a pair of iterator and sentinel. More...
 

Variables

constexpr auto all
 A view that safely wraps a container (you will likely not need to use this unless defining a new view). More...
 
constexpr auto common
 A range adaptor that makes any range satisfy std::ranges::CommonRange (at the expense of some performance). More...
 
constexpr auto filter
 A range adaptor that takes a predicate and returns a view of the elements that satisfy the predicate. More...
 
constexpr auto reverse
 A range adaptor that presents the underlying range in reverse order. More...
 
auto constexpr take_exactly_or_throw
 A view adaptor that returns the first size elements from the underlying range and also exposes size information; throws if the underlying range is smaller than size. More...
 
constexpr auto transform
 A range adaptor that takes a invocable and returns a view of the elements with the invocable applied. More...
 
Alphabet related views
template<alphabet_concept alphabet_type>
auto const char_to
 A view over an alphabet, given a range of characters. More...
 
auto const complement
 A view that converts a range of nucleotides to their complement. More...
 
auto constexpr kmer_hash
 A view that calls std::hash on each substring of length k in the input range. More...
 
template<typename alphabet_type >
auto const rank_to
 A view over an alphabet, given a range of ranks. More...
 
auto const to_char
 A view that calls seqan3::to_char() on each element in the input range. More...
 
auto const to_rank
 A view that calls seqan3::to_rank() on each element in the input range. More...
 
constexpr auto translate_single
 A view that translates nucleotide into aminoacid alphabet for one of the six frames. More...
 
constexpr auto translate
 A view that translates nucleotide into aminoacid alphabet with 1, 2, 3 or 6 frames. More...
 
constexpr auto trim
 A view that does quality-threshold trimming on a range of seqan3::quality_concept. More...
 
General purpose views
template<typename out_t >
auto const convert
 A view that converts each element in the input range (implicitly or via static_cast). More...
 
template<size_t index>
auto const get
 A view calling std::get on each element in a range. More...
 
auto constexpr persist
 A view adaptor that wraps rvalue references of non-views. More...
 
constexpr auto single_pass_input
 A view adapter that decays most of the range properties and adds single pass behavior. More...
 
auto constexpr take
 A view adaptor that returns the first size elements from the underlying range (or less if the underlying range is shorter). More...
 
auto constexpr take_exactly
 A view adaptor that returns the first size elements from the underlying range (or less if the underlying range is shorter); also provides size information. More...
 
auto constexpr take_line
 A view adaptor that returns a single line from the underlying range or the full range if there is no newline. More...
 
auto constexpr take_line_or_throw
 A view adaptor that returns a single line from the underlying range (throws if there is no end-of-line). More...
 
auto constexpr take_until
 A view adaptor that returns elements from the underlying range until the functor evaluates to true (or the end of the underlying range is reached). More...
 
auto constexpr take_until_or_throw
 A view adaptor that returns elements from the underlying range until the functor evaluates to true (throws if the end of the underlying range is reached). More...
 

Detailed Description

The SeqAn3 namespace for views.

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

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