MLPACK  1.0.8
Public Member Functions | Private Member Functions | Private Attributes | List of all members
mlpack::neighbor::NeighborSearchRules< SortPolicy, MetricType, TreeType > Class Template Reference

Public Member Functions

 NeighborSearchRules (const arma::mat &referenceSet, const arma::mat &querySet, arma::Mat< size_t > &neighbors, arma::mat &distances, MetricType &metric)
 
double BaseCase (const size_t queryIndex, const size_t referenceIndex)
 
double Rescore (const size_t queryIndex, TreeType &referenceNode, const double oldScore) const
 Re-evaluate the score for recursion order. More...
 
double Rescore (TreeType &queryNode, TreeType &referenceNode, const double oldScore) const
 Re-evaluate the score for recursion order. More...
 
double Score (const size_t queryIndex, TreeType &referenceNode)
 Get the score for recursion order. More...
 
double Score (TreeType &queryNode, TreeType &referenceNode)
 Get the score for recursion order. More...
 

Private Member Functions

double CalculateBound (TreeType &queryNode) const
 Recalculate the bound for a given query node. More...
 
void InsertNeighbor (const size_t queryIndex, const size_t pos, const size_t neighbor, const double distance)
 Insert a point into the neighbors and distances matrices; this is a helper function. More...
 

Private Attributes

arma::mat & distances
 The matrix the resultant neighbor distances should be stored in. More...
 
double lastBaseCase
 The last base case result. More...
 
size_t lastQueryIndex
 The last query point BaseCase() was called with. More...
 
size_t lastReferenceIndex
 The last reference point BaseCase() was called with. More...
 
MetricType & metric
 The instantiated metric. More...
 
arma::Mat< size_t > & neighbors
 The matrix the resultant neighbor indices should be stored in. More...
 
const arma::mat & querySet
 The query set. More...
 
const arma::mat & referenceSet
 The reference set. More...
 

Detailed Description

template<typename SortPolicy, typename MetricType, typename TreeType>
class mlpack::neighbor::NeighborSearchRules< SortPolicy, MetricType, TreeType >

Definition at line 30 of file neighbor_search_rules.hpp.

Constructor & Destructor Documentation

template<typename SortPolicy , typename MetricType , typename TreeType >
mlpack::neighbor::NeighborSearchRules< SortPolicy, MetricType, TreeType >::NeighborSearchRules ( const arma::mat &  referenceSet,
const arma::mat &  querySet,
arma::Mat< size_t > &  neighbors,
arma::mat &  distances,
MetricType &  metric 
)

Member Function Documentation

template<typename SortPolicy , typename MetricType , typename TreeType >
double mlpack::neighbor::NeighborSearchRules< SortPolicy, MetricType, TreeType >::BaseCase ( const size_t  queryIndex,
const size_t  referenceIndex 
)
template<typename SortPolicy , typename MetricType , typename TreeType >
double mlpack::neighbor::NeighborSearchRules< SortPolicy, MetricType, TreeType >::CalculateBound ( TreeType &  queryNode) const
private

Recalculate the bound for a given query node.

template<typename SortPolicy , typename MetricType , typename TreeType >
void mlpack::neighbor::NeighborSearchRules< SortPolicy, MetricType, TreeType >::InsertNeighbor ( const size_t  queryIndex,
const size_t  pos,
const size_t  neighbor,
const double  distance 
)
private

Insert a point into the neighbors and distances matrices; this is a helper function.

Parameters
queryIndexIndex of point whose neighbors we are inserting into.
posPosition in list to insert into.
neighborIndex of reference point which is being inserted.
distanceDistance from query point to reference point.
template<typename SortPolicy , typename MetricType , typename TreeType >
double mlpack::neighbor::NeighborSearchRules< SortPolicy, MetricType, TreeType >::Rescore ( const size_t  queryIndex,
TreeType &  referenceNode,
const double  oldScore 
) const

Re-evaluate the score for recursion order.

A low score indicates priority for recursion, while DBL_MAX indicates that the node should not be recursed into at all (it should be pruned). This is used when the score has already been calculated, but another recursion may have modified the bounds for pruning. So the old score is checked against the new pruning bound.

