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

#include <functional_adapters.hpp>

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

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

Public Member Functions
constexpr	EnumerateAdapter (Iter begin, Iter end) noexcept(std::is_nothrow_move_constructible_v< Iter > &&std::is_nothrow_copy_constructible_v< Iter >)
	Constructs an enumerate adapter with the given iterator range.
constexpr	EnumerateAdapter (const EnumerateAdapter &)=default
constexpr	EnumerateAdapter (EnumerateAdapter &&)=default
constexpr	~EnumerateAdapter ()=default
constexpr EnumerateAdapter &	operator= (const EnumerateAdapter &)=default
constexpr EnumerateAdapter &	operator= (EnumerateAdapter &&)=default
constexpr EnumerateAdapter &	operator++ () noexcept(noexcept(++std::declval< Iter & >()))
constexpr EnumerateAdapter	operator++ (int) noexcept(std::is_nothrow_copy_constructible_v< EnumerateAdapter > &&noexcept(++std::declval< EnumerateAdapter & >()))
constexpr value_type	operator* () const
constexpr bool	operator== (const EnumerateAdapter &other) const noexcept(noexcept(std::declval< const Iter & >()==std::declval< const Iter & >()))
constexpr bool	operator!= (const EnumerateAdapter &other) const noexcept(noexcept(std::declval< const EnumerateAdapter & >()==std::declval< const EnumerateAdapter & >()))
constexpr EnumerateAdapter	begin () const noexcept(std::is_nothrow_copy_constructible_v< EnumerateAdapter >)
constexpr EnumerateAdapter	end () const noexcept(std::is_nothrow_constructible_v< EnumerateAdapter, const Iter &, const Iter & >)
Public Member Functions inherited from helios::utils::FunctionalAdapterBase< EnumerateAdapter< Iter > >
constexpr auto	Filter (Pred predicate) const noexcept(noexcept(FilterAdapter< EnumerateAdapter< Iter >, Pred >(GetDerived().begin(), GetDerived().end(), std::move(predicate))))
	Chains another filter operation on top of this iterator.
constexpr auto	Map (Func transform) const noexcept(noexcept(MapAdapter< EnumerateAdapter< Iter >, Func >(GetDerived().begin(), GetDerived().end(), std::move(transform))))
	Transforms each element using the given function.
constexpr auto	Take (size_t count) const noexcept(noexcept(TakeAdapter< EnumerateAdapter< Iter > >(GetDerived().begin(), GetDerived().end(), count)))
	Limits the number of elements to at most count.
constexpr auto	Skip (size_t count) const noexcept(noexcept(SkipAdapter< EnumerateAdapter< Iter > >(GetDerived().begin(), GetDerived().end(), count)))
	Skips the first count elements.
constexpr auto	TakeWhile (Pred predicate) const noexcept(noexcept(TakeWhileAdapter< EnumerateAdapter< Iter >, Pred >(GetDerived().begin(), GetDerived().end(), std::move(predicate))))
	Takes elements while a predicate is true.
constexpr auto	SkipWhile (Pred predicate) const noexcept(noexcept(SkipWhileAdapter< EnumerateAdapter< Iter >, Pred >(GetDerived().begin(), GetDerived().end(), std::move(predicate))))
	Skips elements while a predicate is true.
constexpr auto	Enumerate () const noexcept(noexcept(EnumerateAdapter< EnumerateAdapter< Iter > >(GetDerived().begin(), GetDerived().end())))
	Adds an index to each element.
constexpr auto	Inspect (Func inspector) const noexcept(noexcept(InspectAdapter< EnumerateAdapter< Iter >, Func >(GetDerived().begin(), GetDerived().end(), std::move(inspector))))
	Observes each element without modifying it.
constexpr auto	StepBy (size_t step) const noexcept(noexcept(StepByAdapter< EnumerateAdapter< Iter > >(GetDerived().begin(), GetDerived().end(), step)))
	Takes every Nth element.
constexpr auto	Chain (OtherIter begin, OtherIter end) const noexcept(noexcept(ChainAdapter< EnumerateAdapter< Iter >, OtherIter >(GetDerived().begin(), GetDerived().end(), std::move(begin), std::move(end))))
	Chains another range after this one.
constexpr auto	Chain (R &range) const noexcept(noexcept(ChainAdapterFromRange(GetDerived(), range)))
	Chains another range after this one.
constexpr auto	Chain (const R &range) const noexcept(noexcept(ChainAdapterFromRange(GetDerived(), range)))
	Chains another range after this one.
constexpr auto	Reverse () const noexcept(noexcept(ReverseAdapter< EnumerateAdapter< Iter > >(GetDerived().begin(), GetDerived().end())))
	Reverses the order of elements.
constexpr auto	Slide (size_t window_size) const noexcept(noexcept(SlideAdapter< EnumerateAdapter< Iter > >(GetDerived().begin(), GetDerived().end(), window_size)))
	Creates sliding windows over elements.
constexpr auto	Stride (size_t stride) const noexcept(noexcept(StrideAdapter< EnumerateAdapter< Iter > >(GetDerived().begin(), GetDerived().end(), stride)))
	Takes every Nth element with stride.
constexpr auto	Zip (OtherIter begin, OtherIter end) const noexcept(noexcept(ZipAdapter< EnumerateAdapter< Iter >, OtherIter >(GetDerived().begin(), GetDerived().end(), std::move(begin), std::move(end))))
	Zips another range with this one.
constexpr auto	Zip (R &range) const noexcept(noexcept(ZipAdapterFromRange(GetDerived(), range)))
	Zips another range with this one.
