Helios Engine
A modular ECS based data-oriented C++23 game engine framework
Loading...
Searching...
No Matches
helios::utils::SkipAdapter< Iter > Class Template Reference

Iterator adapter that skips the first N elements. More...

#include <functional_adapters.hpp>

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

Detailed Description

template<typename Iter>
requires SkipAdapterRequirements<Iter>
class helios::utils::SkipAdapter< Iter >

Iterator adapter that skips the first N elements.

This adapter skips over the first N elements of the underlying iterator and yields all remaining elements. If the iterator has fewer than N elements, the result will be empty.

Note
This adapter maintains forward iterator semantics.
The adapter is constexpr-compatible for compile-time evaluation.
Template Parameters
IterUnderlying iterator type that satisfies IteratorLike concept
// Skip the first 10 entities
auto remaining = query.Skip(10);

Definition at line 1037 of file functional_adapters.hpp.

Member Typedef Documentation

◆ difference_type

template<typename Iter>
using helios::utils::SkipAdapter< Iter >::difference_type = std::iter_difference_t<Iter>

Definition at line 1044 of file functional_adapters.hpp.

◆ iterator_category

template<typename Iter>
using helios::utils::SkipAdapter< Iter >::iterator_category = details::adapter_iterator_category_t<Iter>

Definition at line 1040 of file functional_adapters.hpp.

◆ iterator_concept

template<typename Iter>
using helios::utils::SkipAdapter< Iter >::iterator_concept = details::adapter_iterator_concept_t<Iter>

Definition at line 1039 of file functional_adapters.hpp.

◆ pointer

template<typename Iter>
using helios::utils::SkipAdapter< Iter >::pointer = void

Definition at line 1043 of file functional_adapters.hpp.

◆ reference

template<typename Iter>
using helios::utils::SkipAdapter< Iter >::reference = value_type

Definition at line 1042 of file functional_adapters.hpp.

◆ value_type

template<typename Iter>
using helios::utils::SkipAdapter< Iter >::value_type = std::iter_value_t<Iter>

Definition at line 1041 of file functional_adapters.hpp.

Constructor & Destructor Documentation

◆ SkipAdapter() [1/5]

template<typename Iter>
requires SkipAdapterRequirements<Iter>
helios::utils::SkipAdapter< Iter >::SkipAdapter ( Iter begin,
Iter end,
size_t count )
constexprnoexcept

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

Parameters
beginStart of the iterator range
endEnd of the iterator range
countNumber of elements to skip

Definition at line 1143 of file functional_adapters.hpp.

◆ SkipAdapter() [2/5]

template<typename Iter>
template<ExternalRange R>
requires SkipAdapterRequirements<std::ranges::iterator_t<R>>
helios::utils::SkipAdapter< Iter >::SkipAdapter ( R & range,
size_t count )
inlineconstexprnoexcept

Constructs a skip adapter from a range and count.

Template Parameters
RThe type of the input range
Parameters
rangeThe input range to adapt
countNumber of elements to skip

Definition at line 1064 of file functional_adapters.hpp.

◆ SkipAdapter() [3/5]

template<typename Iter>
template<ExternalRange R>
requires SkipAdapterRequirements<std::ranges::iterator_t<const R>>
helios::utils::SkipAdapter< Iter >::SkipAdapter ( const R & range,
size_t count )
inlineconstexprnoexcept

Constructs a skip adapter from a const range and count.

Template Parameters
RThe type of the input range
Parameters
rangeThe input range to adapt
countNumber of elements to skip

Definition at line 1077 of file functional_adapters.hpp.

◆ SkipAdapter() [4/5]

template<typename Iter>
helios::utils::SkipAdapter< Iter >::SkipAdapter ( const SkipAdapter< Iter > & ) const
constexprdefaultnoexcept

◆ SkipAdapter() [5/5]

template<typename Iter>
helios::utils::SkipAdapter< Iter >::SkipAdapter ( SkipAdapter< Iter > && ) const
constexprdefaultnoexcept

◆ ~SkipAdapter()

template<typename Iter>
helios::utils::SkipAdapter< Iter >::~SkipAdapter ( )
constexprdefaultnoexcept

Member Function Documentation

◆ begin()

template<typename Iter>
SkipAdapter helios::utils::SkipAdapter< Iter >::begin ( ) const
inlinenodiscardconstexprnoexcept

Definition at line 1119 of file functional_adapters.hpp.

◆ end()

template<typename Iter>
SkipAdapter helios::utils::SkipAdapter< Iter >::end ( ) const
inlinenodiscardconstexprnoexcept

Definition at line 1124 of file functional_adapters.hpp.

◆ operator!=()

template<typename Iter>
bool helios::utils::SkipAdapter< Iter >::operator!= ( const SkipAdapter< Iter > & other) const
inlinenodiscardconstexprnoexcept

Definition at line 1113 of file functional_adapters.hpp.

◆ operator*()

template<typename Iter>
reference helios::utils::SkipAdapter< Iter >::operator* ( ) const
inlinenodiscardconstexprnoexcept

Definition at line 1100 of file functional_adapters.hpp.

◆ operator++() [1/2]

template<typename Iter>
requires SkipAdapterRequirements<Iter>
auto helios::utils::SkipAdapter< Iter >::operator++ ( )
constexprnoexcept

Definition at line 1155 of file functional_adapters.hpp.

◆ operator++() [2/2]

template<typename Iter>
requires SkipAdapterRequirements<Iter>
auto helios::utils::SkipAdapter< Iter >::operator++ ( int )
nodiscardconstexprnoexcept

Definition at line 1163 of file functional_adapters.hpp.

◆ operator->()

template<typename Iter>
pointer helios::utils::SkipAdapter< Iter >::operator-> ( ) const
delete

◆ operator=() [1/2]

template<typename Iter>
SkipAdapter & helios::utils::SkipAdapter< Iter >::operator= ( const SkipAdapter< Iter > & )
constexprdefaultnoexcept

◆ operator=() [2/2]

template<typename Iter>
SkipAdapter & helios::utils::SkipAdapter< Iter >::operator= ( SkipAdapter< Iter > && )
constexprdefaultnoexcept

◆ operator==()

template<typename Iter>
bool helios::utils::SkipAdapter< Iter >::operator== ( const SkipAdapter< Iter > & other) const
inlinenodiscardconstexprnoexcept

Definition at line 1107 of file functional_adapters.hpp.