Ponca::KnnGraphKNearestQuery< Traits > Class Template Reference

Extension of the Query class that allows to read the result of a k-nearest neighbors search on the KnnGraph. More...

#include <knnGraphKNearestQuery.h>

Inheritance diagram for Ponca::KnnGraphKNearestQuery< Traits >:

Collaboration diagram for Ponca::KnnGraphKNearestQuery< Traits >:

Public Types
using	Iterator = typename Traits::IndexContainer::const_iterator
using	QueryType = KNearestIndexQuery< typename Traits::IndexType, typename Traits::DataPoint::Scalar >
using	Self = KnnGraphKNearestQuery< Traits >
Public Types inherited from Ponca::KNearestIndexQuery< Traits::IndexType, Traits::DataPoint::Scalar >
using	Base = Query< QueryInputIsIndex< Traits::IndexType >, QueryOutputIsKNearest< Traits::IndexType, Traits::DataPoint::Scalar > >
	Alias to the inherited base Query
Public Types inherited from Ponca::Query< Input_, Output_ >
using	QueryInType = Input_
	Alias to the input type.
using	QueryOutType = Output_
	Alias to the output type.

Public Member Functions
	KnnGraphKNearestQuery (const KnnGraphBase< Traits > *graph, int index)
Self &	operator() (int index)
	Call the k-nearest neighbors query with new input parameter.
Iterator	begin () const
	Returns an iterator to the beginning of the k-nearest neighbors query.
Iterator	end () const
	Returns an iterator to the end of the k-nearest neighbors query.
Public Member Functions inherited from Ponca::Query< Input_, Output_ >
	Query (const typename QueryInType::InputType &in)
	Default constructor that initialize the input parameter only.
	Query (const typename QueryOutType::OutputParameter &outParam, const typename QueryInType::InputType &in)
	Default constructor that initialize the input and output parameters.
template<typename Base , typename... outputType>
Base &	operator() (const typename QueryInType::InputType &in, outputType &&... out)
	Access operator that resets the input and output parameters.
template<typename Base >
Base &	operator() (const typename QueryInType::InputType &in)
	Access operator that resets the input parameter only.

Protected Attributes
const KnnGraphBase< Traits > *	m_graph {nullptr}

Detailed Description

template<typename Traits>
class Ponca::KnnGraphKNearestQuery< Traits >

Extension of the Query class that allows to read the result of a k-nearest neighbors search on the KnnGraph.

Output result of a KnnGraph::kNearestNeighbors query request.

See also

KnnGraphBase

Definition at line 31 of file knnGraphKNearestQuery.h.

Member Typedef Documentation

Iterator

template<typename Traits >

using Ponca::KnnGraphKNearestQuery< Traits >::Iterator = typename Traits::IndexContainer::const_iterator

Definition at line 40 of file knnGraphKNearestQuery.h.

QueryType

template<typename Traits >

using Ponca::KnnGraphKNearestQuery< Traits >::QueryType = KNearestIndexQuery<typename Traits::IndexType, typename Traits::DataPoint::Scalar>

Definition at line 42 of file knnGraphKNearestQuery.h.

Self

template<typename Traits >

using Ponca::KnnGraphKNearestQuery< Traits >::Self = KnnGraphKNearestQuery<Traits>

Definition at line 46 of file knnGraphKNearestQuery.h.

Constructor & Destructor Documentation

KnnGraphKNearestQuery()

template<typename Traits >

Ponca::KnnGraphKNearestQuery< Traits >::KnnGraphKNearestQuery ( const KnnGraphBase< Traits > *  graph, int  index  )

inline

Definition at line 49 of file knnGraphKNearestQuery.h.

Member Function Documentation

begin()

template<typename Traits >

Iterator Ponca::KnnGraphKNearestQuery< Traits >::begin ( ) const

inline

Returns an iterator to the beginning of the k-nearest neighbors query.

Definition at line 58 of file knnGraphKNearestQuery.h.

end()

template<typename Traits >

Iterator Ponca::KnnGraphKNearestQuery< Traits >::end ( ) const

inline

Returns an iterator to the end of the k-nearest neighbors query.

Definition at line 63 of file knnGraphKNearestQuery.h.

operator()()

template<typename Traits >

Self & Ponca::KnnGraphKNearestQuery< Traits >::operator() ( int  index )

inline

Call the k-nearest neighbors query with new input parameter.

Definition at line 53 of file knnGraphKNearestQuery.h.

Member Data Documentation

m_graph

template<typename Traits >

const KnnGraphBase<Traits>* Ponca::KnnGraphKNearestQuery< Traits >::m_graph {nullptr}

protected

Definition at line 68 of file knnGraphKNearestQuery.h.