Parameters
queryIndexIndex of query point.
referenceNodeCandidate node to be recursed into.
oldScoreOld score produced by Score() (or Rescore()).
template<typename SortPolicy , typename MetricType , typename TreeType >
double mlpack::neighbor::NeighborSearchRules< SortPolicy, MetricType, TreeType >::Rescore ( TreeType &  queryNode,
TreeType &  referenceNode,
const double  oldScore 
) const

Re-evaluate the score for recursion order.

A low score indicates priority for recursion, while DBL_MAX indicates that the node should not be recursed into at all (it should be pruned). This is used when the score has already been calculated, but another recursion may have modified the bounds for pruning. So the old score is checked against the new pruning bound.

Parameters
queryNodeCandidate query node to recurse into.
referenceNodeCandidate reference node to recurse into.
oldScoreOld score produced by Socre() (or Rescore()).
template<typename SortPolicy , typename MetricType , typename TreeType >
double mlpack::neighbor::NeighborSearchRules< SortPolicy, MetricType, TreeType >::Score ( const size_t  queryIndex,
TreeType &  referenceNode 
)

Get the score for recursion order.

A low score indicates priority for recursion, while DBL_MAX indicates that the node should not be recursed into at all (it should be pruned).

Parameters
queryIndexIndex of query point.
referenceNodeCandidate node to be recursed into.
template<typename SortPolicy , typename MetricType , typename TreeType >
double mlpack::neighbor::NeighborSearchRules< SortPolicy, MetricType, TreeType >::Score ( TreeType &  queryNode,
TreeType &  referenceNode 
)

Get the score for recursion order.

A low score indicates priority for recursionm while DBL_MAX indicates that the node should not be recursed into at all (it should be pruned).

Parameters
queryNodeCandidate query node to recurse into.
referenceNodeCandidate reference node to recurse into.

Member Data Documentation

template<typename SortPolicy , typename MetricType , typename TreeType >
arma::mat& mlpack::neighbor::NeighborSearchRules< SortPolicy, MetricType, TreeType >::distances
private

The matrix the resultant neighbor distances should be stored in.

Definition at line 102 of file neighbor_search_rules.hpp.

template<typename SortPolicy , typename MetricType , typename TreeType >
double mlpack::neighbor::NeighborSearchRules< SortPolicy, MetricType, TreeType >::lastBaseCase
private

The last base case result.

Definition at line 112 of file neighbor_search_rules.hpp.

template<typename SortPolicy , typename MetricType , typename TreeType >
size_t mlpack::neighbor::NeighborSearchRules< SortPolicy, MetricType, TreeType >::lastQueryIndex
private

The last query point BaseCase() was called with.

Definition at line 108 of file neighbor_search_rules.hpp.

template<typename SortPolicy , typename MetricType , typename TreeType >
size_t mlpack::neighbor::NeighborSearchRules< SortPolicy, MetricType, TreeType >::lastReferenceIndex
private

The last reference point BaseCase() was called with.

Definition at line 110 of file neighbor_search_rules.hpp.

template<typename SortPolicy , typename MetricType , typename TreeType >
MetricType& mlpack::neighbor::NeighborSearchRules< SortPolicy, MetricType, TreeType >::metric
private

The instantiated metric.

Definition at line 105 of file neighbor_search_rules.hpp.

template<typename SortPolicy , typename MetricType , typename TreeType >
arma::Mat<size_t>& mlpack::neighbor::NeighborSearchRules< SortPolicy, MetricType, TreeType >::neighbors
private

The matrix the resultant neighbor indices should be stored in.

Definition at line 99 of file neighbor_search_rules.hpp.

template<typename SortPolicy , typename MetricType , typename TreeType >
const arma::mat& mlpack::neighbor::NeighborSearchRules< SortPolicy, MetricType, TreeType >::querySet
private

The query set.

Definition at line 96 of file neighbor_search_rules.hpp.

template<typename SortPolicy , typename MetricType , typename TreeType >
const arma::mat& mlpack::neighbor::NeighborSearchRules< SortPolicy, MetricType, TreeType >::referenceSet
private

The reference set.

Definition at line 93 of file neighbor_search_rules.hpp.


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