helios::utils::FilterAdapter< Iter, Pred > Class Template Reference

#include <functional_adapters.hpp>

Inheritance diagram for helios::utils::FilterAdapter< Iter, Pred >:

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	FilterAdapter (Iter begin, Iter end, Pred predicate) noexcept(std::is_nothrow_copy_constructible_v< Iter > &&std::is_nothrow_move_constructible_v< Iter > &&std::is_nothrow_move_constructible_v< Pred > &&noexcept(AdvanceToValid()))
	Constructs a filter adapter with the given iterator range and predicate.
constexpr	FilterAdapter (const FilterAdapter &) noexcept(std::is_nothrow_copy_constructible_v< Iter > &&std::is_nothrow_copy_constructible_v< Pred >)=default
constexpr	FilterAdapter (FilterAdapter &&) noexcept(std::is_nothrow_move_constructible_v< Iter > &&std::is_nothrow_move_constructible_v< Pred >)=default
constexpr	~FilterAdapter () noexcept(std::is_nothrow_destructible_v< Iter > &&std::is_nothrow_destructible_v< Pred >)=default
constexpr FilterAdapter &	operator= (const FilterAdapter &) noexcept(std::is_nothrow_copy_assignable_v< Iter > &&std::is_nothrow_copy_assignable_v< Pred >)=default
constexpr FilterAdapter &	operator= (FilterAdapter &&) noexcept(std::is_nothrow_move_assignable_v< Iter > &&std::is_nothrow_move_assignable_v< Pred >)=default
constexpr FilterAdapter &	operator++ () noexcept(noexcept(++std::declval< Iter & >()) &&noexcept(AdvanceToValid()))
constexpr FilterAdapter	operator++ (int) noexcept(std::is_nothrow_copy_constructible_v< FilterAdapter > &&noexcept(++std::declval< FilterAdapter & >()))
constexpr value_type	operator* () const noexcept(noexcept(*std::declval< const Iter & >()))
constexpr bool	operator== (const FilterAdapter &other) const noexcept(noexcept(std::declval< const Iter & >()==std::declval< const Iter & >()))
constexpr bool	operator!= (const FilterAdapter &other) const noexcept(noexcept(std::declval< const FilterAdapter & >()==std::declval< const FilterAdapter & >()))
constexpr bool	IsAtEnd () const noexcept(noexcept(std::declval< const Iter & >()==std::declval< const Iter & >()))
	Checks if the iterator has reached the end.
constexpr FilterAdapter	begin () const noexcept(std::is_nothrow_copy_constructible_v< FilterAdapter >)
constexpr FilterAdapter	end () const noexcept(std::is_nothrow_constructible_v< FilterAdapter, const Iter &, const Iter &, const Pred & >)

Detailed Description

template<typename Iter, typename Pred>
requires FilterAdapterRequirements<Iter, Pred>
class helios::utils::FilterAdapter< Iter, Pred >

Definition at line 385 of file functional_adapters.hpp.

Member Typedef Documentation

difference_type

template<typename Iter , typename Pred >

using helios::utils::FilterAdapter< Iter, Pred >::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 389 of file functional_adapters.hpp.

iterator_category

template<typename Iter , typename Pred >

using helios::utils::FilterAdapter< Iter, Pred >::iterator_category = std::forward_iterator_tag

Examples

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

Definition at line 387 of file functional_adapters.hpp.

pointer

template<typename Iter , typename Pred >

using helios::utils::FilterAdapter< Iter, Pred >::pointer = value_type*

Examples

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

Definition at line 390 of file functional_adapters.hpp.

reference

template<typename Iter , typename Pred >

using helios::utils::FilterAdapter< Iter, Pred >::reference = value_type

Examples

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

Definition at line 391 of file functional_adapters.hpp.

value_type

template<typename Iter , typename Pred >

using helios::utils::FilterAdapter< Iter, Pred >::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 388 of file functional_adapters.hpp.

Constructor & Destructor Documentation

FilterAdapter() [1/3]

template<typename Iter , typename Pred >

constexpr helios::utils::FilterAdapter< Iter, Pred >::FilterAdapter ( Iter  begin, Iter  end, Pred  predicate  )

