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

#include <functional_adapters.hpp>

Public Types
using	iterator = Iter
using	const_iterator = Iter
using	value_type = std::iter_value_t< Iter >
using	reference = decltype(*std::declval< Iter >())
using	size_type = size_t

Public Member Functions
constexpr	SlideView (Iter begin, size_t size) noexcept(std::is_nothrow_copy_constructible_v< Iter >)
	Constructs a SlideView.
constexpr	SlideView (const SlideView &) noexcept(std::is_nothrow_copy_constructible_v< Iter >)=default
constexpr	SlideView (SlideView &&) noexcept(std::is_nothrow_move_constructible_v< Iter >)=default
constexpr	~SlideView () noexcept=default
constexpr SlideView &	operator= (const SlideView &) noexcept(std::is_nothrow_copy_assignable_v< Iter >)=default
constexpr SlideView &	operator= (SlideView &&) noexcept(std::is_nothrow_move_assignable_v< Iter >)=default
constexpr auto	Collect () const -> std::vector< value_type >
	Collects the window elements into a vector.
constexpr reference	operator[] (size_t index) const noexcept(noexcept(*std::declval< Iter >()) &&noexcept(++std::declval< Iter & >()))
	Accesses an element by index.
constexpr bool	operator== (const SlideView &other) const
	Compares two SlideViews for equality.
template<std::ranges::sized_range R>
constexpr bool	operator== (const R &range) const
	Compares SlideView with a vector for equality.
constexpr bool	Empty () const noexcept
	Checks if the window is empty.
constexpr size_t	Size () const noexcept
	Returns the size of the window.
constexpr Iter	begin () const noexcept(std::is_nothrow_copy_constructible_v< Iter >)
	Returns an iterator to the beginning.
constexpr Iter	end () const noexcept(std::is_nothrow_copy_constructible_v< Iter > &&noexcept(++std::declval< Iter & >()))
	Returns an iterator to the end.

Detailed Description

template<IteratorLike Iter>
class helios::utils::SlideView< Iter >

Definition at line 1965 of file functional_adapters.hpp.

Member Typedef Documentation

const_iterator

template<IteratorLike Iter>

using helios::utils::SlideView< Iter >::const_iterator = Iter

Examples

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

Definition at line 1968 of file functional_adapters.hpp.

iterator

template<IteratorLike Iter>

using helios::utils::SlideView< Iter >::iterator = Iter

Examples

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

Definition at line 1967 of file functional_adapters.hpp.

reference

template<IteratorLike Iter>

using helios::utils::SlideView< Iter >::reference = decltype(*std::declval<Iter>())

Examples

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

Definition at line 1970 of file functional_adapters.hpp.

size_type

template<IteratorLike Iter>

using helios::utils::SlideView< Iter >::size_type = size_t

Examples

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

Definition at line 1971 of file functional_adapters.hpp.

value_type

template<IteratorLike Iter>

using helios::utils::SlideView< Iter >::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 1969 of file functional_adapters.hpp.

Constructor & Destructor Documentation

SlideView() [1/3]

template<IteratorLike Iter>

constexpr helios::utils::SlideView< Iter >::SlideView ( Iter  begin, size_t  size  )

inlineconstexprnoexcept

Constructs a SlideView.

Parameters

begin	Iterator to the beginning of the window
size	Size of the window

Definition at line 1978 of file functional_adapters.hpp.

      : begin_(begin), size_(size) {}

SlideView() [2/3]

template<IteratorLike Iter>

constexpr helios::utils::SlideView< Iter >::SlideView ( const SlideView< Iter > &  ) const

constexprdefaultnoexcept

SlideView() [3/3]

template<IteratorLike Iter>

constexpr helios::utils::SlideView< Iter >::SlideView ( SlideView< Iter > &&  ) const

constexprdefaultnoexcept

~SlideView()

template<IteratorLike Iter>

constexpr helios::utils::SlideView< Iter >::~SlideView ( )

