NAV::ScrollingBuffer< T, _Padding >::ReverseIterator Class Reference

Reverse Iterator. More...

Public Types
using	difference_type
	Signed integer type (usually std::ptrdiff_t)
using	iterator_category
	To categorize the iteration direction.
using	pointer
	value_type*
using	reference
	value_type&
using	value_type
	T.

Public Member Functions
reference	operator* () const
	Returns a reference to the current element.
ReverseIterator &	operator++ ()
	Advances the iterator.
ReverseIterator	operator++ (int)
	Advances the iterator.
pointer	operator-> ()
	Returns a pointer to the current element.
	ReverseIterator (ScrollingBuffer &buffer, int64_t index=0)
	Constructor.

Private Attributes
ScrollingBuffer &	buffer
	Reference to the buffer.
int64_t	index
	Iterator index inside the buffer (counted from the non-reversed start)

Friends
bool	operator!= (const ReverseIterator &lhs, const ReverseIterator &rhs)
	Inequality comparison operator.
bool	operator== (const ReverseIterator &lhs, const ReverseIterator &rhs)
	Equality comparison operator.

Detailed Description

template<class T, size_t _Padding = 0>
class NAV::ScrollingBuffer< T, _Padding >::ReverseIterator

Reverse Iterator.

Definition at line 269 of file ScrollingBuffer.hpp.

Member Typedef Documentation

difference_type

template<class T, size_t _Padding = 0>

using NAV::ScrollingBuffer< T, _Padding >::ReverseIterator::difference_type

Signed integer type (usually std::ptrdiff_t)

Definition at line 273 of file ScrollingBuffer.hpp.

iterator_category

template<class T, size_t _Padding = 0>

using NAV::ScrollingBuffer< T, _Padding >::ReverseIterator::iterator_category

To categorize the iteration direction.

Definition at line 272 of file ScrollingBuffer.hpp.

pointer

template<class T, size_t _Padding = 0>

using NAV::ScrollingBuffer< T, _Padding >::ReverseIterator::pointer

value_type*

Definition at line 275 of file ScrollingBuffer.hpp.

reference

template<class T, size_t _Padding = 0>

using NAV::ScrollingBuffer< T, _Padding >::ReverseIterator::reference

value_type&

Definition at line 276 of file ScrollingBuffer.hpp.

value_type

template<class T, size_t _Padding = 0>

using NAV::ScrollingBuffer< T, _Padding >::ReverseIterator::value_type

T.

Definition at line 274 of file ScrollingBuffer.hpp.

Constructor & Destructor Documentation

ReverseIterator()

template<class T, size_t _Padding = 0>

NAV::ScrollingBuffer< T, _Padding >::ReverseIterator::ReverseIterator ( ScrollingBuffer & buffer, int64_t index = 0 )

inlineexplicit

Constructor.

Parameters

[in]	buffer	Mutable reference to the buffer of the iterator
[in]	index	Iterator index inside the buffer (counted from the non-reversed start)

Definition at line 281 of file ScrollingBuffer.hpp.

Member Function Documentation

operator*()

template<class T, size_t _Padding = 0>

reference NAV::ScrollingBuffer< T, _Padding >::ReverseIterator::operator* ( ) const

inline

Returns a reference to the current element.

Definition at line 285 of file ScrollingBuffer.hpp.

operator++() [1/2]

template<class T, size_t _Padding = 0>

ReverseIterator & NAV::ScrollingBuffer< T, _Padding >::ReverseIterator::operator++ ( )

inline

Advances the iterator.

Definition at line 290 of file ScrollingBuffer.hpp.

operator++() [2/2]

template<class T, size_t _Padding = 0>

ReverseIterator NAV::ScrollingBuffer< T, _Padding >::ReverseIterator::operator++ ( int )

inline

Advances the iterator.

Definition at line 297 of file ScrollingBuffer.hpp.

operator->()

template<class T, size_t _Padding = 0>

pointer NAV::ScrollingBuffer< T, _Padding >::ReverseIterator::operator-> ( )

inline

Returns a pointer to the current element.

Definition at line 287 of file ScrollingBuffer.hpp.

Friends And Related Symbol Documentation

operator!=

template<class T, size_t _Padding = 0>

bool operator!= ( const ReverseIterator & lhs, const ReverseIterator & rhs )

friend

Inequality comparison operator.

Parameters

[in]	lhs	Left-hand side
[in]	rhs	Right-hand side

Returns

False if elements are equal

Definition at line 313 of file ScrollingBuffer.hpp.

operator==

template<class T, size_t _Padding = 0>

bool operator== ( const ReverseIterator & lhs, const ReverseIterator & rhs )

friend

Equality comparison operator.

Parameters

[in]	lhs	Left-hand side
[in]	rhs	Right-hand side

Returns

True if elements are equal

Definition at line 308 of file ScrollingBuffer.hpp.

Field Documentation

buffer

template<class T, size_t _Padding = 0>

ScrollingBuffer& NAV::ScrollingBuffer< T, _Padding >::ReverseIterator::buffer

private

Reference to the buffer.

Definition at line 316 of file ScrollingBuffer.hpp.

index

template<class T, size_t _Padding = 0>

int64_t NAV::ScrollingBuffer< T, _Padding >::ReverseIterator::index

private

Iterator index inside the buffer (counted from the non-reversed start)

Definition at line 317 of file ScrollingBuffer.hpp.

---

The documentation for this class was generated from the following file:

• /home/runner/work/INSTINCT/INSTINCT/src/util/Container/ScrollingBuffer.hpp