SYNOPSIS

Public Member Functions

TraversalInfo ()
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 score.

Detailed Description

template<typename TreeType>class TraversalInfo< TreeType >

The TraversalInfo class holds traversal information which is used in dual-tree (and single-tree) traversals.

A traversal should be updating the members of this class before Score() is called. This class should be held as a member of the RuleType class and the interface to it should be through a TraversalInfo() method.

The information held by this class is the last node combination visited before the current node combination was recursed into, and the score resulting from when Score() was called on that combination. However, this information is identical for a query node and a reference node in a particular node combination, so traversals only need to update the TraversalInfo object in a query node (and the algorithms should only use the TraversalInfo object from a query node).

In general, this auxiliary traversal information is used to try and make a prune without needing to call BaseCase() or calculate the distance between nodes. Using this information you can place bounds on the distance between the two nodes quickly.

If the traversal is not updating the members of this class correctly, a likely result is a null pointer dereference. Dual-tree algorithms should assume that the members are set properly and should not need to check for null pointers.

There is one exception, which is the root node combination; the score can be set to 0 and the query and reference nodes can just be set to the root nodes; no algorithm should be able to prune the root combination anyway.

Definition at line 57 of file traversal_info.hpp.

Constructor & Destructor Documentation

template<typename TreeType > TraversalInfo< TreeType >::TraversalInfo () [inline]

Create the TraversalInfo object and initialize the pointers to NULL.

Definition at line 63 of file traversal_info.hpp.

Member Function Documentation

template<typename TreeType > double TraversalInfo< TreeType >::LastBaseCase () const [inline]

Get the base case associated with the last node combination.

Definition at line 85 of file traversal_info.hpp.

References TraversalInfo< TreeType >::lastBaseCase.

template<typename TreeType > double& TraversalInfo< TreeType >::LastBaseCase () [inline]

Modify the base case associated with the last node combination.

Definition at line 87 of file traversal_info.hpp.

References TraversalInfo< TreeType >::lastBaseCase.

template<typename TreeType > TreeType* TraversalInfo< TreeType >::LastQueryNode () const [inline]

Get the last query node.

Definition at line 70 of file traversal_info.hpp.

References TraversalInfo< TreeType >::lastQueryNode.

template<typename TreeType > TreeType*& TraversalInfo< TreeType >::LastQueryNode () [inline]

Modify the last query node.

Definition at line 72 of file traversal_info.hpp.

References TraversalInfo< TreeType >::lastQueryNode.

template<typename TreeType > TreeType* TraversalInfo< TreeType >::LastReferenceNode () const [inline]

Get the last reference node.

Definition at line 75 of file traversal_info.hpp.

References TraversalInfo< TreeType >::lastReferenceNode.

template<typename TreeType > TreeType*& TraversalInfo< TreeType >::LastReferenceNode () [inline]

Modify the last reference node.

Definition at line 77 of file traversal_info.hpp.

References TraversalInfo< TreeType >::lastReferenceNode.

template<typename TreeType > double TraversalInfo< TreeType >::LastScore () const [inline]

Get the score associated with the last query and reference nodes.

Definition at line 80 of file traversal_info.hpp.

References TraversalInfo< TreeType >::lastScore.

template<typename TreeType > double& TraversalInfo< TreeType >::LastScore () [inline]

Modify the score associated with the last query and reference nodes.

Definition at line 82 of file traversal_info.hpp.

References TraversalInfo< TreeType >::lastScore.

Member Data Documentation

template<typename TreeType > double TraversalInfo< TreeType >::lastBaseCase [private]

The last base case.

Definition at line 97 of file traversal_info.hpp.

Referenced by TraversalInfo< TreeType >::LastBaseCase().

template<typename TreeType > TreeType* TraversalInfo< TreeType >::lastQueryNode [private]

The last query node.

Definition at line 91 of file traversal_info.hpp.

Referenced by TraversalInfo< TreeType >::LastQueryNode().

template<typename TreeType > TreeType* TraversalInfo< TreeType >::lastReferenceNode [private]

The last reference node.

Definition at line 93 of file traversal_info.hpp.

Referenced by TraversalInfo< TreeType >::LastReferenceNode().

template<typename TreeType > double TraversalInfo< TreeType >::lastScore [private]

The last score.

Definition at line 95 of file traversal_info.hpp.

Referenced by TraversalInfo< TreeType >::LastScore().

Author

Generated automatically by Doxygen for MLPACK from the source code.