constexprdefaultnoexcept

Examples

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

Member Function Documentation

begin()

template<IteratorLike Iter>

constexpr Iter helios::utils::SlideView< Iter >::begin ( ) const

inlineconstexprnoexcept

Returns an iterator to the beginning.

Returns

Iterator to the first element

Examples

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

Definition at line 2037 of file functional_adapters.hpp.

{ return begin_; }

Collect()

template<IteratorLike Iter>
requires std::copy_constructible<value_type>

constexpr auto helios::utils::SlideView< Iter >::Collect ( ) const -> std::vector<value_type>

constexpr

Collects the window elements into a vector.

Use when you need ownership of the elements.

Returns

Vector containing copies of the window elements

Examples

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

Definition at line 2052 of file functional_adapters.hpp.

{
  std::vector<value_type> result;
  result.reserve(size_);
  auto it = begin_;
  for (size_t i = 0; i < size_; ++i) {
    result.push_back(*it++);
  }
  return result;
}

Empty()

template<IteratorLike Iter>

constexpr bool helios::utils::SlideView< Iter >::Empty ( ) const

inlineconstexprnoexcept

Checks if the window is empty.

Returns

True if the window has no elements

Examples

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

Definition at line 2025 of file functional_adapters.hpp.

{ return size_ == 0; }

end()

template<IteratorLike Iter>

constexpr Iter helios::utils::SlideView< Iter >::end ( ) const

constexprnoexcept

Returns an iterator to the end.

Returns

Iterator past the last element

Examples

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

Definition at line 2101 of file functional_adapters.hpp.

                                                                                          {
  auto it = begin_;
  for (size_t i = 0; i < size_; ++i) {
    ++it;
  }
  return it;
}

operator=() [1/2]

template<IteratorLike Iter>

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

constexprdefaultnoexcept

Examples

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

operator=() [2/2]

template<IteratorLike Iter>

constexpr SlideView & helios::utils::SlideView< Iter >::operator= ( SlideView< Iter > &&  )

constexprdefaultnoexcept

operator==() [1/2]

template<IteratorLike Iter>

template<std::ranges::sized_range R>

constexpr bool helios::utils::SlideView< Iter >::operator== ( const R &  range ) const

constexpr

Compares SlideView with a vector for equality.

Template Parameters

R

Parameters

vec	Vector to compare with

Returns

True if the view has the same elements as the vector

Definition at line 2092 of file functional_adapters.hpp.

                                                               {
  if (size_ != std::ranges::size(range)) {
    return false;
  }
 
  return std::equal(std::ranges::cbegin(range), std::ranges::cend(range), begin_);
}

operator==() [2/2]

template<IteratorLike Iter>

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

constexpr

Compares two SlideViews for equality.

Parameters

other

SlideView to compare with

Returns

True if both views have the same elements

Examples

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

Definition at line 2075 of file functional_adapters.hpp.

                                                                       {
  if (size_ != other.size_) {
    return false;
  }
 
  auto it1 = begin_;
  auto it2 = other.begin_;
  for (size_t i = 0; i < size_; ++i) {
    if (*it1++ != *it2++) {
      return false;
    }
  }
  return true;
}

operator[]()

template<IteratorLike Iter>

constexpr auto helios::utils::SlideView< Iter >::operator[] ( size_t  index ) const

constexprnoexcept

Accesses an element by index.

Warning

Index must be less than size

Parameters

index

Index of the element

Returns

Reference to the element

Examples

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

Definition at line 2065 of file functional_adapters.hpp.

                                                                                            {
  auto it = begin_;
  for (size_t i = 0; i < index; ++i) {
    ++it;
  }
  return *it;
}

Size()

template<IteratorLike Iter>

constexpr size_t helios::utils::SlideView< Iter >::Size ( ) const

inlineconstexprnoexcept

Returns the size of the window.

Returns

Number of elements in the window

Examples

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

Definition at line 2031 of file functional_adapters.hpp.

{ return size_; }