Public Types
typedef bound::HRectBound< metric::EuclideanDistance, ElemType >	BoundType
	The bound type held by the auxiliary information. More...

typedef TreeType::ElemType	ElemType
	The element type held by the tree. More...

Public Member Functions
	RPlusPlusTreeAuxiliaryInformation ()
	Construct the auxiliary information object. More...

	RPlusPlusTreeAuxiliaryInformation (const TreeType *)
	Construct this as an auxiliary information for the given node. More...

	RPlusPlusTreeAuxiliaryInformation (const RPlusPlusTreeAuxiliaryInformation &other, TreeType *tree, bool=true)
	Create an auxiliary information object by copying from another object. More...

	RPlusPlusTreeAuxiliaryInformation (RPlusPlusTreeAuxiliaryInformation &&other)
	Create an auxiliary information object by moving from another node. More...

bool	HandleNodeInsertion (TreeType , TreeType , bool)
	Some tree types require to save some properties at the insertion process. More...

bool	HandleNodeRemoval (TreeType *, const size_t)
	Some tree types require to save some properties at the deletion process. More...

bool	HandlePointDeletion (TreeType *, const size_t)
	Some tree types require to save some properties at the deletion process. More...

bool	HandlePointInsertion (TreeType *, const size_t)
	Some tree types require to save some properties at the insertion process. More...

void	NullifyData ()
	Nullify the auxiliary information in order to prevent an invalid free. More...

BoundType &	OuterBound ()
	Return the maximum bounding rectangle. More...

const BoundType &	OuterBound () const
	Modify the maximum bounding rectangle. More...

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

void	SplitAuxiliaryInfo (TreeType treeOne, TreeType treeTwo, const size_t axis, const ElemType cut)
	The R++ tree requires to split the maximum bounding rectangle of a node that is being split. More...

bool	UpdateAuxiliaryInfo (TreeType *)
	Some tree types require to propagate the information upward. More...

Detailed Description

template
<
typename
TreeType
>

class mlpack::tree::RPlusPlusTreeAuxiliaryInformation< TreeType >

Definition at line 24 of file r_plus_plus_tree_auxiliary_information.hpp.

Member Typedef Documentation

◆ BoundType

typedef bound::HRectBound<metric::EuclideanDistance, ElemType> BoundType

The bound type held by the auxiliary information.

Definition at line 30 of file r_plus_plus_tree_auxiliary_information.hpp.

◆ ElemType

typedef TreeType::ElemType ElemType

The element type held by the tree.

Definition at line 28 of file r_plus_plus_tree_auxiliary_information.hpp.

Constructor & Destructor Documentation

◆ RPlusPlusTreeAuxiliaryInformation() [1/4]

RPlusPlusTreeAuxiliaryInformation ( )

Construct the auxiliary information object.

◆ RPlusPlusTreeAuxiliaryInformation() [2/4]

RPlusPlusTreeAuxiliaryInformation ( const TreeType * )

Construct this as an auxiliary information for the given node.

Parameters

*	(node) The node that stores this auxiliary information.

◆ RPlusPlusTreeAuxiliaryInformation() [3/4]

RPlusPlusTreeAuxiliaryInformation	(	const RPlusPlusTreeAuxiliaryInformation< TreeType > &	other,
		TreeType *	tree,
		bool	= `true`
	)

Create an auxiliary information object by copying from another object.

Parameters

other	Another auxiliary information object from which the information will be copied.
tree	The node that holds the auxiliary information.
*	(deepCopy) If false, the new object uses the same memory (not used here).

◆ RPlusPlusTreeAuxiliaryInformation() [4/4]

RPlusPlusTreeAuxiliaryInformation ( RPlusPlusTreeAuxiliaryInformation< TreeType > && other )

Create an auxiliary information object by moving from another node.

Parameters

other The auxiliary information object from which the information will be moved.

Member Function Documentation

◆ HandleNodeInsertion()

bool HandleNodeInsertion	(	TreeType *	,
		TreeType *	,
		bool
	)

Some tree types require to save some properties at the insertion process.

This method allows the auxiliary information the option of manipulating the tree in order to perform the insertion process. If the auxiliary information does that, then the method should return true; if the method returns false the RectangleTree performs its default behavior.

Parameters