constexpr auto	Zip (const R &range) const noexcept(noexcept(ZipAdapterFromRange(GetDerived(), range)))
	Zips another range with this one.
constexpr void	ForEach (const Action &action) const
	Terminal operation: applies an action to each element.
constexpr T	Fold (T init, const Folder &folder) const
	Terminal operation: reduces elements to a single value using a folder function.
constexpr bool	Any (const Pred &predicate) const
	Terminal operation: checks if any element satisfies a predicate.
constexpr bool	All (const Pred &predicate) const
	Terminal operation: checks if all elements satisfy a predicate.
constexpr bool	None (const Pred &predicate) const
	Terminal operation: checks if no elements satisfy a predicate.
constexpr auto	Find (const Pred &predicate) const
	Terminal operation: finds the first element satisfying a predicate.
constexpr size_t	CountIf (const Pred &predicate) const
	Terminal operation: counts elements satisfying a predicate.
constexpr auto	Partition (const Pred &predicate) const
	Terminal operation: partitions elements into two groups based on a predicate.
constexpr auto	MaxBy (const KeyFunc &key_func) const
	Terminal operation: finds the element with the maximum value according to a key function.
constexpr auto	MinBy (const KeyFunc &key_func) const
	Terminal operation: finds the element with the minimum value according to a key function.
constexpr auto	GroupBy (const KeyFunc &key_func) const
	Terminal operation: groups elements by a key function.
constexpr auto	Collect () const
	Terminal operation: collects all elements into a vector.
constexpr void	Into (OutIt out) const

Additional Inherited Members
Protected Member Functions inherited from helios::utils::FunctionalAdapterBase< EnumerateAdapter< Iter > >
constexpr EnumerateAdapter< Iter > &	GetDerived () noexcept
	Gets reference to derived class instance.
constexpr const EnumerateAdapter< Iter > &	GetDerived () const noexcept
	Gets const reference to derived class instance.

Detailed Description

template<typename Iter>
requires EnumerateAdapterRequirements<Iter>
class helios::utils::EnumerateAdapter< Iter >

Definition at line 1160 of file functional_adapters.hpp.

Member Typedef Documentation

difference_type

template<typename Iter >

using helios::utils::EnumerateAdapter< 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 1175 of file functional_adapters.hpp.

iterator_category

template<typename Iter >

using helios::utils::EnumerateAdapter< 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 1173 of file functional_adapters.hpp.

pointer

template<typename Iter >

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

Examples

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

Definition at line 1176 of file functional_adapters.hpp.

reference

template<typename Iter >

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

Examples

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

Definition at line 1177 of file functional_adapters.hpp.

value_type

template<typename Iter >

using helios::utils::EnumerateAdapter< Iter >::value_type = typename MakeEnumeratedValue<std::iter_value_t<Iter> >::type

Examples

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

Definition at line 1174 of file functional_adapters.hpp.

Constructor & Destructor Documentation

EnumerateAdapter() [1/3]

template<typename Iter >

constexpr helios::utils::EnumerateAdapter< Iter >::EnumerateAdapter ( Iter  begin, Iter  end  )

inlineconstexprnoexcept

Constructs an enumerate adapter with the given iterator range.

Parameters

begin	Start of the iterator range
end	End of the iterator range

Definition at line 1184 of file functional_adapters.hpp.

      : begin_(std::move(begin)), current_(begin_), end_(std::move(end)) {}

EnumerateAdapter() [2/3]

template<typename Iter >

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

constexprdefault

EnumerateAdapter() [3/3]

template<typename Iter >

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

constexprdefault

~EnumerateAdapter()

template<typename Iter >

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

constexprdefault

Examples

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

Member Function Documentation

begin()

template<typename Iter >

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

inlineconstexprnoexcept

Examples

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

Definition at line 1211 of file functional_adapters.hpp.

                                                                     {
    return *this;
  }

end()

template<typename Iter >

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

inlineconstexprnoexcept

Examples

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

Definition at line 1216 of file functional_adapters.hpp.

                                                                                          {
    return {end_, end_};
  }

operator!=()

template<typename Iter >

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

inlineconstexprnoexcept

Examples

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

Definition at line 1206 of file functional_adapters.hpp.

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

operator*()

template<typename Iter >
requires EnumerateAdapterRequirements<Iter>

constexpr auto helios::utils::EnumerateAdapter< Iter >::operator* ( ) const

constexpr

Examples

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

Definition at line 1248 of file functional_adapters.hpp.

                                                                     {
  auto value = *current_;
  if constexpr (details::TupleLike<decltype(value)>) {
    return std::tuple_cat(std::tuple{index_}, value);
  } else {
    return std::tuple{index_, value};
  }
}

operator++() [1/2]

template<typename Iter >
requires EnumerateAdapterRequirements<Iter>

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

constexprnoexcept

Examples

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

Definition at line 1230 of file functional_adapters.hpp.

                                                                                                                 {
  ++current_;
  ++index_;
  return *this;
}

operator++() [2/2]

template<typename Iter >
requires EnumerateAdapterRequirements<Iter>

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

constexprnoexcept

Definition at line 1238 of file functional_adapters.hpp.

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

operator=() [1/2]

template<typename Iter >

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

constexprdefault

Examples

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

operator=() [2/2]

template<typename Iter >

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

constexprdefault

operator==()

template<typename Iter >

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

inlineconstexprnoexcept

Examples

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

Definition at line 1201 of file functional_adapters.hpp.

                                                                                 {
    return current_ == other.current_;
  }