RangeSearchRules< MetricType, TreeType > Class Template Reference

The RangeSearchRules class is a template helper class used by RangeSearch class when performing range searches. More...

Public Types

typedef tree::TraversalInfo< TreeType > TraversalInfoType
 

Public Member Functions

 RangeSearchRules (const arma::mat &referenceSet, const arma::mat &querySet, const math::Range &range, std::vector< std::vector< size_t > > &neighbors, std::vector< std::vector< double > > &distances, MetricType &metric, const bool sameSet=false)
 Construct the RangeSearchRules object. More...

 
double BaseCase (const size_t queryIndex, const size_t referenceIndex)
 Compute the base case between the given query point and reference point. More...

 
size_t BaseCases () const
 Get the number of base cases. More...

 
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...

 
size_t Scores () const
 Get the number of scores (that is, calls to RangeDistance()). More...

 
const TraversalInfoTypeTraversalInfo () const
 
TraversalInfoTypeTraversalInfo ()
 

Detailed Description


template
<
typename
MetricType
,
typename
TreeType
>

class mlpack::range::RangeSearchRules< MetricType, TreeType >

The RangeSearchRules class is a template helper class used by RangeSearch class when performing range searches.

Template Parameters
MetricTypeThe metric to use for computation.
TreeTypeThe tree type to use; must adhere to the TreeType API.

Definition at line 28 of file range_search_rules.hpp.

Member Typedef Documentation

◆ TraversalInfoType

Definition at line 110 of file range_search_rules.hpp.

Constructor & Destructor Documentation

◆ RangeSearchRules()

RangeSearchRules ( const arma::mat &  referenceSet,
const arma::mat &  querySet,
const math::Range range,
std::vector< std::vector< size_t > > &  neighbors,
std::vector< std::vector< double > > &  distances,
MetricType &  metric,
const bool  sameSet = false 
)

Construct the RangeSearchRules object.

This is usually done from within the RangeSearch class at search time.

Parameters
referenceSetSet of reference data.
querySetSet of query data.
rangeRange to search for.
neighborsVector to store resulting neighbors in.
distancesVector to store resulting distances in.
metricInstantiated metric.
sameSetIf true, the query and reference set are taken to be the same, and a query point will not return itself in the results.

Member Function Documentation

◆ BaseCase()

double BaseCase ( const size_t  queryIndex,
const size_t  referenceIndex 
)

Compute the base case between the given query point and reference point.

Parameters
queryIndexIndex of query point.
referenceIndexIndex of reference point.

◆ BaseCases()

size_t BaseCases ( ) const
inline

Get the number of base cases.

Definition at line 116 of file range_search_rules.hpp.

◆ Rescore() [1/2]

double 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()).

◆ Rescore() [2/2]

double 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 Score() (or Rescore()).

◆ Score() [1/2]

double 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.

◆ Score() [2/2]

double Score ( TreeType &  queryNode,
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
queryNodeCandidate query node to recurse into.
referenceNodeCandidate reference node to recurse into.

◆ Scores()

size_t Scores ( ) const
inline

Get the number of scores (that is, calls to RangeDistance()).

Definition at line 118 of file range_search_rules.hpp.

◆ TraversalInfo() [1/2]

const TraversalInfoType& TraversalInfo ( ) const
inline

Definition at line 112 of file range_search_rules.hpp.

◆ TraversalInfo() [2/2]

TraversalInfoType& TraversalInfo ( )
inline

Definition at line 113 of file range_search_rules.hpp.


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