*	(node) The node in which the nodeToInsert is being inserted.
*	(nodeToInsert) The node being inserted.
*	(insertionLevel) The level of the tree at which the nodeToInsert should be inserted.

◆ HandleNodeRemoval()

bool HandleNodeRemoval	(	TreeType *	,
		const size_t
	)

Some tree types require to save some properties at the deletion process.

This method allows the auxiliary information the option of manipulating the tree in order to perform the deletion process. If the auxiliary information does that, then the method should return true; if the method returns false the RectangleTree performs its default behavior.

Parameters

*	(node) The node from which the node is being deleted.
*	(nodeIndex) The local index of the node being deleted.

◆ HandlePointDeletion()

bool HandlePointDeletion	(	TreeType *	,
		const size_t
	)

Some tree types require to save some properties at the deletion process.

This method allows the auxiliary information the option of manipulating the tree in order to perform the deletion process. If the auxiliary information does that, then the method should return true; if the method returns false the RectangleTree performs its default behavior.

Parameters

*	(node) The node from which the point is being deleted.
*	(localIndex) The local index of the point being deleted.

◆ HandlePointInsertion()

bool HandlePointInsertion	(	TreeType *	,
		const size_t
	)

Some tree types require to save some properties at the insertion process.

This method allows the auxiliary information the option of manipulating the tree in order to perform the insertion process. If the auxiliary information does that, then the method should return true; if the method returns false the RectangleTree performs its default behavior.

Parameters

*	(node) The node in which the point is being inserted.
*	(point) The global number of the point being inserted.

◆ NullifyData()

void NullifyData ( )

Nullify the auxiliary information in order to prevent an invalid free.

◆ OuterBound() [1/2]

BoundType& OuterBound ( )

inline

Return the maximum bounding rectangle.

Definition at line 146 of file r_plus_plus_tree_auxiliary_information.hpp.

◆ OuterBound() [2/2]

const BoundType& OuterBound ( ) const

inline

Modify the maximum bounding rectangle.

Definition at line 149 of file r_plus_plus_tree_auxiliary_information.hpp.

References RPlusPlusTreeAuxiliaryInformation< TreeType >::serialize().

◆ serialize()

void serialize	(	Archive &	,
		const uint32_t
	)

Serialize the information.

Referenced by RPlusPlusTreeAuxiliaryInformation< TreeType >::OuterBound().

◆ SplitAuxiliaryInfo()

void SplitAuxiliaryInfo	(	TreeType *	treeOne,
		TreeType *	treeTwo,
		const size_t	axis,
		const ElemType	cut
	)

The R++ tree requires to split the maximum bounding rectangle of a node that is being split.

This method is intended for that.

Parameters

treeOne	The first subtree.
treeTwo	The second subtree.
axis	The axis along which the split is performed.
cut	The coordinate at which the node is split.

◆ UpdateAuxiliaryInfo()

bool UpdateAuxiliaryInfo ( TreeType * )

Some tree types require to propagate the information upward.

This method should return false if this is not the case. If true is returned, the update will be propagated upward.

Parameters

*	(node) The node in which the auxiliary information being update.

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

/home/ryan/src/mlpack.org/_src/mlpack-git/src/mlpack/core/tree/rectangle_tree/r_plus_plus_tree_auxiliary_information.hpp

Public Types

Public Member Functions

Detailed Description

template<typenameTreeType> class mlpack::tree::RPlusPlusTreeAuxiliaryInformation< TreeType >

Member Typedef Documentation

◆ BoundType

◆ ElemType

Constructor & Destructor Documentation

◆ RPlusPlusTreeAuxiliaryInformation() [1/4]

◆ RPlusPlusTreeAuxiliaryInformation() [2/4]

◆ RPlusPlusTreeAuxiliaryInformation() [3/4]

◆ RPlusPlusTreeAuxiliaryInformation() [4/4]

Member Function Documentation

◆ HandleNodeInsertion()

◆ HandleNodeRemoval()

◆ HandlePointDeletion()

◆ HandlePointInsertion()

◆ NullifyData()

◆ OuterBound() [1/2]

◆ OuterBound() [2/2]

◆ serialize()

◆ SplitAuxiliaryInfo()

◆ UpdateAuxiliaryInfo()

template
<
typename
TreeType
>

class mlpack::tree::RPlusPlusTreeAuxiliaryInformation< TreeType >