ManiVault: hdps::PointDataIterator< ValueIteratorType, IndexIteratorType, IndexFunctionType > Class Template Reference

ManiVault 1.0.0

A Flexible and Extensible Visual Analytics Framework for High-Dimensional Data

Loading...

Searching...

No Matches

#include <PointDataIterator.h>

Public Types
using	difference_type = std::ptrdiff_t

using	value_type = PointViewType

using	reference = PointViewType

using	pointer = const PointViewType *

using	iterator_category = std::random_access_iterator_tag

Public Member Functions
	PointDataIterator ()=default

	PointDataIterator (const ValueIteratorType valueIterator, const IndexIteratorType indexIterator, const unsigned numberOfDimensions, const IndexFunctionType indexFunction)

auto	operator* () const

auto &	operator++ ()

auto	operator++ (int)

auto &	operator-- ()

auto	operator-- (int)

auto	operator[] (const difference_type n) const

Friends
auto &	operator+= (PointDataIterator &it, const difference_type n)

difference_type	operator- (const PointDataIterator &it1, const PointDataIterator &it2)

auto	operator+ (PointDataIterator it, const difference_type n)

auto	operator+ (const difference_type n, PointDataIterator it)

auto	operator- (PointDataIterator it, const difference_type n)

bool	operator== (const PointDataIterator &it1, const PointDataIterator &it2)

bool	operator!= (const PointDataIterator &it1, const PointDataIterator &it2)

bool	operator< (const PointDataIterator &it1, const PointDataIterator &it2)

bool	operator> (const PointDataIterator &it1, const PointDataIterator &it2)

bool	operator<= (const PointDataIterator &it1, const PointDataIterator &it2)

bool	operator>= (const PointDataIterator &it1, const PointDataIterator &it2)

auto &	operator-= (PointDataIterator &it, const difference_type n)

auto	index (const PointDataIterator &arg)

Member Typedef Documentation

◆ difference_type

template<typename ValueIteratorType , typename IndexIteratorType , typename IndexFunctionType >

using hdps::PointDataIterator< ValueIteratorType, IndexIteratorType, IndexFunctionType >::difference_type = std::ptrdiff_t

◆ iterator_category

template<typename ValueIteratorType , typename IndexIteratorType , typename IndexFunctionType >

using hdps::PointDataIterator< ValueIteratorType, IndexIteratorType, IndexFunctionType >::iterator_category = std::random_access_iterator_tag

◆ pointer

template<typename ValueIteratorType , typename IndexIteratorType , typename IndexFunctionType >

using hdps::PointDataIterator< ValueIteratorType, IndexIteratorType, IndexFunctionType >::pointer = const PointViewType*

◆ reference

template<typename ValueIteratorType , typename IndexIteratorType , typename IndexFunctionType >

using hdps::PointDataIterator< ValueIteratorType, IndexIteratorType, IndexFunctionType >::reference = PointViewType

◆ value_type

template<typename ValueIteratorType , typename IndexIteratorType , typename IndexFunctionType >

using hdps::PointDataIterator< ValueIteratorType, IndexIteratorType, IndexFunctionType >::value_type = PointViewType

Constructor & Destructor Documentation

◆ PointDataIterator() [1/2]

template<typename ValueIteratorType , typename IndexIteratorType , typename IndexFunctionType >

hdps::PointDataIterator< ValueIteratorType, IndexIteratorType, IndexFunctionType >::PointDataIterator ( )

default

◆ PointDataIterator() [2/2]

template<typename ValueIteratorType , typename IndexIteratorType , typename IndexFunctionType >

hdps::PointDataIterator< ValueIteratorType, IndexIteratorType, IndexFunctionType >::PointDataIterator	(	const ValueIteratorType	valueIterator,
		const IndexIteratorType	indexIterator,
		const unsigned	numberOfDimensions,
		const IndexFunctionType	indexFunction
	)

inline

Member Function Documentation

◆ operator*()

template<typename ValueIteratorType , typename IndexIteratorType , typename IndexFunctionType >

auto hdps::PointDataIterator< ValueIteratorType, IndexIteratorType, IndexFunctionType >::operator* ( ) const

inline

Returns a PointView object to the current point.

◆ operator++() [1/2]

template<typename ValueIteratorType , typename IndexIteratorType , typename IndexFunctionType >

auto & hdps::PointDataIterator< ValueIteratorType, IndexIteratorType, IndexFunctionType >::operator++ ( )

inline

Prefix increment ('++it').

◆ operator++() [2/2]

template<typename ValueIteratorType , typename IndexIteratorType , typename IndexFunctionType >

auto hdps::PointDataIterator< ValueIteratorType, IndexIteratorType, IndexFunctionType >::operator++ ( int )

inline

Postfix increment ('it++').

Note: Usually prefix increment ('++it') is preferable.

◆ operator--() [1/2]

template<typename ValueIteratorType , typename IndexIteratorType , typename IndexFunctionType >

auto & hdps::PointDataIterator< ValueIteratorType, IndexIteratorType, IndexFunctionType >::operator-- ( )

inline

Prefix decrement ('–it').

◆ operator--() [2/2]

template<typename ValueIteratorType , typename IndexIteratorType , typename IndexFunctionType >

auto hdps::PointDataIterator< ValueIteratorType, IndexIteratorType, IndexFunctionType >::operator-- ( int )

inline

Postfix increment ('it–').

Note: Usually prefix increment ('–it') is preferable.

