RAModel< SortPolicy > Class Template Reference

The RAModel class provides an abstraction for the RASearch class, abstracting away the TreeType parameter and allowing it to be specified at runtime in this class. More...

Public Types

enum  TreeTypes
{
  KD_TREE
,
  COVER_TREE
,
  R_TREE
,
  R_STAR_TREE
,
  X_TREE
,
  HILBERT_R_TREE
,
  R_PLUS_TREE
,
  R_PLUS_PLUS_TREE
,
  UB_TREE
,
  OCTREE

}
 The list of tree types we can use with RASearch. More...

 

Public Member Functions

 RAModel (TreeTypes treeType=TreeTypes::KD_TREE, bool randomBasis=false)
 Initialize the RAModel with the given type and whether or not a random basis should be used. More...

 
 RAModel (const RAModel &other)
 Copy the given RAModel. More...

 
 RAModel (RAModel &&other)
 Take ownership of the given RAModel. More...

 
 ~RAModel ()
 Clean memory, if necessary. More...

 
double Alpha () const
 Get the desired success probability. More...

 
double & Alpha ()
 Modify the desired success probability. More...

 
void BuildModel (arma::mat &&referenceSet, const size_t leafSize, const bool naive, const bool singleMode)
 Build the reference tree. More...

 
const arma::mat & Dataset () const
 Expose the dataset. More...

 
bool FirstLeafExact () const
 Get whether or not we traverse to the first leaf without approximation. More...

 
bool & FirstLeafExact ()
 Modify whether or not we traverse to the first leaf without approximation. More...

 
size_t LeafSize () const
 Get the leaf size (only relevant when the kd-tree is used). More...

 
size_t & LeafSize ()
 Modify the leaf size (only relevant when the kd-tree is used). More...

 
bool Naive () const
 Get whether or not naive search is being used. More...

 
bool & Naive ()
 Modify whether or not naive search is being used. More...

 
RAModeloperator= (const RAModel &other)
 Copy the given RAModel. More...

 
RAModeloperator= (RAModel &&other)
 Take ownership of the given RAModel. More...

 
bool RandomBasis () const
 Get whether or not a random basis is being used. More...

 
bool & RandomBasis ()
 Modify whether or not a random basis is being used. More...

 
bool SampleAtLeaves () const
 Get whether or not sampling is done at the leaves. More...

 
bool & SampleAtLeaves ()
 Modify whether or not sampling is done at the leaves. More...

 
void Search (arma::mat &&querySet, const size_t k, arma::Mat< size_t > &neighbors, arma::mat &distances)
 Perform rank-approximate neighbor search, taking ownership of the query set. More...

 
void Search (const size_t k, arma::Mat< size_t > &neighbors, arma::mat &distances)
 Perform rank-approximate neighbor search, using the reference set as the query set. More...

 
template
<
typename
Archive
>
void serialize (Archive &ar, const unsigned int)
 Serialize the model. More...

 
bool SingleMode () const
 Get whether or not single-tree search is being used. More...

 
bool & SingleMode ()
 Modify whether or not single-tree search is being used. More...

 
size_t SingleSampleLimit () const
 Get the limit on the size of a node that can be approximated. More...

 
size_t & SingleSampleLimit ()
 Modify the limit on the size of a node that can be approximation. More...

 
double Tau () const
 Get the rank-approximation in percentile of the data. More...

 
double & Tau ()
 Modify the rank-approximation in percentile of the data. More...

 
std::string TreeName () const
 Get the name of the tree type. More...

 
TreeTypes TreeType () const
 Get the type of tree being used. More...

 
TreeTypesTreeType ()
 Modify the type of tree being used. More...

 

Detailed Description


template
<
typename
SortPolicy
>

class mlpack::neighbor::RAModel< SortPolicy >

The RAModel class provides an abstraction for the RASearch class, abstracting away the TreeType parameter and allowing it to be specified at runtime in this class.

This class is written for the sake of the 'allkrann' program, but is not necessarily restricted to that use.

Parameters
SortPolicySorting policy for neighbor searching (see RASearch).

Definition at line 271 of file ra_model.hpp.

Member Enumeration Documentation

◆ TreeTypes

enum TreeTypes

The list of tree types we can use with RASearch.

Does not include ball trees; see #338.

Enumerator
KD_TREE 
COVER_TREE 
R_TREE 
R_STAR_TREE 
X_TREE 
HILBERT_R_TREE 
R_PLUS_TREE 
R_PLUS_PLUS_TREE 
UB_TREE 
OCTREE 

