The iterator type inherits from the underlying type, but overwrites several operators. More...
#include <seqan3/range/views/take_until.hpp>
Public Member Functions | |
Constructors, destructor and assignment | |
Exceptions specification is implicitly inherited. | |
constexpr | basic_iterator ()=default |
Defaulted. | |
constexpr | basic_iterator (basic_iterator const &rhs)=default |
Defaulted. | |
constexpr | basic_iterator (basic_iterator &&rhs)=default |
Defaulted. | |
constexpr basic_iterator & | operator= (basic_iterator const &rhs)=default |
Defaulted. | |
constexpr basic_iterator & | operator= (basic_iterator &&rhs)=default |
Defaulted. | |
~basic_iterator ()=default | |
Defaulted. | |
basic_iterator (base_base_t it) noexcept(noexcept(base_t{it})) | |
Constructor that delegates to the CRTP layer. | |
basic_iterator (base_base_t it, fun_ref_t _fun, sentinel_type) noexcept(noexcept(base_t{it})) | |
Constructor that delegates to the CRTP layer and initialises the callable. | |
![]() | |
constexpr base_t | base () && |
Returns an rvalue of the base. | |
constexpr base_t | base () const & |
Get a copy of the base. | |
constexpr | inherited_iterator_base () noexcept(std::is_nothrow_default_constructible_v< base_t >)=default |
Defaulted. | |
constexpr | inherited_iterator_base (inherited_iterator_base const &rhs) noexcept(std::is_nothrow_copy_constructible_v< base_t >)=default |
Defaulted. | |
constexpr | inherited_iterator_base (inherited_iterator_base &&rhs) noexcept(std::is_nothrow_move_constructible_v< base_t >)=default |
Defaulted. | |
constexpr | inherited_iterator_base (base_t it) noexcept(std::is_nothrow_move_constructible_v< base_t >) |
Delegate to base class if inheriting from non-pointer iterator. | |
constexpr | inherited_iterator_base (base_t it) noexcept |
Initialise member if deriving from pointer. | |
constexpr inherited_iterator_base & | operator= (inherited_iterator_base const &rhs) noexcept(std::is_nothrow_copy_assignable_v< base_t >)=default |
Defaulted. | |
constexpr inherited_iterator_base & | operator= (inherited_iterator_base &&rhs) noexcept(std::is_nothrow_move_assignable_v< base_t >)=default |
Defaulted. | |
~inherited_iterator_base () noexcept(std::is_nothrow_destructible_v< base_t >)=default | |
Defaulted. | |
constexpr bool | operator== (basic_iterator< rng_t > const &rhs) const noexcept(noexcept(std::declval< base_t & >()==std::declval< base_t & >())) |
Checks whether *this is equal to rhs . | |
constexpr bool | operator!= (basic_iterator< rng_t > const &rhs) const noexcept(noexcept(std::declval< base_t & >()==std::declval< base_t & >())) |
Checks whether *this is not equal to rhs . | |
constexpr bool | operator< (basic_iterator< rng_t > const &rhs) const noexcept(noexcept(std::declval< base_t & >()< std::declval< base_t & >())) |
Checks whether *this is less than rhs . | |
constexpr bool | operator> (basic_iterator< rng_t > const &rhs) const noexcept(noexcept(std::declval< base_t & >() > std::declval< base_t & >())) |
Checks whether *this is greater than rhs . | |
constexpr bool | operator<= (basic_iterator< rng_t > const &rhs) const noexcept(noexcept(std::declval< base_t & >() > std::declval< base_t & >())) |
Checks whether *this is less than or equal to rhs . | |
constexpr bool | operator>= (basic_iterator< rng_t > const &rhs) const noexcept(noexcept(std::declval< base_t & >()< std::declval< base_t & >())) |
Checks whether *this is greater than or equal to rhs . | |
constexpr reference | operator* () noexcept(noexcept(*std::declval< base_t & >())) |
Dereference operator returns element currently pointed at. | |
constexpr decltype(auto) | operator* () const noexcept(noexcept(*std::declval< base_t const & >())) |
Dereference operator returns element currently pointed at. | |
constexpr pointer | operator-> () noexcept(noexcept(*std::declval< base_t & >())) |
Return pointer to this iterator. | |
constexpr decltype(auto) | operator-> () const noexcept(noexcept(*std::declval< base_t const & >())) |
Return pointer to this iterator. | |
constexpr decltype(auto) | operator[] (std::make_signed_t< difference_type > const n) noexcept(noexcept(std::declval< base_t & >()[0])) |
Return underlying container value currently pointed at. | |
constexpr decltype(auto) | operator[] (std::make_signed_t< difference_type > const n) const noexcept(noexcept(std::declval< base_t const & >()[0])) |
Return underlying container value currently pointed at. | |
constexpr basic_iterator< rng_t > & | operator++ () noexcept(noexcept(++std::declval< base_t & >())) |
Pre-increment, return updated iterator. | |
constexpr auto | operator++ (int) noexcept(noexcept(std::declval< base_t & >()++)) |
Post-increment of input iterators that do not return a copy of themselves but void or a proxy type. | |
constexpr basic_iterator< rng_t > | operator++ (int) noexcept(noexcept(std::declval< base_t & >()++) &&noexcept(basic_iterator< rng_t >(std::declval< base_t & >()))) |
Post-increment, return previous iterator state. | |
constexpr basic_iterator< rng_t > & | operator-- () noexcept(noexcept(--std::declval< base_t & >())) |
Pre-decrement, return updated iterator. | |
constexpr basic_iterator< rng_t > | operator-- (int) noexcept(noexcept(std::declval< base_t & >() --) &&noexcept(basic_iterator< rng_t > {std::declval< base_t & >()})) |
Post-decrement, return previous iterator state. | |
constexpr basic_iterator< rng_t > & | operator+= (difference_type const skip) noexcept(noexcept(std::declval< base_t & >()+=skip)) |
Move iterator to the right. | |
constexpr basic_iterator< rng_t > | operator+ (difference_type const skip) const noexcept(noexcept(std::declval< base_t & >()+skip) &&noexcept(basic_iterator< rng_t > {std::declval< base_t & >()})) |
Returns an iterator which is advanced by skip positions. | |
constexpr basic_iterator< rng_t > & | operator-= (difference_type const skip) noexcept(noexcept(std::declval< base_t & >() -=skip)) |
Decrement iterator by skip. | |
constexpr basic_iterator< rng_t > | operator- (difference_type const skip) const noexcept(noexcept(std::declval< base_t const & >() - skip) &&noexcept(basic_iterator< rng_t >(std::declval< base_t & >()))) |
Return decremented copy of this iterator. | |
constexpr difference_type | operator- (basic_iterator< rng_t > const &rhs) const noexcept(noexcept(std::declval< base_t & >() - std::declval< base_t & >())) |
Return offset between this and remote iterator's position. | |
Private Types | |
using | base_base_t = std::ranges::iterator_t< rng_t > |
The iterator type of the underlying range. | |
using | base_t = inherited_iterator_base< basic_iterator, std::ranges::iterator_t< rng_t > > |
The CRTP wrapper type. | |
using | fun_ref_t = std::conditional_t< std::is_const_v< rng_t >, std::remove_reference_t< fun_t > const &, std::remove_reference_t< fun_t > & > |
Auxiliary type. | |
using | sentinel_type = std::ranges::sentinel_t< rng_t > |
The sentinel type is identical to that of the underlying range. | |
Private Attributes | |
seqan3::semiregular_box_t< fun_ref_t > | fun |
Reference to the functor stored in the view. | |
The iterator type inherits from the underlying type, but overwrites several operators.
rng_t | Should be urng_t for defining iterator and urng_t const for defining const_iterator. |