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

#include <functional_adapters.hpp>

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

Public Types
using	iterator_category = std::forward_iterator_tag
using	value_type = typename DeduceValueType< std::iter_value_t< Iter > >::Type
using	difference_type = std::iter_difference_t< Iter >
using	pointer = value_type *
using	reference = value_type

Public Member Functions
constexpr	MapAdapter (Iter begin, Iter end, Func transform) noexcept(std::is_nothrow_move_constructible_v< Iter > &&std::is_nothrow_move_constructible_v< Func >)
	Constructs a map adapter with the given iterator range and transform function.
constexpr	MapAdapter (const MapAdapter &) noexcept(std::is_nothrow_copy_constructible_v< Iter > &&std::is_nothrow_copy_constructible_v< Func >)=default
constexpr	MapAdapter (MapAdapter &&) noexcept(std::is_nothrow_move_constructible_v< Iter > &&std::is_nothrow_move_constructible_v< Func >)=default
constexpr	~MapAdapter () noexcept(std::is_nothrow_destructible_v< Iter > &&std::is_nothrow_destructible_v< Func >)=default
constexpr MapAdapter &	operator= (const MapAdapter &) noexcept(std::is_nothrow_copy_assignable_v< Iter > &&std::is_nothrow_copy_assignable_v< Func >)=default
constexpr MapAdapter &	operator= (MapAdapter &&) noexcept(std::is_nothrow_move_assignable_v< Iter > &&std::is_nothrow_move_assignable_v< Func >)=default
constexpr MapAdapter &	operator++ () noexcept(noexcept(++std::declval< Iter & >()))
constexpr MapAdapter	operator++ (int) noexcept(std::is_nothrow_copy_constructible_v< MapAdapter > &&noexcept(++std::declval< MapAdapter & >()))
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 MapAdapter &other) const noexcept(noexcept(std::declval< const Iter & >()==std::declval< const Iter & >()))
constexpr bool	operator!= (const MapAdapter &other) const noexcept(noexcept(std::declval< const MapAdapter & >()==std::declval< const MapAdapter & >()))
constexpr MapAdapter	begin () const noexcept(std::is_nothrow_copy_constructible_v< MapAdapter >)
constexpr MapAdapter	end () const noexcept(std::is_nothrow_constructible_v< MapAdapter, const Iter &, const Iter &, const Func & >)

Detailed Description

template<typename Iter, typename Func>
requires MapAdapterRequirements<Iter, Func>
class helios::utils::MapAdapter< Iter, Func >

Definition at line 527 of file functional_adapters.hpp.

Member Typedef Documentation

difference_type

template<typename Iter , typename Func >

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

iterator_category

template<typename Iter , typename Func >

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

pointer

template<typename Iter , typename Func >

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

Examples

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

Definition at line 547 of file functional_adapters.hpp.

reference

template<typename Iter , typename Func >

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

Examples

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

Definition at line 548 of file functional_adapters.hpp.

value_type

template<typename Iter , typename Func >

using helios::utils::MapAdapter< Iter, Func >::value_type = typename DeduceValueType<std::iter_value_t<Iter> >::Type

Examples

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

Definition at line 545 of file functional_adapters.hpp.

Constructor & Destructor Documentation

MapAdapter() [1/3]

template<typename Iter , typename Func >

constexpr helios::utils::MapAdapter< Iter, Func >::MapAdapter ( Iter  begin, Iter  end, Func  transform  )

inlineconstexprnoexcept

Constructs a map adapter with the given iterator range and transform function.

Parameters

begin	Start of the iterator range
end	End of the iterator range
transform	Function to transform elements

Definition at line 556 of file functional_adapters.hpp.

      : begin_(std::move(begin)), current_(begin_), end_(std::move(end)), transform_(std::move(transform)) {}

MapAdapter() [2/3]

template<typename Iter , typename Func >

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

constexprdefaultnoexcept

MapAdapter() [3/3]

template<typename Iter , typename Func >

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

constexprdefaultnoexcept

~MapAdapter()

template<typename Iter , typename Func >

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

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 MapAdapter helios::utils::MapAdapter< Iter, Func >::begin ( ) const

inlineconstexprnoexcept

Examples

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

Definition at line 588 of file functional_adapters.hpp.

                                                                                                            {
    return *this;
  }

end()

template<typename Iter , typename Func >

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

inlineconstexprnoexcept

Examples

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

Definition at line 592 of file functional_adapters.hpp.

                                                                                                 {
    return {end_, end_, transform_};
  }

operator!=()

template<typename Iter , typename Func >

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

inlineconstexprnoexcept

Examples

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

Definition at line 583 of file functional_adapters.hpp.

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

operator*()

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

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

constexprnoexcept

Examples

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

Definition at line 622 of file functional_adapters.hpp.

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

operator++() [1/2]

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

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

constexprnoexcept

Examples

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

Definition at line 606 of file functional_adapters.hpp.

                                                                                                           {
  ++current_;
  return *this;
}

operator++() [2/2]

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

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

constexprnoexcept

Definition at line 613 of file functional_adapters.hpp.

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

operator=() [1/2]

template<typename Iter , typename Func >

constexpr MapAdapter & helios::utils::MapAdapter< Iter, Func >::operator= ( const MapAdapter< 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 MapAdapter & helios::utils::MapAdapter< Iter, Func >::operator= ( MapAdapter< Iter, Func > &&  ) &&

constexprdefaultnoexcept

operator==()

template<typename Iter , typename Func >

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

inlineconstexprnoexcept

Examples

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

Definition at line 579 of file functional_adapters.hpp.

                                                                                 {
    return current_ == other.current_;
  }