Definition at line 278 of file ra_model.hpp.

Constructor & Destructor Documentation

◆ RAModel() [1/3]

RAModel ( TreeTypes  treeType = TreeTypes::KD_TREE,
bool  randomBasis = false 
)

Initialize the RAModel with the given type and whether or not a random basis should be used.

◆ RAModel() [2/3]

RAModel ( const RAModel< SortPolicy > &  other)

Copy the given RAModel.

Parameters
otherRAModel to copy.

◆ RAModel() [3/3]

RAModel ( RAModel< SortPolicy > &&  other)

Take ownership of the given RAModel.

Parameters
otherRAModel to take ownership of.

◆ ~RAModel()

~RAModel ( )

Clean memory, if necessary.

Member Function Documentation

◆ Alpha() [1/2]

double Alpha ( ) const

Get the desired success probability.

◆ Alpha() [2/2]

double& Alpha ( )

Modify the desired success probability.

◆ BuildModel()

void BuildModel ( arma::mat &&  referenceSet,
const size_t  leafSize,
const bool  naive,
const bool  singleMode 
)

Build the reference tree.

◆ Dataset()

const arma::mat& Dataset ( ) const

Expose the dataset.

◆ FirstLeafExact() [1/2]

bool FirstLeafExact ( ) const

Get whether or not we traverse to the first leaf without approximation.

◆ FirstLeafExact() [2/2]

bool& FirstLeafExact ( )

Modify whether or not we traverse to the first leaf without approximation.

◆ LeafSize() [1/2]

size_t LeafSize ( ) const

Get the leaf size (only relevant when the kd-tree is used).

◆ LeafSize() [2/2]

size_t& LeafSize ( )

Modify the leaf size (only relevant when the kd-tree is used).

◆ Naive() [1/2]

bool Naive ( ) const

Get whether or not naive search is being used.

◆ Naive() [2/2]

bool& Naive ( )

Modify whether or not naive search is being used.

◆ operator=() [1/2]

RAModel& operator= ( const RAModel< SortPolicy > &  other)

Copy the given RAModel.

Parameters
otherRAModel to copy.

◆ operator=() [2/2]

RAModel& operator= ( RAModel< SortPolicy > &&  other)

Take ownership of the given RAModel.

Parameters
otherRAModel to take ownership of.

◆ RandomBasis() [1/2]

bool RandomBasis ( ) const

Get whether or not a random basis is being used.

◆ RandomBasis() [2/2]

bool& RandomBasis ( )

Modify whether or not a random basis is being used.

Be sure to rebuild the model using BuildModel().

◆ SampleAtLeaves() [1/2]

bool SampleAtLeaves ( ) const

Get whether or not sampling is done at the leaves.

◆ SampleAtLeaves() [2/2]

bool& SampleAtLeaves ( )

Modify whether or not sampling is done at the leaves.

◆ Search() [1/2]

void Search ( arma::mat &&  querySet,
const size_t  k,
arma::Mat< size_t > &  neighbors,
arma::mat &  distances 
)

Perform rank-approximate neighbor search, taking ownership of the query set.

◆ Search() [2/2]

void Search ( const size_t  k,
arma::Mat< size_t > &  neighbors,
arma::mat &  distances 
)

Perform rank-approximate neighbor search, using the reference set as the query set.

◆ serialize()

void serialize ( Archive &  ar,
const unsigned  int 
)

Serialize the model.

◆ SingleMode() [1/2]

bool SingleMode ( ) const

Get whether or not single-tree search is being used.

◆ SingleMode() [2/2]

bool& SingleMode ( )

Modify whether or not single-tree search is being used.

◆ SingleSampleLimit() [1/2]

size_t SingleSampleLimit ( ) const

Get the limit on the size of a node that can be approximated.

◆ SingleSampleLimit() [2/2]

size_t& SingleSampleLimit ( )

Modify the limit on the size of a node that can be approximation.

◆ Tau() [1/2]

double Tau ( ) const

Get the rank-approximation in percentile of the data.

◆ Tau() [2/2]

double& Tau ( )

Modify the rank-approximation in percentile of the data.

◆ TreeName()

std::string TreeName ( ) const

Get the name of the tree type.

◆ TreeType() [1/2]

TreeTypes TreeType ( ) const

Get the type of tree being used.

◆ TreeType() [2/2]

TreeTypes& TreeType ( )

Modify the type of tree being used.


The documentation for this class was generated from the following file:
  • /home/jenkins-mlpack/mlpack.org/_src/mlpack-3.2.1/src/mlpack/methods/rann/ra_model.hpp