helios::utils::InspectAdapter< Iter, Func > Class Template Reference

#include <functional_adapters.hpp>

Inheritance diagram for helios::utils::InspectAdapter< Iter, Func >:

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	InspectAdapter (Iter begin, Iter end, Func inspector) noexcept(std::is_nothrow_move_constructible_v< Iter > &&std::is_nothrow_copy_constructible_v< Iter > &&std::is_nothrow_move_constructible_v< Func >)
	Constructs an inspect adapter with the given iterator range and inspector function.
constexpr	InspectAdapter (const InspectAdapter &) noexcept(std::is_nothrow_copy_constructible_v< Iter > &&std::is_nothrow_copy_constructible_v< Func >)=default
constexpr	InspectAdapter (InspectAdapter &&) noexcept(std::is_nothrow_move_constructible_v< Iter > &&std::is_nothrow_move_constructible_v< Func >)=default
constexpr	~InspectAdapter () noexcept(std::is_nothrow_destructible_v< Iter > &&std::is_nothrow_destructible_v< Func >)=default
constexpr InspectAdapter &	operator= (const InspectAdapter &) noexcept(std::is_nothrow_copy_assignable_v< Iter > &&std::is_nothrow_copy_assignable_v< Func >)=default
constexpr InspectAdapter &	operator= (InspectAdapter &&) noexcept(std::is_nothrow_move_assignable_v< Iter > &&std::is_nothrow_move_assignable_v< Func >)=default
constexpr InspectAdapter &	operator++ () noexcept(noexcept(++std::declval< Iter & >()))
constexpr InspectAdapter	operator++ (int) noexcept(std::is_nothrow_copy_constructible_v< InspectAdapter > &&noexcept(++std::declval< InspectAdapter & >()))
constexpr value_type	operator* () const noexcept(std::is_nothrow_invocable_v< Func, std::iter_value_t< Iter > > &&noexcept(*std::declval< const Iter & >()))
constexpr bool	operator== (const InspectAdapter &other) const noexcept(noexcept(std::declval< const Iter & >()==std::declval< const Iter & >()))
constexpr bool	operator!= (const InspectAdapter &other) const noexcept(noexcept(std::declval< const InspectAdapter & >()==std::declval< const InspectAdapter & >()))
constexpr InspectAdapter	begin () const noexcept(std::is_nothrow_copy_constructible_v< InspectAdapter >)
constexpr InspectAdapter	end () const noexcept(std::is_nothrow_constructible_v< InspectAdapter, const Iter &, const Iter &, const Func & >)

Detailed Description

template<typename Iter, typename Func>
requires InspectAdapterRequirements<Iter, Func>
class helios::utils::InspectAdapter< Iter, Func >

Definition at line 1259 of file functional_adapters.hpp.

Member Typedef Documentation

difference_type

template<typename Iter , typename Func >

using helios::utils::InspectAdapter< Iter, Func >::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 1263 of file functional_adapters.hpp.

iterator_category

template<typename Iter , typename Func >

using helios::utils::InspectAdapter< Iter, Func >::iterator_category = std::forward_iterator_tag

Examples

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

Definition at line 1261 of file functional_adapters.hpp.

pointer

template<typename Iter , typename Func >

using helios::utils::InspectAdapter< Iter, Func >::pointer = value_type*

Examples

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

Definition at line 1264 of file functional_adapters.hpp.

reference

template<typename Iter , typename Func >

using helios::utils::InspectAdapter< Iter, Func >::reference = value_type

Examples

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

Definition at line 1265 of file functional_adapters.hpp.

value_type

template<typename Iter , typename Func >

using helios::utils::InspectAdapter< Iter, Func >::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 1262 of file functional_adapters.hpp.

Constructor & Destructor Documentation

InspectAdapter() [1/3]

template<typename Iter , typename Func >

constexpr helios::utils::InspectAdapter< Iter, Func >::InspectAdapter ( Iter  begin, Iter  end, Func  inspector  )

inlineconstexprnoexcept

Constructs an inspect adapter with the given iterator range and inspector function.

Parameters

begin	Start of the iterator range
end	End of the iterator range
inspector	Function to call for each element

Definition at line 1273 of file functional_adapters.hpp.

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

InspectAdapter() [2/3]

template<typename Iter , typename Func >

constexpr helios::utils::InspectAdapter< Iter, Func >::InspectAdapter ( const InspectAdapter< Iter, Func > &  ) const &&

constexprdefaultnoexcept

InspectAdapter() [3/3]

template<typename Iter , typename Func >

constexpr helios::utils::InspectAdapter< Iter, Func >::InspectAdapter ( InspectAdapter< Iter, Func > &&  ) const &&

constexprdefaultnoexcept

~InspectAdapter()

template<typename Iter , typename Func >

constexpr helios::utils::InspectAdapter< Iter, Func >::~InspectAdapter ( ) &&

constexprdefaultnoexcept

Examples

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

Member Function Documentation

begin()

template<typename Iter , typename Func >

constexpr InspectAdapter helios::utils::InspectAdapter< Iter, Func >::begin ( ) const

inlineconstexprnoexcept

Examples

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

Definition at line 1307 of file functional_adapters.hpp.

                                                                                                                    {
    return *this;
  }

end()

template<typename Iter , typename Func >

constexpr InspectAdapter helios::utils::InspectAdapter< Iter, Func >::end ( ) const

inlineconstexprnoexcept

Examples

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

Definition at line 1311 of file functional_adapters.hpp.

                                                                                                     {
    return {end_, end_, inspector_};
  }

operator!=()

template<typename Iter , typename Func >

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

inlineconstexprnoexcept

Examples

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

Definition at line 1302 of file functional_adapters.hpp.

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

operator*()

template<typename Iter , typename Func >
requires InspectAdapterRequirements<Iter, Func>

constexpr auto helios::utils::InspectAdapter< Iter, Func >::operator* ( ) const

constexprnoexcept

Examples

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

Definition at line 1342 of file functional_adapters.hpp.

                                 {
  auto value = *current_;
  if constexpr (std::invocable<Func, decltype(value)>) {
    inspector_(value);
  } else {
    std::apply(inspector_, value);
  }
  return value;
}

operator++() [1/2]

template<typename Iter , typename Func >
requires InspectAdapterRequirements<Iter, Func>

constexpr auto helios::utils::InspectAdapter< Iter, Func >::operator++ ( )

constexprnoexcept

Examples

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

Definition at line 1325 of file functional_adapters.hpp.

                                                                                                                   {
  ++current_;
  return *this;
}

operator++() [2/2]

template<typename Iter , typename Func >
requires InspectAdapterRequirements<Iter, Func>

constexpr auto helios::utils::InspectAdapter< Iter, Func >::operator++ ( int  )

constexprnoexcept

Definition at line 1332 of file functional_adapters.hpp.

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

operator=() [1/2]

template<typename Iter , typename Func >

constexpr InspectAdapter & helios::utils::InspectAdapter< Iter, Func >::operator= ( const InspectAdapter< Iter, Func > &  ) &&

constexprdefaultnoexcept

Examples

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

operator=() [2/2]

template<typename Iter , typename Func >

constexpr InspectAdapter & helios::utils::InspectAdapter< Iter, Func >::operator= ( InspectAdapter< Iter, Func > &&  ) &&

constexprdefaultnoexcept

operator==()

template<typename Iter , typename Func >

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

inlineconstexprnoexcept

Examples

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

Definition at line 1297 of file functional_adapters.hpp.

                                                                                 {
    return current_ == other.current_;
  }