Ponca::KdTreeNearestIterator< Index > Class Template Reference

Input iterator to read the KdTreeKNearestQueryBase object. More...

#include <kdTreeNearestIterator.h>

Collaboration diagram for Ponca::KdTreeNearestIterator< Index >:

Public Types
using	iterator_category = std::input_iterator_tag
using	difference_type = std::ptrdiff_t
using	value_type = Index
using	pointer = Index *
using	reference = const Index &

Public Member Functions
	KdTreeNearestIterator (Index index)
bool	operator!= (const KdTreeNearestIterator &other) const
	Inequality operand.
bool	operator== (const KdTreeNearestIterator &other) const
	Equality operand.
KdTreeNearestIterator &	operator++ ()
	Prefix increment.
KdTreeNearestIterator	operator++ (int)
	Postfix increment.
void	operator+= (int i)
	Value increment.
reference	operator* () const
	Dereference operator.

Protected Attributes
Index	m_index {-1}

Detailed Description

template<typename Index>
class Ponca::KdTreeNearestIterator< Index >

Input iterator to read the KdTreeKNearestQueryBase object.

As this is an input iterator, we don't guarantee anything other than reading the values with it. If you need to operate on the values of this iterator with algorithms that relies on forward iterator functionalities, you should copy the index values in an STL-like container.

Note

This iterator object can be duplicated with no issues.

See also

KdTreeNearestQueryBase

Definition at line 25 of file kdTreeNearestIterator.h.

Member Typedef Documentation

difference_type

template<typename Index >

using Ponca::KdTreeNearestIterator< Index >::difference_type = std::ptrdiff_t

Definition at line 29 of file kdTreeNearestIterator.h.

iterator_category

template<typename Index >

using Ponca::KdTreeNearestIterator< Index >::iterator_category = std::input_iterator_tag

Definition at line 28 of file kdTreeNearestIterator.h.

pointer

template<typename Index >

using Ponca::KdTreeNearestIterator< Index >::pointer = Index*

Definition at line 31 of file kdTreeNearestIterator.h.

reference

template<typename Index >

using Ponca::KdTreeNearestIterator< Index >::reference = const Index&

Definition at line 32 of file kdTreeNearestIterator.h.

value_type

template<typename Index >

using Ponca::KdTreeNearestIterator< Index >::value_type = Index

Definition at line 30 of file kdTreeNearestIterator.h.

Constructor & Destructor Documentation

KdTreeNearestIterator()

template<typename Index >

Ponca::KdTreeNearestIterator< Index >::KdTreeNearestIterator ( Index  index )

inline

Definition at line 35 of file kdTreeNearestIterator.h.

Member Function Documentation

operator!=()

template<typename Index >

bool Ponca::KdTreeNearestIterator< Index >::operator!= ( const KdTreeNearestIterator< Index > &  other ) const

inline

Inequality operand.

Definition at line 40 of file kdTreeNearestIterator.h.

operator*()

template<typename Index >

reference Ponca::KdTreeNearestIterator< Index >::operator* ( ) const

inline

Dereference operator.

Definition at line 66 of file kdTreeNearestIterator.h.

operator++() [1/2]

template<typename Index >

KdTreeNearestIterator & Ponca::KdTreeNearestIterator< Index >::operator++ ( )

inline

Prefix increment.

Definition at line 50 of file kdTreeNearestIterator.h.

operator++() [2/2]

template<typename Index >

KdTreeNearestIterator Ponca::KdTreeNearestIterator< Index >::operator++ ( int  )

inline

Postfix increment.

Definition at line 56 of file kdTreeNearestIterator.h.

operator+=()

template<typename Index >

void Ponca::KdTreeNearestIterator< Index >::operator+= ( int  i )

inline

Value increment.

Definition at line 63 of file kdTreeNearestIterator.h.

operator==()

template<typename Index >

bool Ponca::KdTreeNearestIterator< Index >::operator== ( const KdTreeNearestIterator< Index > &  other ) const

inline

Equality operand.

Definition at line 45 of file kdTreeNearestIterator.h.

Member Data Documentation

m_index

template<typename Index >

Index Ponca::KdTreeNearestIterator< Index >::m_index {-1}

protected

Definition at line 71 of file kdTreeNearestIterator.h.