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...

Variables
constexpr auto	chunk = ::ranges::views::chunk
	A chunk view. More...
template<simd_concept index_simd_t>
constexpr detail::iota_simd_view_fn< index_simd_t >	iota_simd
	An iota view over a simd vector. More...
template<simd::simd_concept simd_t>
constexpr auto	to_simd
	A view that transforms a range of ranges into chunks of seqan3::simd vectors. More...
General purpose views
constexpr auto	async_input_buffer
	A view adapter that returns a concurrent-queue-like view over the underlying range. More...
auto const	as_const
	A view that provides only const & to elements of the underlying range. More...
constexpr auto	drop
	A view adaptor that returns all elements after n from the underlying range (or an empty range if the underlying range is shorter). More...
constexpr auto	enforce_random_access
	A view adaptor that converts a pseudo random access range to a std::random_access_range. More...
template<auto index>
auto const	get
	A view calling std::get on each element in a range. More...
constexpr auto	interleave
	A view that interleaves a given range into another range at regular intervals. More...
constexpr auto	istreambuf
	A view factory that returns a view over the stream buffer of an input stream. More...
auto const	move
	A view that turns lvalue-references into rvalue-references. More...
constexpr auto	pairwise_combine
	A view adaptor that generates all pairwise combinations of the elements of the underlying range. More...
constexpr auto	persist
	A view adaptor that wraps rvalue references of non-views. More...
constexpr detail::repeat_fn	repeat
	A view factory that repeats a given value infinitely. More...
constexpr auto	repeat_n
	A view factory that repeats a given value n times. More...
constexpr auto	single_pass_input
	A view adapter that decays most of the range properties and adds single pass behavior. More...
constexpr auto	slice
	A view adaptor that returns a half-open interval on the underlying range. More...
constexpr auto	take
	A view adaptor that returns the first size elements from the underlying range (or less if the underlying range is shorter). More...
constexpr auto	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...
constexpr auto	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	take_line = views::take_until_and_consume(is_char<'\r'> || is_char<'\n'>)
	A view adaptor that returns a single line from the underlying range or the full range if there is no newline. More...
constexpr auto	take_line_or_throw = views::take_until_or_throw_and_consume(is_char<'\r'> || is_char<'\n'>)
	A view adaptor that returns a single line from the underlying range (throws if there is no end-of-line). More...
constexpr auto	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...
constexpr auto	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...
constexpr auto	take_until_and_consume
	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; consumes end in single-pass ranges). More...
constexpr auto	take_until_or_throw_and_consume
	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; consumes end in single-pass ranges). More...
auto const	to_lower
	A view that calls seqan3::to_lower() on each element in the input range. More...
auto const	to_upper
	A view that calls seqan3::to_upper() on each element in the input range. More...
constexpr auto	type_reduce
	A view adaptor that behaves like std::views::all, but type erases certain ranges. More...
constexpr auto	minimiser
	Computes minimisers for a range of comparable values. A minimiser is the smallest value in a window. More...
template<typename out_t >
constexpr auto	convert
	A view that converts each element in the input range (implicitly or via static_cast). More...
Alphabet related views
template<alphabet 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...
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	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. More...
constexpr auto	trim_quality
	A view that does quality-threshold trimming on a range of seqan3::quality_alphabet. More...
constexpr auto	kmer_hash
	Computes hash values for each position of a range via a given shape. More...
constexpr auto	minimiser_hash
	Computes minimisers for a range with a given shape, window size and seed. More...

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.