Reference documentation for deal.II version 9.3.2
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Public Member Functions | Private Member Functions | Private Attributes | List of all members
ArborXWrappers::PointNearestPredicate Class Reference

#include <deal.II/arborx/access_traits.h>

Inheritance diagram for ArborXWrappers::PointNearestPredicate:
[legend]

Public Member Functions

template<int dim, typename Number >
 PointNearestPredicate (const std::vector<::Point< dim, Number >> &points, const unsigned int n_nearest_neighbors)
 
unsigned int get_n_nearest_neighbors () const
 
const ::Point< 3, float > & get (unsigned int i) const
 
std::size_t size () const
 

Private Member Functions

std::size_t size () const
 
const ::Point< 3, float > & get (unsigned int i) const
 

Private Attributes

unsigned int n_nearest_neighbors
 
std::vector<::Point< 3, float > > points
 

Detailed Description

This class defines a predicate used by ArborXWrappers::BVH to determine for given points which are the nearest bounding boxes/points among the ones used to build the ArborXWrappers::BVH.

Note
The class is not supposed to be used in a polymorphic context.

Definition at line 92 of file access_traits.h.

Constructor & Destructor Documentation

◆ PointNearestPredicate()

template<int dim, typename Number >
ArborXWrappers::PointNearestPredicate::PointNearestPredicate ( const std::vector<::Point< dim, Number >> &  points,
const unsigned int  n_nearest_neighbors 
)

Constructor. points is a list of points for which we are interested in the n_nearest_neighbors in the ArborXWrappers::BVH bounding boxes/points.

Definition at line 69 of file access_traits.cc.

Member Function Documentation

◆ get_n_nearest_neighbors()

unsigned int ArborXWrappers::PointNearestPredicate::get_n_nearest_neighbors ( ) const

Return the number of nearest neighbors we are looking for.

Definition at line 79 of file access_traits.cc.

◆ get() [1/2]

const ::Point< 3, float > & ArborXWrappers::PointPredicate::get

Return the ith Point stored in the object.

Definition at line 54 of file access_traits.cc.

◆ size() [1/2]

std::size_t ArborXWrappers::PointPredicate::size

Number of points stored in the structure.

Definition at line 48 of file access_traits.cc.

◆ size() [2/2]

std::size_t ArborXWrappers::PointPredicate::size ( ) const
protectedinherited

Number of points stored in the structure.

Definition at line 45 of file access_traits.cc.

◆ get() [2/2]

const ::Point< 3, float > & ArborXWrappers::PointPredicate::get ( unsigned int  i) const
protectedinherited

Return the ith Point stored in the object.

Definition at line 53 of file access_traits.cc.

Member Data Documentation

◆ n_nearest_neighbors

unsigned int ArborXWrappers::PointNearestPredicate::n_nearest_neighbors
private

Definition at line 115 of file access_traits.h.

◆ points

std::vector<::Point<3, float> > ArborXWrappers::PointPredicate::points
privateinherited

Definition at line 57 of file access_traits.h.

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.1