NAME¶

mlpack::neighbor::NeighborSearchTraversalInfo< TreeType > - Traversal information for NeighborSearch.

SYNOPSIS¶

Public Member Functions¶

NeighborSearchTraversalInfo () Create the TraversalInfo object and initialize the pointers to NULL. double LastBaseCase () const Get the base case associated with the last node combination. double & LastBaseCase () Modify the base case associated with the last node combination. TreeType * LastQueryNode () const Get the last query node. TreeType *& LastQueryNode () Modify the last query node. TreeType * LastReferenceNode () const Get the last reference node. TreeType *& LastReferenceNode () Modify the last reference node. double LastScore () const Get the score associated with the last query and reference nodes. double & LastScore () Modify the score associated with the last query and reference nodes.

Private Attributes¶

double lastBaseCase The last base case. TreeType * lastQueryNode The last query node. TreeType * lastReferenceNode The last reference node. double lastScore The last distance.

Detailed Description¶

template<typename TreeType>class mlpack::neighbor::NeighborSearchTraversalInfo< TreeType >¶

Traversal information for NeighborSearch. This information is used to make parent-child prunes or parent-parent prunes in Score() without needing to evaluate the distance between two nodes. The information held by this class is the last node combination visited before the current node combination was recursed into and the distance between the node centroids. Definition at line 39 of file ns_traversal_info.hpp.

Constructor & Destructor Documentation¶

template<typename TreeType > mlpack::neighbor::NeighborSearchTraversalInfo< TreeType >:: NeighborSearchTraversalInfo () [inline]¶

Create the TraversalInfo object and initialize the pointers to NULL. Definition at line 45 of file ns_traversal_info.hpp.

Member Function Documentation¶

template<typename TreeType > double mlpack::neighbor::NeighborSearchTraversalInfo< TreeType >::LastBaseCase () const [inline]¶

Get the base case associated with the last node combination. Definition at line 67 of file ns_traversal_info.hpp. References mlpack::neighbor::NeighborSearchTraversalInfo< TreeType >::lastBaseCase.

template<typename TreeType > double& mlpack::neighbor::NeighborSearchTraversalInfo< TreeType >::LastBaseCase () [inline]¶

Modify the base case associated with the last node combination. Definition at line 69 of file ns_traversal_info.hpp. References mlpack::neighbor::NeighborSearchTraversalInfo< TreeType >::lastBaseCase.

template<typename TreeType > TreeType* mlpack::neighbor::NeighborSearchTraversalInfo< TreeType >::LastQueryNode () const [inline]¶

Get the last query node. Definition at line 52 of file ns_traversal_info.hpp. References mlpack::neighbor::NeighborSearchTraversalInfo< TreeType >::lastQueryNode.

template<typename TreeType > TreeType*& mlpack::neighbor::NeighborSearchTraversalInfo< TreeType >::LastQueryNode () [inline]¶

Modify the last query node. Definition at line 54 of file ns_traversal_info.hpp. References mlpack::neighbor::NeighborSearchTraversalInfo< TreeType >::lastQueryNode.

template<typename TreeType > TreeType* mlpack::neighbor::NeighborSearchTraversalInfo< TreeType >::LastReferenceNode () const [inline]¶

Get the last reference node. Definition at line 57 of file ns_traversal_info.hpp. References mlpack::neighbor::NeighborSearchTraversalInfo< TreeType >::lastReferenceNode.

template<typename TreeType > TreeType*& mlpack::neighbor::NeighborSearchTraversalInfo< TreeType >::LastReferenceNode () [inline]¶

Modify the last reference node. Definition at line 59 of file ns_traversal_info.hpp. References mlpack::neighbor::NeighborSearchTraversalInfo< TreeType >::lastReferenceNode.

template<typename TreeType > double mlpack::neighbor::NeighborSearchTraversalInfo< TreeType >::LastScore () const [inline]¶

Get the score associated with the last query and reference nodes. Definition at line 62 of file ns_traversal_info.hpp. References mlpack::neighbor::NeighborSearchTraversalInfo< TreeType >::lastScore.

template<typename TreeType > double& mlpack::neighbor::NeighborSearchTraversalInfo< TreeType >::LastScore () [inline]¶

Modify the score associated with the last query and reference nodes. Definition at line 64 of file ns_traversal_info.hpp. References mlpack::neighbor::NeighborSearchTraversalInfo< TreeType >::lastScore.

Member Data Documentation¶

template<typename TreeType > double mlpack::neighbor::NeighborSearchTraversalInfo< TreeType >::lastBaseCase [private]¶

The last base case. Definition at line 79 of file ns_traversal_info.hpp. Referenced by mlpack::neighbor::NeighborSearchTraversalInfo< TreeType >::LastBaseCase().

template<typename TreeType > TreeType* mlpack::neighbor::NeighborSearchTraversalInfo< TreeType >::lastQueryNode [private]¶

The last query node. Definition at line 73 of file ns_traversal_info.hpp. Referenced by mlpack::neighbor::NeighborSearchTraversalInfo< TreeType >::LastQueryNode().

template<typename TreeType > TreeType* mlpack::neighbor::NeighborSearchTraversalInfo< TreeType >::lastReferenceNode [private]¶

The last reference node. Definition at line 75 of file ns_traversal_info.hpp. Referenced by mlpack::neighbor::NeighborSearchTraversalInfo< TreeType >::LastReferenceNode().

template<typename TreeType > double mlpack::neighbor::NeighborSearchTraversalInfo< TreeType >::lastScore [private]¶

The last distance. Definition at line 77 of file ns_traversal_info.hpp. Referenced by mlpack::neighbor::NeighborSearchTraversalInfo< TreeType >::LastScore().

Author¶

Generated automatically by Doxygen for MLPACK from the source code.