Reference documentation for deal.II version GIT relicensing-693-g4fb6c325db 2024-05-21 16:20:02+00:00
\(\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\}}\)
No Matches
Public Member Functions | Private Attributes | List of all members
ArborXWrappers::PointNearestPredicate Class Reference

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

Inheritance diagram for ArborXWrappers::PointNearestPredicate:
Inheritance graph

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 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.

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

Definition at line 93 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 77 of file

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 87 of file

◆ get()

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

Return the ith Point stored in the object.

Definition at line 55 of file

◆ size()

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

The number of points stored in the structure.

Definition at line 49 of file

Member Data Documentation

◆ n_nearest_neighbors

unsigned int ArborXWrappers::PointNearestPredicate::n_nearest_neighbors

Definition at line 116 of file access_traits.h.

◆ points

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

Definition at line 58 of file access_traits.h.

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