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::BoundingBoxNearestPredicate Class Reference

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

Inheritance diagram for ArborXWrappers::BoundingBoxNearestPredicate:
[legend]

Public Member Functions

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

Private Member Functions

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

Private Attributes

unsigned int n_nearest_neighbors
 
std::vector<::BoundingBox< 3, float > > bounding_boxes
 

Detailed Description

This class is used by ArborXWrappers::BVH to determine for given bounding boxes 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 182 of file access_traits.h.

Constructor & Destructor Documentation

◆ BoundingBoxNearestPredicate()

template<int dim, typename Number >
ArborXWrappers::BoundingBoxNearestPredicate::BoundingBoxNearestPredicate ( const std::vector<::BoundingBox< dim, Number >> &  bounding_boxes,
const unsigned int  n_nearest_neighbors 
)

Constructor. bounding_boxes is a list of bounding boxes for which are interested in knowing the n_nearest_neighbors nearest bounding boxes used to build the ArborXWrappers::BVH.

Definition at line 135 of file access_traits.cc.

Member Function Documentation

◆ get_n_nearest_neighbors()

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

Return the number of nearest neighbors we are looking for.

Definition at line 145 of file access_traits.cc.

◆ get() [1/2]

const ::BoundingBox< 3, float > & ArborXWrappers::BoundingBoxPredicate::get

Return the ith BoundingBox stored in the object.

Definition at line 145 of file access_traits.cc.

◆ size() [1/2]

std::size_t ArborXWrappers::BoundingBoxPredicate::size

Number of bounding boxes stored in the structure.

Definition at line 139 of file access_traits.cc.

◆ size() [2/2]

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

Number of bounding boxes stored in the structure.

Definition at line 111 of file access_traits.cc.

◆ get() [2/2]

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

Return the ith BoundingBox stored in the object.

Definition at line 119 of file access_traits.cc.

Member Data Documentation

◆ n_nearest_neighbors

unsigned int ArborXWrappers::BoundingBoxNearestPredicate::n_nearest_neighbors
private

Definition at line 206 of file access_traits.h.

◆ bounding_boxes

std::vector<::BoundingBox<3, float> > ArborXWrappers::BoundingBoxPredicate::bounding_boxes
privateinherited

Definition at line 148 of file access_traits.h.

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