TreeTraits< BinarySpaceTree< MetricType, StatisticType, MatType, BoundType, SplitType > > Class Template Reference

This is a specialization of the TreeTraits class to the BinarySpaceTree tree type. More...

Static Public Attributes

static const bool BinaryTree = true
 This is always a binary tree. More...

 
static const bool FirstPointIsCentroid = false
 There is no guarantee that the first point in a node is its centroid. More...

 
static const bool HasDuplicatedPoints = false
 Each binary space tree node doesn't share points with any other node. More...

 
static const bool HasOverlappingChildren = false
 Each binary space tree node has two children which represent non-overlapping subsets of the space which the node represents. More...

 
static const bool HasSelfChildren = false
 Points are not contained at multiple levels of the binary space tree. More...

 
static const bool RearrangesDataset = true
 Points are rearranged during building of the tree. More...

 
static const bool UniqueNumDescendants = true
 Binary space trees don't have duplicated points, so NumDescendants() represents the number of unique descendant points. More...

 

Detailed Description


template<typename MetricType, typename StatisticType, typename MatType, template< typename BoundMetricType, typename... > class BoundType, template< typename SplitBoundType, typename SplitMatType > class SplitType>
class mlpack::tree::TreeTraits< BinarySpaceTree< MetricType, StatisticType, MatType, BoundType, SplitType > >

This is a specialization of the TreeTraits class to the BinarySpaceTree tree type.

It defines characteristics of the binary space tree, and is used to help write tree-independent (but still optimized) tree-based algorithms. See mlpack/core/tree/tree_traits.hpp for more information.

Definition at line 33 of file traits.hpp.

Member Data Documentation

◆ BinaryTree

const bool BinaryTree = true
static

This is always a binary tree.

Definition at line 67 of file traits.hpp.

◆ FirstPointIsCentroid

const bool FirstPointIsCentroid = false
static

There is no guarantee that the first point in a node is its centroid.

Definition at line 52 of file traits.hpp.

◆ HasDuplicatedPoints

const bool HasDuplicatedPoints = false
static

Each binary space tree node doesn't share points with any other node.

Definition at line 47 of file traits.hpp.

◆ HasOverlappingChildren

const bool HasOverlappingChildren = false
static

Each binary space tree node has two children which represent non-overlapping subsets of the space which the node represents.

Therefore, children are not overlapping.

Definition at line 42 of file traits.hpp.

◆ HasSelfChildren

const bool HasSelfChildren = false
static

Points are not contained at multiple levels of the binary space tree.

Definition at line 57 of file traits.hpp.

◆ RearrangesDataset

const bool RearrangesDataset = true
static

Points are rearranged during building of the tree.

Definition at line 62 of file traits.hpp.

◆ UniqueNumDescendants

const bool UniqueNumDescendants = true
static

Binary space trees don't have duplicated points, so NumDescendants() represents the number of unique descendant points.

Definition at line 73 of file traits.hpp.


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/traits.hpp