mlpack  2.2.5
FastMKSStat Class Reference

The statistic used in trees with FastMKS. More...

Public Member Functions

 FastMKSStat ()
 Default initialization. More...

 
template
<
typename
TreeType
>
 FastMKSStat (const TreeType &node)
 Initialize this statistic for the given tree node. More...

 
double Bound () const
 Get the bound. More...

 
double & Bound ()
 Modify the bound. More...

 
double LastKernel () const
 Get the last kernel evaluation. More...

 
double & LastKernel ()
 Modify the last kernel evaluation. More...

 
void * LastKernelNode () const
 Get the address of the node corresponding to the last distance evaluation. More...

 
void *& LastKernelNode ()
 Modify the address of the node corresponding to the last distance evaluation. More...

 
double SelfKernel () const
 Get the self-kernel. More...

 
double & SelfKernel ()
 Modify the self-kernel. More...

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

 

Detailed Description

The statistic used in trees with FastMKS.

This stores both the bound and the self-kernels for each node in the tree.

Definition at line 25 of file fastmks_stat.hpp.

Constructor & Destructor Documentation

◆ FastMKSStat() [1/2]

FastMKSStat ( )
inline

Default initialization.

Definition at line 31 of file fastmks_stat.hpp.

◆ FastMKSStat() [2/2]

FastMKSStat ( const TreeType &  node)
inline

Initialize this statistic for the given tree node.

The TreeType's metric better be IPMetric with some kernel type (that is, Metric().Kernel() must exist).

Parameters
nodeNode that this statistic is built for.

Definition at line 46 of file fastmks_stat.hpp.

Member Function Documentation

◆ Bound() [1/2]

double Bound ( ) const
inline

Get the bound.

Definition at line 86 of file fastmks_stat.hpp.

◆ Bound() [2/2]

double& Bound ( )
inline

Modify the bound.

Definition at line 88 of file fastmks_stat.hpp.

◆ LastKernel() [1/2]

double LastKernel ( ) const
inline

Get the last kernel evaluation.

Definition at line 91 of file fastmks_stat.hpp.

◆ LastKernel() [2/2]

double& LastKernel ( )
inline

Modify the last kernel evaluation.

Definition at line 93 of file fastmks_stat.hpp.

◆ LastKernelNode() [1/2]

void* LastKernelNode ( ) const
inline

Get the address of the node corresponding to the last distance evaluation.

Definition at line 96 of file fastmks_stat.hpp.

◆ LastKernelNode() [2/2]

void*& LastKernelNode ( )
inline

Modify the address of the node corresponding to the last distance evaluation.

Definition at line 99 of file fastmks_stat.hpp.

◆ SelfKernel() [1/2]

double SelfKernel ( ) const
inline

Get the self-kernel.

Definition at line 81 of file fastmks_stat.hpp.

◆ SelfKernel() [2/2]

double& SelfKernel ( )
inline

Modify the self-kernel.

Definition at line 83 of file fastmks_stat.hpp.

◆ Serialize()

void Serialize ( Archive &  ar,
const unsigned  int 
)
inline

Serialize the statistic.

Definition at line 103 of file fastmks_stat.hpp.

References mlpack::data::CreateNVP().


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