inlineconstexprnoexcept

Constructs a filter adapter with the given iterator range and predicate.

Parameters

begin	Start of the iterator range
end	End of the iterator range
predicate	Function to filter elements

Definition at line 399 of file functional_adapters.hpp.

      : begin_(std::move(begin)), current_(begin_), end_(std::move(end)), predicate_(std::move(predicate)) {
    AdvanceToValid();
  }

FilterAdapter() [2/3]

template<typename Iter , typename Pred >

constexpr helios::utils::FilterAdapter< Iter, Pred >::FilterAdapter ( const FilterAdapter< Iter, Pred > &  ) const &&

constexprdefaultnoexcept

FilterAdapter() [3/3]

template<typename Iter , typename Pred >

constexpr helios::utils::FilterAdapter< Iter, Pred >::FilterAdapter ( FilterAdapter< Iter, Pred > &&  ) const &&

constexprdefaultnoexcept

~FilterAdapter()

template<typename Iter , typename Pred >

constexpr helios::utils::FilterAdapter< Iter, Pred >::~FilterAdapter ( ) &&

constexprdefaultnoexcept

Examples

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

Member Function Documentation

begin()

template<typename Iter , typename Pred >

constexpr FilterAdapter helios::utils::FilterAdapter< Iter, Pred >::begin ( ) const

inlineconstexprnoexcept

Examples

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

Definition at line 446 of file functional_adapters.hpp.

                                                                                                                  {
    return *this;
  }

end()

template<typename Iter , typename Pred >

constexpr FilterAdapter helios::utils::FilterAdapter< Iter, Pred >::end ( ) const

inlineconstexprnoexcept

Examples

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

Definition at line 450 of file functional_adapters.hpp.

                                                                                                    {
    return {end_, end_, predicate_};
  }

IsAtEnd()

template<typename Iter , typename Pred >

constexpr bool helios::utils::FilterAdapter< Iter, Pred >::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 441 of file functional_adapters.hpp.

                                                                                 {
    return current_ == end_;
  }

operator!=()

template<typename Iter , typename Pred >

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

inlineconstexprnoexcept

Examples

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

Definition at line 432 of file functional_adapters.hpp.

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

operator*()

template<typename Iter , typename Pred >

constexpr value_type helios::utils::FilterAdapter< Iter, Pred >::operator* ( ) const

inlineconstexprnoexcept

Examples

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

Definition at line 423 of file functional_adapters.hpp.

                                                                                                      {
    return *current_;
  }

operator++() [1/2]

template<typename Iter , typename Pred >
requires FilterAdapterRequirements<Iter, Pred>

constexpr auto helios::utils::FilterAdapter< Iter, Pred >::operator++ ( )

constexprnoexcept

Examples

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

Definition at line 468 of file functional_adapters.hpp.

                                                                                                              {
  ++current_;
  AdvanceToValid();
  return *this;
}

operator++() [2/2]

template<typename Iter , typename Pred >
requires FilterAdapterRequirements<Iter, Pred>

constexpr auto helios::utils::FilterAdapter< Iter, Pred >::operator++ ( int  )

constexprnoexcept

Definition at line 477 of file functional_adapters.hpp.

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

operator=() [1/2]

template<typename Iter , typename Pred >

constexpr FilterAdapter & helios::utils::FilterAdapter< Iter, Pred >::operator= ( const FilterAdapter< Iter, Pred > &  ) &&

constexprdefaultnoexcept

Examples

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

operator=() [2/2]

template<typename Iter , typename Pred >

constexpr FilterAdapter & helios::utils::FilterAdapter< Iter, Pred >::operator= ( FilterAdapter< Iter, Pred > &&  ) &&

constexprdefaultnoexcept

operator==()

template<typename Iter , typename Pred >

constexpr bool helios::utils::FilterAdapter< Iter, Pred >::operator== ( const FilterAdapter< Iter, Pred > &  other ) const

inlineconstexprnoexcept

Examples

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

Definition at line 427 of file functional_adapters.hpp.

                                                                                 {
    return current_ == other.current_;
  }