helios::utils::StepByAdapter< Iter > Class Template Reference

#include <functional_adapters.hpp>

Inheritance diagram for helios::utils::StepByAdapter< Iter >:

Public Types
using	iterator_category = std::forward_iterator_tag
using	value_type = std::iter_value_t< Iter >
using	difference_type = std::iter_difference_t< Iter >
using	pointer = value_type *
using	reference = value_type

Public Member Functions
constexpr	StepByAdapter (Iter begin, Iter end, size_t step) noexcept(std::is_nothrow_move_constructible_v< Iter > &&std::is_nothrow_copy_constructible_v< Iter >)
	Constructs a step-by adapter with the given iterator range and step size.
constexpr	StepByAdapter (const StepByAdapter &)=default
constexpr	StepByAdapter (StepByAdapter &&)=default
constexpr	~StepByAdapter ()=default
constexpr StepByAdapter &	operator= (const StepByAdapter &)=default
constexpr StepByAdapter &	operator= (StepByAdapter &&)=default
constexpr StepByAdapter &	operator++ () noexcept(noexcept(++std::declval< Iter & >()) &&noexcept(std::declval< Iter & >() !=std::declval< Iter & >()))
constexpr StepByAdapter	operator++ (int) noexcept(std::is_copy_constructible_v< StepByAdapter > &&noexcept(++std::declval< StepByAdapter & >()))
constexpr value_type	operator* () const noexcept(noexcept(*std::declval< const Iter & >()))
constexpr bool	operator== (const StepByAdapter &other) const noexcept(noexcept(std::declval< const Iter & >()==std::declval< const Iter & >()))
constexpr bool	operator!= (const StepByAdapter &other) const noexcept(noexcept(std::declval< const StepByAdapter & >()==std::declval< const StepByAdapter & >()))
constexpr StepByAdapter	begin () const noexcept(std::is_nothrow_copy_constructible_v< StepByAdapter >)
constexpr StepByAdapter	end () const noexcept(std::is_nothrow_constructible_v< StepByAdapter, const Iter &, const Iter &, size_t >)

Detailed Description

template<typename Iter>
requires StepByAdapterRequirements<Iter>
class helios::utils::StepByAdapter< Iter >

Definition at line 1367 of file functional_adapters.hpp.

Member Typedef Documentation

difference_type

template<typename Iter >

using helios::utils::StepByAdapter< Iter >::difference_type = std::iter_difference_t<Iter>

Examples

/home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/utils/functional_adapters.hpp.

Definition at line 1371 of file functional_adapters.hpp.

iterator_category

template<typename Iter >

using helios::utils::StepByAdapter< Iter >::iterator_category = std::forward_iterator_tag

Examples

/home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/utils/functional_adapters.hpp.

Definition at line 1369 of file functional_adapters.hpp.

pointer

template<typename Iter >

using helios::utils::StepByAdapter< Iter >::pointer = value_type*

Examples

/home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/utils/functional_adapters.hpp.

Definition at line 1372 of file functional_adapters.hpp.

reference

template<typename Iter >

using helios::utils::StepByAdapter< Iter >::reference = value_type

Examples

/home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/utils/functional_adapters.hpp.

Definition at line 1373 of file functional_adapters.hpp.

value_type

template<typename Iter >

using helios::utils::StepByAdapter< Iter >::value_type = std::iter_value_t<Iter>

Examples

/home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/utils/functional_adapters.hpp.

Definition at line 1370 of file functional_adapters.hpp.

Constructor & Destructor Documentation

StepByAdapter() [1/3]

template<typename Iter >

constexpr helios::utils::StepByAdapter< Iter >::StepByAdapter ( Iter  begin, Iter  end, size_t  step  )

inlineconstexprnoexcept

Constructs a step-by adapter with the given iterator range and step size.

Parameters

begin	Start of the iterator range
end	End of the iterator range
step	Number of elements to step by

Definition at line 1381 of file functional_adapters.hpp.

      : begin_(std::move(begin)), current_(begin_), end_(std::move(end)), step_(step > 0 ? step : 1) {}

StepByAdapter() [2/3]

template<typename Iter >

constexpr helios::utils::StepByAdapter< Iter >::StepByAdapter ( const StepByAdapter< Iter > &  )

constexprdefault

StepByAdapter() [3/3]

template<typename Iter >

constexpr helios::utils::StepByAdapter< Iter >::StepByAdapter ( StepByAdapter< Iter > &&  )

constexprdefault

~StepByAdapter()

template<typename Iter >

constexpr helios::utils::StepByAdapter< Iter >::~StepByAdapter ( )

constexprdefault

Examples

/home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/utils/functional_adapters.hpp.

Member Function Documentation

begin()

template<typename Iter >

constexpr StepByAdapter helios::utils::StepByAdapter< Iter >::begin ( ) const

inlineconstexprnoexcept

Examples

/home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/utils/functional_adapters.hpp.

Definition at line 1411 of file functional_adapters.hpp.

                                                                                                                  {
    return *this;
  }

end()

template<typename Iter >

constexpr StepByAdapter helios::utils::StepByAdapter< Iter >::end ( ) const

inlineconstexprnoexcept

Examples

/home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/utils/functional_adapters.hpp.

Definition at line 1415 of file functional_adapters.hpp.

                                                                                               {
    return {end_, end_, step_};
  }

operator!=()

template<typename Iter >

constexpr bool helios::utils::StepByAdapter< Iter >::operator!= ( const StepByAdapter< Iter > &  other ) const

inlineconstexprnoexcept

Examples

/home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/utils/functional_adapters.hpp.

Definition at line 1406 of file functional_adapters.hpp.

                                                                                                   {
    return !(*this == other);
  }

operator*()

template<typename Iter >

constexpr value_type helios::utils::StepByAdapter< Iter >::operator* ( ) const

inlineconstexprnoexcept

Examples

/home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/utils/functional_adapters.hpp.

Definition at line 1397 of file functional_adapters.hpp.

                                                                                                      {
    return *current_;
  }

operator++() [1/2]

template<typename Iter >
requires StepByAdapterRequirements<Iter>

constexpr auto helios::utils::StepByAdapter< Iter >::operator++ ( )

constexprnoexcept

Examples

/home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/utils/functional_adapters.hpp.

Definition at line 1429 of file functional_adapters.hpp.

                      {
  for (size_t i = 0; i < step_ && current_ != end_; ++i) {
    ++current_;
  }
  return *this;
}

operator++() [2/2]

template<typename Iter >
requires StepByAdapterRequirements<Iter>

constexpr auto helios::utils::StepByAdapter< Iter >::operator++ ( int  )

constexprnoexcept

Definition at line 1440 of file functional_adapters.hpp.

                     {
  auto temp = *this;
  ++(*this);
  return temp;
}

operator=() [1/2]

template<typename Iter >

constexpr StepByAdapter & helios::utils::StepByAdapter< Iter >::operator= ( const StepByAdapter< Iter > &  )

constexprdefault

Examples

/home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/utils/functional_adapters.hpp.

operator=() [2/2]

template<typename Iter >

constexpr StepByAdapter & helios::utils::StepByAdapter< Iter >::operator= ( StepByAdapter< Iter > &&  )

constexprdefault

operator==()

template<typename Iter >

constexpr bool helios::utils::StepByAdapter< Iter >::operator== ( const StepByAdapter< Iter > &  other ) const

inlineconstexprnoexcept

Examples

/home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/utils/functional_adapters.hpp.

Definition at line 1401 of file functional_adapters.hpp.

                                                                                 {
    return current_ == other.current_;
  }