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

#include <functional_adapters.hpp>

Inheritance diagram for helios::utils::TakeAdapter< 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	TakeAdapter (Iter begin, Iter end, size_t count) noexcept(std::is_nothrow_move_constructible_v< Iter > &&std::is_nothrow_copy_constructible_v< Iter >)
	Constructs a take adapter with the given iterator range and count.
constexpr	TakeAdapter (const TakeAdapter &) noexcept(std::is_nothrow_copy_constructible_v< Iter >)=default
constexpr	TakeAdapter (TakeAdapter &&) noexcept(std::is_nothrow_move_constructible_v< Iter >)=default
constexpr	~TakeAdapter () noexcept(std::is_nothrow_destructible_v< Iter >)=default
constexpr TakeAdapter &	operator= (const TakeAdapter &) noexcept(std::is_nothrow_copy_assignable_v< Iter >)=default
constexpr TakeAdapter &	operator= (TakeAdapter &&) noexcept(std::is_nothrow_move_assignable_v< Iter >)=default
constexpr TakeAdapter &	operator++ () noexcept(noexcept(++std::declval< Iter & >()))
constexpr TakeAdapter	operator++ (int) noexcept(std::is_nothrow_copy_constructible_v< TakeAdapter > &&noexcept(++std::declval< TakeAdapter & >()))
constexpr value_type	operator* () const noexcept(noexcept(*std::declval< const Iter & >()))
constexpr bool	operator== (const TakeAdapter &other) const noexcept(noexcept(std::declval< const Iter & >()==std::declval< const Iter & >()))
constexpr bool	operator!= (const TakeAdapter &other) const noexcept(noexcept(std::declval< const TakeAdapter & >()==std::declval< const TakeAdapter & >()))
constexpr bool	IsAtEnd () const noexcept(noexcept(std::declval< const Iter & >()==std::declval< const Iter & >()))
	Checks if the iterator has reached the end.
constexpr TakeAdapter	begin () const noexcept(std::is_nothrow_copy_constructible_v< TakeAdapter >)
constexpr TakeAdapter	end () const noexcept(std::is_nothrow_copy_constructible_v< TakeAdapter >)
Public Member Functions inherited from helios::utils::FunctionalAdapterBase< TakeAdapter< Iter > >
constexpr auto	Filter (Pred predicate) const noexcept(noexcept(FilterAdapter< TakeAdapter< 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< TakeAdapter< 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< TakeAdapter< 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< TakeAdapter< Iter > >(GetDerived().begin(), GetDerived().end(), count)))
	Skips the first count elements.
constexpr auto	TakeWhile (Pred predicate) const noexcept(noexcept(TakeWhileAdapter< TakeAdapter< 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< TakeAdapter< Iter >, Pred >(GetDerived().begin(), GetDerived().end(), std::move(predicate))))
	Skips elements while a predicate is true.
constexpr auto	Enumerate () const noexcept(noexcept(EnumerateAdapter< TakeAdapter< Iter > >(GetDerived().begin(), GetDerived().end())))
	Adds an index to each element.
constexpr auto	Inspect (Func inspector) const noexcept(noexcept(InspectAdapter< TakeAdapter< 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< TakeAdapter< Iter > >(GetDerived().begin(), GetDerived().end(), step)))
	Takes every Nth element.
constexpr auto	Chain (OtherIter begin, OtherIter end) const noexcept(noexcept(ChainAdapter< TakeAdapter< 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< TakeAdapter< Iter > >(GetDerived().begin(), GetDerived().end())))
	Reverses the order of elements.
constexpr auto	Slide (size_t window_size) const noexcept(noexcept(SlideAdapter< TakeAdapter< Iter > >(GetDerived().begin(), GetDerived().end(), window_size)))
	Creates sliding windows over elements.
constexpr auto	Stride (size_t stride) const noexcept(noexcept(StrideAdapter< TakeAdapter< Iter > >(GetDerived().begin(), GetDerived().end(), stride)))
	Takes every Nth element with stride.
