MFEM v4.7.0
Finite element discretization library
Loading...
Searching...
No Matches
Public Member Functions | List of all members
mfem::KDTreeBase< Tindex, Tfloat > Class Template Referenceabstract

Abstract base class for KDTree. Can be used when the dimension of the space is known dynamically. More...

#include <kdtree.hpp>

Inheritance diagram for mfem::KDTreeBase< Tindex, Tfloat >:
[legend]

Public Member Functions

virtual void AddPoint (const Tfloat *xx, Tindex ii)=0
 Adds a point to the tree. See KDTree::AddPoint().
 
virtual void Sort ()=0
 Sorts the tree. Should be performed after adding points and before performing queries. See KDTree::Sort().
 
virtual Tindex FindClosestPoint (const Tfloat *xx) const =0
 Returns the index of the closest point to xx.
 
virtual ~KDTreeBase ()
 Virtual destructor.
 

Detailed Description

template<typename Tindex, typename Tfloat>
class mfem::KDTreeBase< Tindex, Tfloat >

Abstract base class for KDTree. Can be used when the dimension of the space is known dynamically.

Definition at line 91 of file kdtree.hpp.

Constructor & Destructor Documentation

◆ ~KDTreeBase()

template<typename Tindex , typename Tfloat >
virtual mfem::KDTreeBase< Tindex, Tfloat >::~KDTreeBase ( )
inlinevirtual

Virtual destructor.

Definition at line 102 of file kdtree.hpp.

Member Function Documentation

◆ AddPoint()

template<typename Tindex , typename Tfloat >
virtual void mfem::KDTreeBase< Tindex, Tfloat >::AddPoint ( const Tfloat *  xx,
Tindex  ii 
)
pure virtual

Adds a point to the tree. See KDTree::AddPoint().

Implemented in mfem::KDTree< Tindex, Tfloat, ndim, Tnorm >.

◆ FindClosestPoint()

template<typename Tindex , typename Tfloat >
virtual Tindex mfem::KDTreeBase< Tindex, Tfloat >::FindClosestPoint ( const Tfloat *  xx) const
pure virtual

Returns the index of the closest point to xx.

Implemented in mfem::KDTree< Tindex, Tfloat, ndim, Tnorm >.

◆ Sort()

template<typename Tindex , typename Tfloat >
virtual void mfem::KDTreeBase< Tindex, Tfloat >::Sort ( )
pure virtual

Sorts the tree. Should be performed after adding points and before performing queries. See KDTree::Sort().

Implemented in mfem::KDTree< Tindex, Tfloat, ndim, Tnorm >, and mfem::KDTree< int, real_t, 3 >.


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