DTBRules< MetricType, TreeType > Class Template Reference

Public Types
typedef tree::TraversalInfo< TreeType >	TraversalInfoType

Public Member Functions
	DTBRules (const arma::mat &dataSet, UnionFind &connections, arma::vec &neighborsDistances, arma::Col< size_t > &neighborsInComponent, arma::Col< size_t > &neighborsOutComponent, MetricType &metric)
double	BaseCase (const size_t queryIndex, const size_t referenceIndex)
size_t	BaseCases () const
	Get the number of base cases performed. More...
size_t &	BaseCases ()
	Modify the number of base cases performed. More...
double	Rescore (const size_t queryIndex, TreeType &referenceNode, const double oldScore)
	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 node combinations that have been scored. More...
size_t &	Scores ()
	Modify the number of node combinations that have been scored. More...
const TraversalInfoType &	TraversalInfo () const
TraversalInfoType &	TraversalInfo ()

Detailed Description

template

<

typename

MetricType

,

typename

TreeType

>

class mlpack::emst::DTBRules< MetricType, TreeType >

Definition at line 23 of file dtb_rules.hpp.

Member Typedef Documentation

TraversalInfoType

typedef tree::TraversalInfo<TreeType> TraversalInfoType

Definition at line 85 of file dtb_rules.hpp.

Constructor & Destructor Documentation

DTBRules()

DTBRules	(	const arma::mat &	dataSet,
		UnionFind &	connections,
		arma::vec &	neighborsDistances,
		arma::Col< size_t > &	neighborsInComponent,
		arma::Col< size_t > &	neighborsOutComponent,
		MetricType &	metric
	)

Member Function Documentation

BaseCase()

double BaseCase	(	const size_t	queryIndex,
		const size_t	referenceIndex
	)

BaseCases() [1/2]

size_t BaseCases ( ) const

inline

Get the number of base cases performed.

Definition at line 91 of file dtb_rules.hpp.

BaseCases() [2/2]

size_t& BaseCases ( )

inline

Modify the number of base cases performed.

Definition at line 93 of file dtb_rules.hpp.

Rescore() [1/2]

double Rescore	(	const size_t	queryIndex,
		TreeType &	referenceNode,
		const double	oldScore
	)

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

queryIndex	Index of query point.
referenceNode	Candidate node to be recursed into.
oldScore	Old 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

queryNode	Candidate query node to recurse into.
referenceNode	Candidate reference node to recurse into.
oldScore	Old score produced by Socre() (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

queryIndex	Index of query point.
referenceNode	Candidate 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 recursionm while DBL_MAX indicates that the node should not be recursed into at all (it should be pruned).

Parameters

queryNode	Candidate query node to recurse into.
referenceNode	Candidate reference node to recurse into.

Scores() [1/2]

size_t Scores ( ) const

inline

Get the number of node combinations that have been scored.

Definition at line 96 of file dtb_rules.hpp.

Scores() [2/2]

size_t& Scores ( )

inline

Modify the number of node combinations that have been scored.

Definition at line 98 of file dtb_rules.hpp.

TraversalInfo() [1/2]

const TraversalInfoType& TraversalInfo ( ) const

inline

Definition at line 87 of file dtb_rules.hpp.

TraversalInfo() [2/2]

TraversalInfoType& TraversalInfo ( )

inline

Definition at line 88 of file dtb_rules.hpp.

---

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

• /home/ryan/src/mlpack.org/_src/mlpack-git/src/mlpack/methods/emst/dtb_rules.hpp