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

Adapter that yields every Nth element from the range. More...

#include <functional_adapters.hpp>

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

Public Types
using	iterator_concept = details::adapter_iterator_concept_t<Iter>
using	iterator_category = details::adapter_iterator_category_t<Iter>
using	value_type = std::iter_value_t<Iter>
using	reference = value_type
using	pointer = void
using	difference_type = std::iter_difference_t<Iter>

Public Member Functions
constexpr	StrideAdapter (Iter begin, Iter end, size_t stride) noexcept(std::is_nothrow_move_constructible_v< Iter > &&std::is_nothrow_copy_constructible_v< Iter >)
	Constructs a stride adapter.
template<ExternalRange R> requires StrideAdapterRequirements<std::ranges::iterator_t<R>>
constexpr	StrideAdapter (R &range, size_t stride) noexcept(noexcept(StrideAdapter(std::ranges::begin(range), std::ranges::end(range), stride)))
	Constructs a stride adapter from a range and a stride.
template<ExternalRange R> requires StrideAdapterRequirements<std::ranges::iterator_t<const R>>
constexpr	StrideAdapter (const R &range, size_t stride) noexcept(noexcept(StrideAdapter(std::ranges::cbegin(range), std::ranges::cend(range), stride)))
	Constructs a stride adapter from a const range and a stride.
constexpr	StrideAdapter (const StrideAdapter &) noexcept(std::is_nothrow_copy_constructible_v< Iter >)=default
constexpr	StrideAdapter (StrideAdapter &&) noexcept(std::is_nothrow_move_constructible_v< Iter >)=default
constexpr	~StrideAdapter () noexcept(std::is_nothrow_destructible_v< Iter >)=default
constexpr StrideAdapter &	operator= (const StrideAdapter &) noexcept(std::is_nothrow_copy_assignable_v< Iter >)=default
constexpr StrideAdapter &	operator= (StrideAdapter &&) noexcept(std::is_nothrow_move_assignable_v< Iter >)=default
constexpr StrideAdapter &	operator++ () noexcept(noexcept(std::declval< Iter & >() !=std::declval< Iter & >()) &&noexcept(++std::declval< Iter & >()))
constexpr StrideAdapter	operator++ (int) noexcept(std::is_nothrow_copy_constructible_v< StrideAdapter > &&noexcept(++std::declval< StrideAdapter & >()))
constexpr reference	operator* () const noexcept(noexcept(*std::declval< const Iter & >()))
pointer	operator-> () const =delete
constexpr bool	operator== (const StrideAdapter &other) const noexcept(noexcept(std::declval< const Iter & >()==std::declval< const Iter & >()))
constexpr bool	operator!= (const StrideAdapter &other) const noexcept(noexcept(std::declval< const Iter & >() !=std::declval< const Iter & >()))
constexpr StrideAdapter	begin () const noexcept(std::is_nothrow_constructible_v< StrideAdapter, const Iter &, const Iter &, size_t >)
constexpr StrideAdapter	end () const noexcept(std::is_nothrow_copy_constructible_v< StrideAdapter > &&std::is_nothrow_copy_assignable_v< Iter >)
Public Member Functions inherited from helios::utils::FunctionalAdapterBase< StrideAdapter< Iter > >
constexpr auto	Filter (Pred predicate) const noexcept(noexcept(FilterAdapter< StrideAdapter< 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< StrideAdapter< 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< StrideAdapter< 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< StrideAdapter< Iter > >(GetDerived().begin(), GetDerived().end(), count)))
	Skips the first count elements.
constexpr auto	TakeWhile (Pred predicate) const noexcept(noexcept(TakeWhileAdapter< StrideAdapter< 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< StrideAdapter< Iter >, Pred >(GetDerived().begin(), GetDerived().end(), std::move(predicate))))
	Skips elements while a predicate is true.
