Classes
class	DualTreeTraverser
	A dual-tree traverser; see dual_tree_traverser.hpp. More...

class	SingleTreeTraverser
	A single-tree traverser; see single_tree_traverser.hpp. More...

Public Types
typedef MatType	Mat
	So other classes can use TreeType::Mat.

typedef MatType::elem_type	ElemType
	The type of element held in MatType.

Public Member Functions
	Octree (const MatType &data, const size_t maxLeafSize=20)
	Construct this as the root node of an octree on the given dataset. More...

	Octree (const MatType &data, std::vector< size_t > &oldFromNew, const size_t maxLeafSize=20)
	Construct this as the root node of an octree on the given dataset. More...

	Octree (const MatType &data, std::vector< size_t > &oldFromNew, std::vector< size_t > &newFromOld, const size_t maxLeafSize=20)
	Construct this as the root node of an octree on the given dataset. More...

	Octree (MatType &&data, const size_t maxLeafSize=20)
	Construct this as the root node of an octree on the given dataset. More...

	Octree (MatType &&data, std::vector< size_t > &oldFromNew, const size_t maxLeafSize=20)
	Construct this as the root node of an octree on the given dataset. More...

	Octree (MatType &&data, std::vector< size_t > &oldFromNew, std::vector< size_t > &newFromOld, const size_t maxLeafSize=20)
	Construct this as the root node of an octree on the given dataset. More...

	Octree (Octree *parent, const size_t begin, const size_t count, const arma::vec &center, const double width, const size_t maxLeafSize=20)
	Construct this node as a child of the given parent, starting at column begin and using count points. More...

	Octree (Octree *parent, const size_t begin, const size_t count, std::vector< size_t > &oldFromNew, const arma::vec &center, const double width, const size_t maxLeafSize=20)
	Construct this node as a child of the given parent, starting at column begin and using count points. More...

	Octree (const Octree &other)
	Copy the given tree. More...

	Octree (Octree &&other)
	Move the given tree. More...

Octree &	operator= (const Octree &other)
	Copy the given Octree. More...

Octree &	operator= (Octree &&other)
	Take ownership of the given Octree. More...

template<typename Archive >
	Octree (Archive &ar, const typename std::enable_if_t< cereal::is_loading< Archive >()> *=0)
	Initialize the tree from a cereal archive. More...

	~Octree ()
	Destroy the tree.

const MatType &	Dataset () const
	Return the dataset used by this node.

Octree *	Parent () const
	Get the pointer to the parent.

Octree *&	Parent ()
	Modify the pointer to the parent (be careful!).

const bound::HRectBound< MetricType > &	Bound () const
	Return the bound object for this node.

bound::HRectBound< MetricType > &	Bound ()
	Modify the bound object for this node.

const StatisticType &	Stat () const
	Return the statistic object for this node.

StatisticType &	Stat ()
	Modify the statistic object for this node.

size_t	NumChildren () const
	Return the number of children in this node.

MetricType	Metric () const
	Return the metric that this tree uses.

template<typename VecType >
size_t	GetNearestChild (const VecType &point, typename std::enable_if_t< IsVector< VecType >::value > *=0) const
	Return the index of the nearest child node to the given query point. More...

template<typename VecType >
size_t	GetFurthestChild (const VecType &point, typename std::enable_if_t< IsVector< VecType >::value > *=0) const
	Return the index of the furthest child node to the given query point. More...

bool	IsLeaf () const
	Return whether or not the node is a leaf.

size_t	GetNearestChild (const Octree &queryNode) const
	Return the index of the nearest child node to the given query node. More...

size_t	GetFurthestChild (const Octree &queryNode) const
	Return the index of the furthest child node to the given query node. More...

ElemType	FurthestPointDistance () const
	Return the furthest distance to a point held in this node. More...

ElemType	FurthestDescendantDistance () const
	Return the furthest possible descendant distance. More...

ElemType	MinimumBoundDistance () const
	Return the minimum distance from the center of the node to any bound edge.

ElemType	ParentDistance () const
	Return the distance from the center of this node to the center of the parent node. More...

ElemType &	ParentDistance ()
	Modify the distance from the center of this node to the center of the parent node. More...

