seqan3::detail::translate_fn< single > Struct Template Reference

Definition of the range adaptor object type for seqan3::views::translate and seqan3::views::translate_single. More...

#include <seqan3/alphabet/views/translate.hpp>

Public Member Functions
constexpr auto	operator() (translation_frames const tf=default_frames) const
	Store the argument and return a range adaptor closure object.
template<std::ranges::range urng_t>
constexpr auto	operator() (urng_t &&urange, translation_frames const tf=default_frames) const
	Directly return an instance of the view, initialised with the given parameters.

Static Public Attributes
static constexpr translation_frames	default_frames
	The default frames parameter for the translation view adaptors.

Friends
template<std::ranges::range urng_t>
constexpr friend auto	operator| (urng_t &&urange, translate_fn const &me)
	This adaptor is usable without setting the frames parameter in which case the default is chosen.

Detailed Description

template<bool single>
struct seqan3::detail::translate_fn< single >

Definition of the range adaptor object type for seqan3::views::translate and seqan3::views::translate_single.

Template Parameters

single

Switch between seqan3::views::translate and seqan3::views::translate_single.

Member Function Documentation

operator()()

template<bool single>

template<std::ranges::range urng_t>

constexpr auto seqan3::detail::translate_fn< single >::operator() ( urng_t &&  urange, translation_frames const  tf = default_frames  ) const

inlineconstexpr

Directly return an instance of the view, initialised with the given parameters.

Parameters

[in]	urange	The underlying range.
[in]	tf	The frame that should be used for translation.

Returns

A range of translated sequence(s).

Member Data Documentation

default_frames

template<bool single>

constexpr translation_frames seqan3::detail::translate_fn< single >::default_frames

staticconstexpr

Initial value:

=
        single ? translation_frames::forward_frame0 : translation_frames::six_frames

The default frames parameter for the translation view adaptors.

---

The documentation for this struct was generated from the following file:

• translate.hpp