ArborX / Spatial indexes

ArborX::BVH

Note

For ArborX 1.x, see ArborX::BoundingVolumeHierarchy (v1).

Defined in header <ArborX_LinearBVH.hpp>

template <typename MemorySpace, typename Value, typename IndexableGetter, typename BoundingVolume>
class BoundingVolumeHierarchy;

The class template ArborX::BoundingVolumeHierarchy is a tree data structure that can be used to accelerate the search for geometrical objects in space.

Template parameter

  • MemorySpace: valid Kokkos memory space

  • Value: type of objects stored in the container

  • IndexableGetter: function extracting an indexable geometry from Value

  • BoundingVolume: bounding volume used for internal nodes

Member types

Member type

Definition

memory_space

MemorySpace

value_type

Value

size_type

MemorySpace::size_type

bounding_volume_type

BoundingVolume

indexable_getter_type

IndexableGetter

Member functions

(constructor)

constructs the tree data structure

size

returns the number of leaves stored in the tree

empty

checks whether the tree has no leaves

bounds

returns a bounding volume able to contain all leaves stored in the tree

query

finds all leaves that satisfy given predicates, e.g. nearest to a point or intersecting with a box or a sphere