SeqAn3 3.4.0-rc.1
The Modern C++ library for sequence analysis.
|
The return type of seqan3::views::translate_single. More...
#include <seqan3/alphabet/views/translate.hpp>
Public Types | |
Member types | |
using | reference = aa27 |
The reference_type. | |
using | const_reference = aa27 |
The const_reference type. | |
using | value_type = aa27 |
The value_type (which equals the reference_type with any references removed). | |
using | size_type = std::ranges::range_size_t< urng_t > |
The size_type. | |
using | difference_type = std::ranges::range_difference_t< urng_t > |
A signed integer type, usually std::ptrdiff_t. | |
using | iterator = detail::random_access_iterator< view_translate_single > |
The iterator type of this view (a random access iterator). | |
using | const_iterator = detail::random_access_iterator< view_translate_single const > |
The const_iterator type is equal to the iterator type. | |
Public Member Functions | |
size_type | size () |
Returns the number of elements in the view. | |
size_type | size () const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
Constructors, destructor and assignment | |
view_translate_single () noexcept=default | |
Defaulted. | |
constexpr | view_translate_single (view_translate_single const &rhs) noexcept=default |
Defaulted. | |
constexpr | view_translate_single (view_translate_single &&rhs) noexcept=default |
Defaulted. | |
constexpr view_translate_single & | operator= (view_translate_single const &rhs) noexcept=default |
Defaulted. | |
constexpr view_translate_single & | operator= (view_translate_single &&rhs) noexcept=default |
Defaulted. | |
~view_translate_single () noexcept=default | |
Defaulted. | |
view_translate_single (urng_t _urange, translation_frames const _tf=translation_frames::forward_frame0) | |
Construct from another view. | |
template<typename rng_t > requires (!std::same_as<std::remove_cvref_t<rng_t>, view_translate_single>) && std::ranges::viewable_range<rng_t> && std::constructible_from<urng_t, std::ranges::ref_view<std::remove_reference_t<rng_t>>> | |
view_translate_single (rng_t &&_urange, translation_frames const _tf=translation_frames::forward_frame0) | |
Construct from another range. | |
Iterators | |
iterator | begin () noexcept |
Returns an iterator to the first element of the container. | |
const_iterator | begin () const noexcept |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
iterator | end () noexcept |
Returns an iterator to the element following the last element of the container. | |
const_iterator | end () const noexcept |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
Element access | |
reference | operator[] (size_type const n) |
Return the n-th element. | |
const_reference | operator[] (size_type const n) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
Private Attributes | |
translation_frames | tf |
The frame that should be used for translation. | |
urng_t | urange |
The input range (of ranges). | |
Static Private Attributes | |
static constexpr small_string | multiple_frame_error |
Error thrown if tried to be used with multiple frames. | |
The return type of seqan3::views::translate_single.
|
inline |
Construct from another view.
[in] | _urange | The underlying range. |
[in] | _tf | The frame that should be used for translation. |
Throws if multiple frames are given as _tf input argument.
|
inline |
Construct from another range.
[in] | _urange | The underlying range. |
[in] | _tf | The frame that should be used for translation. |
Throws if multiple frames are given as _tf input argument.
|
inlinenoexcept |
Returns an iterator to the first element of the container.
If the container is empty, the returned iterator will be equal to end().
Constant.
No-throw guarantee.
|
inlinenoexcept |
Returns an iterator to the element following the last element of the container.
This element acts as a placeholder; attempting to dereference it results in undefined behaviour.
Constant.
No-throw guarantee.
|
inline |
Return the n-th element.
[in] | n | The element to retrieve. |
Accessing an element behind the last causes undefined behaviour. In debug mode an assertion checks the size of the container.
Strong exception guarantee (never modifies data).
Constant.
|
inline |
Returns the number of elements in the view.
Constant.
Strong exception guarantee (never modifies data).
|
staticconstexprprivate |
Error thrown if tried to be used with multiple frames.