NoAuxiliaryInformation< TreeType > Class Template Reference

Public Member Functions

 NoAuxiliaryInformation ()
 Construct the auxiliary information object. More...

 
 NoAuxiliaryInformation (const TreeType *)
 Construct the auxiliary information object. More...

 
 NoAuxiliaryInformation (const NoAuxiliaryInformation &, TreeType *, bool=true)
 Construct the auxiliary information object. More...

 
 NoAuxiliaryInformation (NoAuxiliaryInformation &&)
 Construct the auxiliary information object. 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...

 
NoAuxiliaryInformationoperator= (const NoAuxiliaryInformation &)
 Copy the auxiliary information object. More...

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

 
void SplitAuxiliaryInfo (TreeType *, TreeType *, size_t, typename TreeType::ElemType)
 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::NoAuxiliaryInformation< TreeType >

Definition at line 20 of file no_auxiliary_information.hpp.

Constructor & Destructor Documentation

◆ NoAuxiliaryInformation() [1/4]

Construct the auxiliary information object.

Definition at line 24 of file no_auxiliary_information.hpp.

◆ NoAuxiliaryInformation() [2/4]

NoAuxiliaryInformation ( const TreeType *  )
inline

Construct the auxiliary information object.

Definition at line 26 of file no_auxiliary_information.hpp.

◆ NoAuxiliaryInformation() [3/4]

NoAuxiliaryInformation ( const NoAuxiliaryInformation< TreeType > &  ,
TreeType *  ,
bool  = true 
)
inline

Construct the auxiliary information object.

Definition at line 28 of file no_auxiliary_information.hpp.

◆ NoAuxiliaryInformation() [4/4]

NoAuxiliaryInformation ( NoAuxiliaryInformation< TreeType > &&  )
inline

Construct the auxiliary information object.

Definition at line 32 of file no_auxiliary_information.hpp.

Member Function Documentation

◆ HandleNodeInsertion()

bool HandleNodeInsertion ( TreeType *  ,
TreeType *  ,
bool   
)
inline

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
nodeThe node in which the nodeToInsert is being inserted.
nodeToInsertThe node being inserted.
insertionLevelThe level of the tree at which the nodeToInsert should be inserted.

Definition at line 67 of file no_auxiliary_information.hpp.

◆ HandleNodeRemoval()

bool HandleNodeRemoval ( TreeType *  ,
const size_t   
)
inline

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
nodeThe node from which the node is being deleted.
nodeIndexThe local index of the node being deleted.

Definition at line 99 of file no_auxiliary_information.hpp.

◆ HandlePointDeletion()

bool HandlePointDeletion ( TreeType *  ,
const size_t   
)
inline

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
nodeThe node from which the point is being deleted.
localIndexThe local index of the point being deleted.

Definition at line 84 of file no_auxiliary_information.hpp.

◆ HandlePointInsertion()

bool HandlePointInsertion ( TreeType *  ,
const size_t   
)
inline

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
nodeThe node in which the point is being inserted.
pointThe global number of the point being inserted.

Definition at line 50 of file no_auxiliary_information.hpp.

◆ NullifyData()

void NullifyData ( )
inline

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

Definition at line 137 of file no_auxiliary_information.hpp.

◆ operator=()

NoAuxiliaryInformation& operator= ( const NoAuxiliaryInformation< TreeType > &  )
inline

Copy the auxiliary information object.

Definition at line 35 of file no_auxiliary_information.hpp.

◆ serialize()

void serialize ( Archive &  ,
const unsigned  int 
)
inline

Serialize the information.

Definition at line 144 of file no_auxiliary_information.hpp.

◆ SplitAuxiliaryInfo()

void SplitAuxiliaryInfo ( TreeType *  ,
TreeType *  ,
size_t  ,
typename TreeType::ElemType   
)
inline

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

This method is intended for that. This method is only necessary for an AuxiliaryInformationType that is being used in conjunction with RPlusTreeSplit.

Parameters
treeOneThe first subtree.
treeTwoThe second subtree.
axisThe axis along which the split is performed.
cutThe coordinate at which the node is split.

Definition at line 127 of file no_auxiliary_information.hpp.

◆ UpdateAuxiliaryInfo()

bool UpdateAuxiliaryInfo ( TreeType *  )
inline

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
nodeThe node in which the auxiliary information being update.

Definition at line 111 of file no_auxiliary_information.hpp.


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