constexpr auto	Zip (OtherIter begin, OtherIter end) const noexcept(noexcept(ZipAdapter< TakeAdapter< 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< TakeAdapter< Iter > >
constexpr TakeAdapter< Iter > &	GetDerived () noexcept
	Gets reference to derived class instance.
constexpr const TakeAdapter< Iter > &	GetDerived () const noexcept
	Gets const reference to derived class instance.

Detailed Description

template<typename Iter>
requires TakeAdapterRequirements<Iter>
class helios::utils::TakeAdapter< Iter >

Definition at line 662 of file functional_adapters.hpp.

Member Typedef Documentation

difference_type

template<typename Iter >

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

iterator_category

template<typename Iter >

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

pointer

template<typename Iter >

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

Examples

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

Definition at line 667 of file functional_adapters.hpp.

reference

template<typename Iter >

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

Examples

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

Definition at line 668 of file functional_adapters.hpp.

value_type

template<typename Iter >

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

Constructor & Destructor Documentation

TakeAdapter() [1/3]

template<typename Iter >

constexpr helios::utils::TakeAdapter< Iter >::TakeAdapter ( Iter  begin, Iter  end, size_t  count  )

inlineconstexprnoexcept

Constructs a take adapter with the given iterator range and count.

Parameters

begin	Start of the iterator range
end	End of the iterator range
count	Maximum number of elements to yield

Definition at line 676 of file functional_adapters.hpp.

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

TakeAdapter() [2/3]

template<typename Iter >

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

constexprdefaultnoexcept

TakeAdapter() [3/3]

template<typename Iter >

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

constexprdefaultnoexcept

~TakeAdapter()

template<typename Iter >

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

constexprdefaultnoexcept

Examples

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

Member Function Documentation

begin()

template<typename Iter >

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

inlineconstexprnoexcept

Examples

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

Definition at line 712 of file functional_adapters.hpp.

                                                                                                              {
    return *this;
  }

end()

template<typename Iter >
requires TakeAdapterRequirements<Iter>

constexpr auto helios::utils::TakeAdapter< Iter >::end ( ) const

constexprnoexcept

Examples

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

Definition at line 762 of file functional_adapters.hpp.

                   {
  auto end_iter = *this;
  end_iter.remaining_ = 0;
  return end_iter;
}

IsAtEnd()

template<typename Iter >

constexpr bool helios::utils::TakeAdapter< Iter >::IsAtEnd ( ) const

inlineconstexprnoexcept

Checks if the iterator has reached the end.

Returns

True if at end, false otherwise

Examples

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

Definition at line 707 of file functional_adapters.hpp.

                                                                                 {
    return remaining_ == 0 || current_ == end_;
  }

operator!=()

template<typename Iter >

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

inlineconstexprnoexcept

Examples

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

Definition at line 698 of file functional_adapters.hpp.

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

operator*()

template<typename Iter >

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

inlineconstexprnoexcept

Examples

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

Definition at line 691 of file functional_adapters.hpp.

                                                                                                      {
    return *current_;
  }

operator++() [1/2]

template<typename Iter >
requires TakeAdapterRequirements<Iter>

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

constexprnoexcept

Examples

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

Definition at line 728 of file functional_adapters.hpp.

                                                                                                       {
  if (remaining_ > 0 && current_ != end_) {
    ++current_;
    --remaining_;
  }
  return *this;
}

operator++() [2/2]

template<typename Iter >
requires TakeAdapterRequirements<Iter>

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

constexprnoexcept

Definition at line 738 of file functional_adapters.hpp.

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

operator=() [1/2]

template<typename Iter >

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

constexprdefaultnoexcept

Examples

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

operator=() [2/2]

template<typename Iter >

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

constexprdefaultnoexcept

operator==()

template<typename Iter >
requires TakeAdapterRequirements<Iter>

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

constexprnoexcept

Examples

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

Definition at line 747 of file functional_adapters.hpp.

                                                                               {
  // Both are at end if either has no remaining elements or both iterators are at end
  const bool this_at_end = (remaining_ == 0) || (current_ == end_);
  const bool other_at_end = (other.remaining_ == 0) || (other.current_ == other.end_);
 
  if (this_at_end && other_at_end) {
    return true;
  }
 
  return (current_ == other.current_) && (remaining_ == other.remaining_);
}