const Octree &	Child (const size_t child) const
	Return the specified child. More...

Octree &	Child (const size_t child)
	Return the specified child. More...

Octree *&	ChildPtr (const size_t child)
	Return the pointer to the given child. More...

size_t	NumPoints () const
	Return the number of points in this node (0 if not a leaf).

size_t	NumDescendants () const
	Return the number of descendants of this node.

size_t	Descendant (const size_t index) const
	Return the index (with reference to the dataset) of a particular descendant.

size_t	Point (const size_t index) const
	Return the index (with reference to the dataset) of a particular point in this node. More...

ElemType	MinDistance (const Octree &other) const
	Return the minimum distance to another node.

ElemType	MaxDistance (const Octree &other) const
	Return the maximum distance to another node.

math::RangeType< ElemType >	RangeDistance (const Octree &other) const
	Return the minimum and maximum distance to another node.

template<typename VecType >
ElemType	MinDistance (const VecType &point, typename std::enable_if_t< IsVector< VecType >::value > *=0) const
	Return the minimum distance to the given point.

template<typename VecType >
ElemType	MaxDistance (const VecType &point, typename std::enable_if_t< IsVector< VecType >::value > *=0) const
	Return the maximum distance to the given point.

template<typename VecType >
math::RangeType< ElemType >	RangeDistance (const VecType &point, typename std::enable_if_t< IsVector< VecType >::value > *=0) const
	Return the minimum and maximum distance to another node.

void	Center (arma::vec &center) const
	Store the center of the bounding region in the given vector.

template<typename Archive >
void	serialize (Archive &ar, const uint32_t)
	Serialize the tree.

template<typename VecType >
math::RangeType< typename Octree< MetricType, StatisticType, MatType >::ElemType >	RangeDistance (const VecType &point, typename std::enable_if_t< IsVector< VecType >::value > *) const

Protected Member Functions
	Octree ()
	A default constructor. More...

Friends
class	cereal::access
	Friend access is given for the default constructor.

Constructor & Destructor Documentation

◆ Octree() [1/12]

template<typename MetricType , typename StatisticType , typename MatType>

mlpack::tree::Octree< MetricType, StatisticType, MatType >::Octree	(	const MatType &	data,
		const size_t	maxLeafSize = `20`
	)

Construct this as the root node of an octree on the given dataset.

Construct the tree.

This copies the dataset. If you don't want to copy the input dataset, consider using the constructor that takes an rvalue reference and use std::move().

Parameters

data	Dataset to create tree from. This will be copied!
maxLeafSize	Maximum number of points in a leaf node.

◆ Octree() [2/12]

template<typename MetricType , typename StatisticType , typename MatType>

mlpack::tree::Octree< MetricType, StatisticType, MatType >::Octree	(	const MatType &	data,
		std::vector< size_t > &	oldFromNew,
		const size_t	maxLeafSize = `20`
	)

Construct this as the root node of an octree on the given dataset.

Construct the tree.

This copies the dataset and modifies its ordering; a mapping of the old point indices to the new point indices is filled. If you don't want the matrix to be copied, consider using the constructor that takes an rvalue reference and use std::move().

Parameters

data	Dataset to create tree from. This will be copied!
oldFromNew	Vector which will be filled with the old positions for each new point.
maxLeafSize	Maximum number of points in a leaf node.

◆ Octree() [3/12]

template<typename MetricType , typename StatisticType , typename MatType>

mlpack::tree::Octree< MetricType, StatisticType, MatType >::Octree	(	const MatType &	data,
		std::vector< size_t > &	oldFromNew,
		std::vector< size_t > &	newFromOld,
		const size_t	maxLeafSize = `20`
	)

Construct this as the root node of an octree on the given dataset.

Construct the tree.

This copies the dataset and modifies its ordering; a mapping of the old point indices to the new point indices is filled, and a mapping of the new point indices to the old point indices is filled. If you don't want the matrix to be copied, consider using the constructor that takes an rvalue reference and use std::move().

Parameters

