RPTreeMeanSplit< BoundType, MatType > Class Template Reference

This class splits a binary space tree. More...

Classes

struct  SplitInfo
 An information about the partition. More...

 

Public Types

typedef MatType::elem_type ElemType
 The element type held by the matrix type. More...

 

Static Public Member Functions

template
<
typename
VecType
>
static bool AssignToLeftNode (const VecType &point, const SplitInfo &splitInfo)
 Indicates that a point should be assigned to the left subtree. More...

 
static size_t PerformSplit (MatType &data, const size_t begin, const size_t count, const SplitInfo &splitInfo)
 Perform the split process according to the information about the split. More...

 
static size_t PerformSplit (MatType &data, const size_t begin, const size_t count, const SplitInfo &splitInfo, std::vector< size_t > &oldFromNew)
 Perform the split process according to the information about the split and return the list of changed indices. More...

 
static bool SplitNode (const BoundType &, MatType &data, const size_t begin, const size_t count, SplitInfo &splitInfo)
 Split the node according to the mean value in the dimension with maximum width. More...

 

Detailed Description


template
<
typename
BoundType
,
typename
MatType
=
arma::mat
>

class mlpack::tree::RPTreeMeanSplit< BoundType, MatType >

This class splits a binary space tree.

This class provides two different kinds of split. The mean split (i.e. all points are split by the median of their distance to the mean point) is performed if the average distance between points multiplied by a constant is greater than the diameter of the node. Otherwise, the median split (i.e. the node is split by a random hyperplane) is performed.

Definition at line 33 of file rp_tree_mean_split.hpp.

Member Typedef Documentation

◆ ElemType

typedef MatType::elem_type ElemType

The element type held by the matrix type.

Definition at line 37 of file rp_tree_mean_split.hpp.

Member Function Documentation

◆ AssignToLeftNode()

static bool AssignToLeftNode ( const VecType &  point,
const SplitInfo splitInfo 
)
inlinestatic

Indicates that a point should be assigned to the left subtree.

Parameters
pointThe point that is being assigned.
splitInfoAn information about the split.

Definition at line 125 of file rp_tree_mean_split.hpp.

References RPTreeMeanSplit< BoundType, MatType >::SplitInfo::direction, RPTreeMeanSplit< BoundType, MatType >::SplitInfo::mean, RPTreeMeanSplit< BoundType, MatType >::SplitInfo::meanSplit, and RPTreeMeanSplit< BoundType, MatType >::SplitInfo::splitVal.

◆ PerformSplit() [1/2]

static size_t PerformSplit ( MatType &  data,
const size_t  begin,
const size_t  count,
const SplitInfo splitInfo 
)
inlinestatic

Perform the split process according to the information about the split.

This will order the dataset such that points that belong to the left subtree are on the left of the split column, and points from the right subtree are on the right side of the split column.

Parameters
boundThe bound used for this node.
dataThe dataset used by the binary space tree.
beginIndex of the starting point in the dataset that belongs to this node.
countNumber of points in this node.
splitInfoThe information about the split.

Definition at line 83 of file rp_tree_mean_split.hpp.

◆ PerformSplit() [2/2]

static size_t PerformSplit ( MatType &  data,
const size_t  begin,
const size_t  count,
const SplitInfo splitInfo,
std::vector< size_t > &  oldFromNew 
)
inlinestatic

Perform the split process according to the information about the split and return the list of changed indices.

This will order the dataset such that points that belong to the left subtree are on the left of the split column, and points from the right subtree are on the right side of the split column.

Parameters
boundThe bound used for this node.
dataThe dataset used by the binary space tree.
beginIndex of the starting point in the dataset that belongs to this node.
countNumber of points in this node.
splitInfoThe information about the split.
oldFromNewVector which will be filled with the old positions for each new point.

Definition at line 108 of file rp_tree_mean_split.hpp.

◆ SplitNode()

static bool SplitNode ( const BoundType &  ,
MatType &  data,
const size_t  begin,
const size_t  count,
SplitInfo splitInfo 
)
static

Split the node according to the mean value in the dimension with maximum width.

Parameters
boundThe bound used for this node.
dataThe dataset used by the binary space tree.
beginIndex of the starting point in the dataset that belongs to this node.
countNumber of points in this node.
splitInfoAn information about the split. This information contains the direction and the value.

The documentation for this class was generated from the following file:
  • /home/jenkins-mlpack/mlpack.org/_src/mlpack-3.2.1/src/mlpack/core/tree/binary_space_tree/rp_tree_mean_split.hpp