constexpr auto	Enumerate () const noexcept(noexcept(EnumerateAdapter< StrideAdapter< Iter > >(GetDerived().begin(), GetDerived().end())))
	Adds an index to each element.
constexpr auto	Inspect (Func inspector) const noexcept(noexcept(InspectAdapter< StrideAdapter< 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< StrideAdapter< Iter > >(GetDerived().begin(), GetDerived().end(), step)))
	Takes every Nth element.
constexpr auto	Chain (OtherIter begin, OtherIter end) const noexcept(noexcept(ChainAdapter< StrideAdapter< Iter >, OtherIter >(GetDerived().begin(), GetDerived().end(), std::move(begin), std::move(end))))
	Chains another range after this one.
constexpr auto	Reverse () const noexcept(noexcept(ReverseAdapter< StrideAdapter< Iter > >(GetDerived().begin(), GetDerived().end())))
	Reverses the order of elements.
constexpr auto	Slide (size_t window_size) const noexcept(noexcept(SlideAdapter< StrideAdapter< Iter > >(GetDerived().begin(), GetDerived().end(), window_size)))
	Creates sliding windows over elements.
constexpr auto	Stride (size_t stride) const noexcept(noexcept(StrideAdapter< Derived >(GetDerived().begin(), GetDerived().end(), stride)))
	Takes every Nth element with stride.
constexpr auto	Zip (OtherIter begin, OtherIter end) const noexcept(noexcept(ZipAdapter< StrideAdapter< Iter >, OtherIter >(GetDerived().begin(), GetDerived().end(), std::move(begin), std::move(end))))
	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 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	PartitionWith (const Pred &predicate, Allocator allocator) const
	Terminal operation: partitions elements with a custom allocator.
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	GroupByWith (const KeyFunc &key_func, MapAllocator map_allocator, ValueAllocator value_allocator) const
	Terminal operation: groups elements by key with custom allocators.
constexpr auto	Collect () const
	Terminal operation: collects all elements into a vector.
constexpr auto	CollectWith (Allocator allocator={}) const
	Terminal operation: collects all elements into a vector with a custom allocator.
constexpr void	Into (OutIt out) const
	Terminal operation: writes all elements into an output iterator.
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.

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

Detailed Description

template<typename Iter>
requires StrideAdapterRequirements<Iter>
class helios::utils::StrideAdapter< Iter >

Adapter that yields every Nth element from the range.

Similar to StepBy but with different semantics - takes stride, not step.

Template Parameters

Iter	Type of the underlying iterator

std::vector<int> data = {1, 2, 3, 4, 5, 6, 7, 8, 9};
auto strided = StrideAdapterFromRange(data, 3);
// Yields: 1, 4, 7
for (int val : strided) {
  std::cout << val << " ";
}

Definition at line 3226 of file functional_adapters.hpp.

Member Typedef Documentation

difference_type

template<typename Iter>

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

Definition at line 3233 of file functional_adapters.hpp.

iterator_category

template<typename Iter>

using helios::utils::StrideAdapter< Iter >::iterator_category = details::adapter_iterator_category_t<Iter>

Definition at line 3229 of file functional_adapters.hpp.

iterator_concept

template<typename Iter>

using helios::utils::StrideAdapter< Iter >::iterator_concept = details::adapter_iterator_concept_t<Iter>

Definition at line 3228 of file functional_adapters.hpp.

pointer

template<typename Iter>

using helios::utils::StrideAdapter< Iter >::pointer = void

Definition at line 3232 of file functional_adapters.hpp.

reference

template<typename Iter>

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

Definition at line 3231 of file functional_adapters.hpp.

value_type

template<typename Iter>

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

Definition at line 3230 of file functional_adapters.hpp.

Constructor & Destructor Documentation

StrideAdapter() [1/5]

template<typename Iter>

helios::utils::StrideAdapter< Iter >::StrideAdapter ( Iter begin, Iter end, size_t stride )

inlineconstexprnoexcept