data	Dataset to create tree from. This will be copied!
oldFromNew	Vector which will be filled with the old positions for each new point.
newFromOld	Vector which will be filled with the new positions for each old point.
maxLeafSize	Maximum number of points in a leaf node.

◆ Octree() [4/12]

template<typename MetricType , typename StatisticType , typename MatType>

mlpack::tree::Octree< MetricType, StatisticType, MatType >::Octree	(	MatType &&	data,
		const size_t	maxLeafSize = `20`
	)

Construct this as the root node of an octree on the given dataset.

Construct the tree.

This will take ownership of the dataset; if you don't want this, consider using the constructor that takes a const reference to the dataset.

Parameters

data	Dataset to create tree from. This will be copied!
maxLeafSize	Maximum number of points in a leaf node.

◆ Octree() [5/12]

template<typename MetricType , typename StatisticType , typename MatType>

mlpack::tree::Octree< MetricType, StatisticType, MatType >::Octree	(	MatType &&	data,
		std::vector< size_t > &	oldFromNew,
		const size_t	maxLeafSize = `20`
	)

Construct this as the root node of an octree on the given dataset.

Construct the tree.

This will take ownership of the dataset; if you don't want this, consider using the constructor that takes a const reference to the dataset. This modifies the ordering of the dataset; a mapping of the old point indices to the new point indices is filled.

Parameters

data	Dataset to create tree from. This will be copied!
oldFromNew	Vector which will be filled with the old positions for each new point.
maxLeafSize	Maximum number of points in a leaf node.

◆ Octree() [6/12]

template<typename MetricType , typename StatisticType , typename MatType>

mlpack::tree::Octree< MetricType, StatisticType, MatType >::Octree	(	MatType &&	data,
		std::vector< size_t > &	oldFromNew,
		std::vector< size_t > &	newFromOld,
		const size_t	maxLeafSize = `20`
	)

Construct this as the root node of an octree on the given dataset.

Construct the tree.

This will take ownership of the dataset; if you don't want this, consider using the constructor that takes a const reference to the dataset. This modifies the ordering of the dataset; a mapping of the old point indices to the new point indices is filled, and a mapping of the new point indices to the old point indices is filled.

Parameters

data	Dataset to create tree from. This will be copied!
oldFromNew	Vector which will be filled with the old positions for each new point.
newFromOld	Vector which will be filled with the new positions for each old point.
maxLeafSize	Maximum number of points in a leaf node.

◆ Octree() [7/12]

template<typename MetricType , typename StatisticType , typename MatType>

mlpack::tree::Octree< MetricType, StatisticType, MatType >::Octree	(	Octree< MetricType, StatisticType, MatType > *	parent,
		const size_t	begin,
		const size_t	count,
		const arma::vec &	center,
		const double	width,
		const size_t	maxLeafSize = `20`
	)

Construct this node as a child of the given parent, starting at column begin and using count points.

Construct a child node.

The ordering of that subset of points in the parent's data matrix will be modified! This is used for recursive tree-building by the other constructors that don't specify point indices.

Parameters

parent	Parent of this node. Its dataset will be modified!
begin	Index of point to start tree construction with.
count	Number of points to use to construct tree.
center	Center of the node (for splitting).
width	Width of the node in each dimension.
maxLeafSize	Maximum number of points in a leaf node.

◆ Octree() [8/12]

template<typename MetricType , typename StatisticType , typename MatType>

mlpack::tree::Octree< MetricType, StatisticType, MatType >::Octree	(	Octree< MetricType, StatisticType, MatType > *	parent,
		const size_t	begin,
		const size_t	count,
		std::vector< size_t > &	oldFromNew,
		const arma::vec &	center,
		const double	width,
		const size_t	maxLeafSize = `20`
	)

Construct this node as a child of the given parent, starting at column begin and using count points.

Construct a child node.

The ordering of that subset of points in the parent's data matrix will be modified! This is used for recursive tree-building by the other constructors that don't specify point indices.

A mapping of the old point indices to the new point indices is filled, but it is expected that the vector is already allocated with size greater than or equal to (begin + count), and if that is not true, invalid memory reads (and writes) will occur.

Parameters