◆ operator[]()

template<typename ValueIteratorType , typename IndexIteratorType , typename IndexFunctionType >

auto hdps::PointDataIterator< ValueIteratorType, IndexIteratorType, IndexFunctionType >::operator[] ( const difference_type n ) const

inline

Returns it[n] for iterator 'it' and integer value 'n'.

Friends And Related Symbol Documentation

◆ index

template<typename ValueIteratorType , typename IndexIteratorType , typename IndexFunctionType >

auto index ( const PointDataIterator< ValueIteratorType, IndexIteratorType, IndexFunctionType > & arg )

friend

Returns the index of the current point.

◆ operator!=

template<typename ValueIteratorType , typename IndexIteratorType , typename IndexFunctionType >

bool operator!=	(	const PointDataIterator< ValueIteratorType, IndexIteratorType, IndexFunctionType > &	it1,
		const PointDataIterator< ValueIteratorType, IndexIteratorType, IndexFunctionType > &	it2
	)

friend

Returns (it1 != it2) for iterators it1 and it2.

◆ operator+ [1/2]

template<typename ValueIteratorType , typename IndexIteratorType , typename IndexFunctionType >

auto operator+	(	const difference_type	n,
		PointDataIterator< ValueIteratorType, IndexIteratorType, IndexFunctionType >	it
	)

friend

Returns (n + it) for iterator 'it' and integer value 'n'.

◆ operator+ [2/2]

template<typename ValueIteratorType , typename IndexIteratorType , typename IndexFunctionType >

auto operator+	(	PointDataIterator< ValueIteratorType, IndexIteratorType, IndexFunctionType >	it,
		const difference_type	n
	)

friend

Returns (it + n) for iterator 'it' and integer value 'n'.

◆ operator+=

template<typename ValueIteratorType , typename IndexIteratorType , typename IndexFunctionType >

auto & operator+=	(	PointDataIterator< ValueIteratorType, IndexIteratorType, IndexFunctionType > &	it,
		const difference_type	n
	)

friend

Does (it += n) for iterator 'it' and integer value 'n'.

◆ operator- [1/2]

template<typename ValueIteratorType , typename IndexIteratorType , typename IndexFunctionType >

difference_type operator-	(	const PointDataIterator< ValueIteratorType, IndexIteratorType, IndexFunctionType > &	it1,
		const PointDataIterator< ValueIteratorType, IndexIteratorType, IndexFunctionType > &	it2
	)

friend

Returns (it1 - it2) for iterators it1 and it2.

◆ operator- [2/2]

template<typename ValueIteratorType , typename IndexIteratorType , typename IndexFunctionType >

auto operator-	(	PointDataIterator< ValueIteratorType, IndexIteratorType, IndexFunctionType >	it,
		const difference_type	n
	)

friend

Returns (it - n) for iterator 'it' and integer value 'n'.

◆ operator-=

template<typename ValueIteratorType , typename IndexIteratorType , typename IndexFunctionType >

auto & operator-=	(	PointDataIterator< ValueIteratorType, IndexIteratorType, IndexFunctionType > &	it,
		const difference_type	n
	)

friend

Does (it -= n) for iterator 'it' and integer value 'n'.

◆ operator<

template<typename ValueIteratorType , typename IndexIteratorType , typename IndexFunctionType >

bool operator<	(	const PointDataIterator< ValueIteratorType, IndexIteratorType, IndexFunctionType > &	it1,
		const PointDataIterator< ValueIteratorType, IndexIteratorType, IndexFunctionType > &	it2
	)

friend

Returns (it1 < it2) for iterators it1 and it2.

◆ operator<=

template<typename ValueIteratorType , typename IndexIteratorType , typename IndexFunctionType >

bool operator<=	(	const PointDataIterator< ValueIteratorType, IndexIteratorType, IndexFunctionType > &	it1,
		const PointDataIterator< ValueIteratorType, IndexIteratorType, IndexFunctionType > &	it2
	)

friend

Returns (it1 <= it2) for iterators it1 and it2.

◆ operator==

template<typename ValueIteratorType , typename IndexIteratorType , typename IndexFunctionType >

bool operator==	(	const PointDataIterator< ValueIteratorType, IndexIteratorType, IndexFunctionType > &	it1,
		const PointDataIterator< ValueIteratorType, IndexIteratorType, IndexFunctionType > &	it2
	)

friend

Returns (it1 == it2) for iterators it1 and it2.

◆ operator>

template<typename ValueIteratorType , typename IndexIteratorType , typename IndexFunctionType >

bool operator>	(	const PointDataIterator< ValueIteratorType, IndexIteratorType, IndexFunctionType > &	it1,
		const PointDataIterator< ValueIteratorType, IndexIteratorType, IndexFunctionType > &	it2
	)

friend

Returns (it1 > it2) for iterators it1 and it2.

◆ operator>=

template<typename ValueIteratorType , typename IndexIteratorType , typename IndexFunctionType >

bool operator>=	(	const PointDataIterator< ValueIteratorType, IndexIteratorType, IndexFunctionType > &	it1,
		const PointDataIterator< ValueIteratorType, IndexIteratorType, IndexFunctionType > &	it2
	)

friend

Returns (it1 >= it2) for iterators it1 and it2.

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

D:/Work/ManiVault/DevBundle/allmain/source/core/HDPS/src/plugins/PointData/src/PointDataIterator.h

hdps
PointDataIterator
Generated by 1.9.8