Constructs a stride adapter.

Parameters

begin	Iterator to the beginning of the range
end	Iterator to the end of the range
stride	Number of elements to skip between yields (1 = every element, 2 = every other, etc.)

Warning

stride must be greater than 0

Definition at line 3243 of file functional_adapters.hpp.

StrideAdapter() [2/5]

template<typename Iter>

template<ExternalRange R>
requires StrideAdapterRequirements<std::ranges::iterator_t<R>>

helios::utils::StrideAdapter< Iter >::StrideAdapter ( R & range, size_t stride )

inlineconstexprnoexcept

Constructs a stride adapter from a range and a stride.

Template Parameters

R	The type of the range

Parameters

range	The range to adapt
stride	Number of elements to skip between yields (1 = every element, 2 = every other, etc.)

Warning

stride must be greater than 0

Definition at line 3261 of file functional_adapters.hpp.

StrideAdapter() [3/5]

template<typename Iter>

template<ExternalRange R>
requires StrideAdapterRequirements<std::ranges::iterator_t<const R>>

helios::utils::StrideAdapter< Iter >::StrideAdapter ( const R & range, size_t stride )

inlineconstexprnoexcept

Constructs a stride adapter from a const range and a stride.

Template Parameters

R	The type of the range

Parameters

range	The range to adapt
stride	Number of elements to skip between yields (1 = every element, 2 = every other, etc.)

Warning

stride must be greater than 0

Definition at line 3277 of file functional_adapters.hpp.

StrideAdapter() [4/5]

template<typename Iter>

helios::utils::StrideAdapter< Iter >::StrideAdapter ( const StrideAdapter< Iter > & ) const

constexprdefaultnoexcept

StrideAdapter() [5/5]

template<typename Iter>

helios::utils::StrideAdapter< Iter >::StrideAdapter ( StrideAdapter< Iter > && ) const

constexprdefaultnoexcept

~StrideAdapter()

template<typename Iter>

helios::utils::StrideAdapter< Iter >::~StrideAdapter ( )

constexprdefaultnoexcept

Member Function Documentation

begin()

template<typename Iter>

StrideAdapter helios::utils::StrideAdapter< Iter >::begin ( ) const

inlinenodiscardconstexprnoexcept

Definition at line 3321 of file functional_adapters.hpp.

end()

template<typename Iter>
requires StrideAdapterRequirements<Iter>

auto helios::utils::StrideAdapter< Iter >::end ( ) const

nodiscardconstexprnoexcept

Definition at line 3370 of file functional_adapters.hpp.

operator!=()

template<typename Iter>

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

inlinenodiscardconstexprnoexcept

Definition at line 3315 of file functional_adapters.hpp.

operator*()

template<typename Iter>

reference helios::utils::StrideAdapter< Iter >::operator* ( ) const

inlinenodiscardconstexprnoexcept

Definition at line 3302 of file functional_adapters.hpp.

operator++() [1/2]

template<typename Iter>
requires StrideAdapterRequirements<Iter>

auto helios::utils::StrideAdapter< Iter >::operator++ ( )

constexprnoexcept

Definition at line 3349 of file functional_adapters.hpp.

operator++() [2/2]

template<typename Iter>
requires StrideAdapterRequirements<Iter>

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

nodiscardconstexprnoexcept

Definition at line 3360 of file functional_adapters.hpp.

operator->()

template<typename Iter>

pointer helios::utils::StrideAdapter< Iter >::operator-> ( ) const

delete

operator=() [1/2]

template<typename Iter>

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

constexprdefaultnoexcept

operator=() [2/2]

template<typename Iter>

StrideAdapter & helios::utils::StrideAdapter< Iter >::operator= ( StrideAdapter< Iter > && )

constexprdefaultnoexcept

operator==()

template<typename Iter>

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

inlinenodiscardconstexprnoexcept

Definition at line 3309 of file functional_adapters.hpp.