parent	Parent of this node. Its dataset will be modified!
begin	Index of point to start tree construction with.
count	Number of points to use to construct tree.
oldFromNew	Vector which will be filled with the old positions for each new point.
center	Center of the node (for splitting).
width	Width of the node in each dimension.
maxLeafSize	Maximum number of points in a leaf node.

◆ Octree() [9/12]

template<typename MetricType , typename StatisticType , typename MatType>

mlpack::tree::Octree< MetricType, StatisticType, MatType >::Octree ( const Octree< MetricType, StatisticType, MatType > & other )

Copy the given tree.

Be careful! This may use a lot of memory.

Parameters

other Tree to copy from.

◆ Octree() [10/12]

template<typename MetricType , typename StatisticType , typename MatType>

mlpack::tree::Octree< MetricType, StatisticType, MatType >::Octree ( Octree< MetricType, StatisticType, MatType > && other )

Move the given tree.

The tree passed as a parameter will be emptied and will not be usable after this call.

Parameters

other Tree to move.

◆ Octree() [11/12]

template<typename MetricType , typename StatisticType , typename MatType >

template<typename Archive >

mlpack::tree::Octree< MetricType, StatisticType, MatType >::Octree	(	Archive &	ar,
		const typename std::enable_if_t< cereal::is_loading< Archive >()> *	= `0`
	)

Initialize the tree from a cereal archive.

Parameters

ar	Archive to load tree from. Must be an iarchive, not an oarchive.

◆ Octree() [12/12]

template<typename MetricType , typename StatisticType , typename MatType>

mlpack::tree::Octree< MetricType, StatisticType, MatType >::Octree ( )

protected

A default constructor.

This is meant to only be used with cereal, which is allowed with the friend declaration below. This does not return a valid treee! The method must be protected, so that the serialization shim can work with the default constructor.

Member Function Documentation

◆ Child() [1/2]

template<typename MetricType = metric::EuclideanDistance, typename StatisticType = EmptyStatistic, typename MatType = arma::mat>

const Octree& mlpack::tree::Octree< MetricType, StatisticType, MatType >::Child ( const size_t child ) const

inline

Return the specified child.

If the index is out of bounds, unspecified behavior will occur.

◆ Child() [2/2]

template<typename MetricType = metric::EuclideanDistance, typename StatisticType = EmptyStatistic, typename MatType = arma::mat>

Octree& mlpack::tree::Octree< MetricType, StatisticType, MatType >::Child ( const size_t child )

inline

Return the specified child.

If the index is out of bounds, unspecified behavior will occur.

◆ ChildPtr()

template<typename MetricType = metric::EuclideanDistance, typename StatisticType = EmptyStatistic, typename MatType = arma::mat>

Octree*& mlpack::tree::Octree< MetricType, StatisticType, MatType >::ChildPtr ( const size_t child )

inline

Return the pointer to the given child.

This allows the child itself to be modified.

◆ FurthestDescendantDistance()

template<typename MetricType , typename StatisticType , typename MatType >

Octree< MetricType, StatisticType, MatType >::ElemType mlpack::tree::Octree< MetricType, StatisticType, MatType >::FurthestDescendantDistance ( ) const

Return the furthest possible descendant distance.

This returns the maximum distance from the centroid to the edge of the bound and not the empirical quantity which is the actual furthest descendant distance. So the actual furthest descendant distance may be less than what this method returns (but it will never be greater than this).

◆ FurthestPointDistance()

template<typename MetricType , typename StatisticType , typename MatType >

Octree< MetricType, StatisticType, MatType >::ElemType mlpack::tree::Octree< MetricType, StatisticType, MatType >::FurthestPointDistance ( ) const

Return the furthest distance to a point held in this node.

If this is not a leaf node, then the distance is 0 because the node holds no points.

◆ GetFurthestChild() [1/2]

template<typename MetricType , typename StatisticType , typename MatType >

template<typename VecType >

size_t mlpack::tree::Octree< MetricType, StatisticType, MatType >::GetFurthestChild	(	const VecType &	point,
		typename std::enable_if_t< IsVector< VecType >::value > *	= `0`
	)		const

Return the index of the furthest child node to the given query point.

If this is a leaf node, it will return NumChildren() (invalid index).

◆ GetFurthestChild() [2/2]

template<typename MetricType , typename StatisticType , typename MatType >

size_t mlpack::tree::Octree< MetricType, StatisticType, MatType >::GetFurthestChild ( const Octree< MetricType, StatisticType, MatType > & queryNode ) const

Return the index of the furthest child node to the given query node.

If it can't decide, it will return NumChildren() (invalid index).

◆ GetNearestChild() [1/2]

template<typename MetricType , typename StatisticType , typename MatType >

template<typename VecType >

size_t mlpack::tree::Octree< MetricType, StatisticType, MatType >::GetNearestChild	(	const VecType &	point,
		typename std::enable_if_t< IsVector< VecType >::value > *	= `0`
	)		const

Return the index of the nearest child node to the given query point.

If this is a leaf node, it will return NumChildren() (invalid index).

◆ GetNearestChild() [2/2]

template<typename MetricType , typename StatisticType , typename MatType >

size_t mlpack::tree::Octree< MetricType, StatisticType, MatType >::GetNearestChild ( const Octree< MetricType, StatisticType, MatType > & queryNode ) const

Return the index of the nearest child node to the given query node.

If it can't decide, it will return NumChildren() (invalid index).

◆ operator=() [1/2]

template<typename MetricType , typename StatisticType , typename MatType >

Octree< MetricType, StatisticType, MatType > & mlpack::tree::Octree< MetricType, StatisticType, MatType >::operator= ( const Octree< MetricType, StatisticType, MatType > & other )

Copy the given Octree.

Copy assignment operator: copy the given other tree.

Parameters

other The tree to be copied.

◆ operator=() [2/2]

template<typename MetricType , typename StatisticType , typename MatType >

Octree< MetricType, StatisticType, MatType > & mlpack::tree::Octree< MetricType, StatisticType, MatType >::operator= ( Octree< MetricType, StatisticType, MatType > && other )

Take ownership of the given Octree.

Move assignment operator: take ownership of the given tree.

Parameters

other The tree to take ownership of.

◆ ParentDistance() [1/2]

template<typename MetricType = metric::EuclideanDistance, typename StatisticType = EmptyStatistic, typename MatType = arma::mat>

ElemType mlpack::tree::Octree< MetricType, StatisticType, MatType >::ParentDistance ( ) const

inline

Return the distance from the center of this node to the center of the parent node.

◆ ParentDistance() [2/2]

template<typename MetricType = metric::EuclideanDistance, typename StatisticType = EmptyStatistic, typename MatType = arma::mat>

ElemType& mlpack::tree::Octree< MetricType, StatisticType, MatType >::ParentDistance ( )

inline

Modify the distance from the center of this node to the center of the parent node.

◆ Point()

template<typename MetricType , typename StatisticType , typename MatType >

size_t mlpack::tree::Octree< MetricType, StatisticType, MatType >::Point ( const size_t index ) const

Return the index (with reference to the dataset) of a particular point in this node.

If the given index is invalid (i.e. if it is greater than NumPoints()), the indices returned will be invalid.

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

src/mlpack/core/tree/octree/octree.hpp
src/mlpack/core/tree/octree/octree_impl.hpp

Classes

Public Types

Public Member Functions

Protected Member Functions

Friends

Constructor & Destructor Documentation

◆ Octree() [1/12]

◆ Octree() [2/12]

◆ Octree() [3/12]

◆ Octree() [4/12]

◆ Octree() [5/12]

◆ Octree() [6/12]

◆ Octree() [7/12]

◆ Octree() [8/12]

◆ Octree() [9/12]

◆ Octree() [10/12]

◆ Octree() [11/12]

◆ Octree() [12/12]

Member Function Documentation

◆ Child() [1/2]

◆ Child() [2/2]

◆ ChildPtr()

◆ FurthestDescendantDistance()

◆ FurthestPointDistance()

◆ GetFurthestChild() [1/2]

◆ GetFurthestChild() [2/2]

◆ GetNearestChild() [1/2]

◆ GetNearestChild() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ ParentDistance() [1/2]

◆ ParentDistance() [2/2]

◆ Point()