FleCSI User API Version: 2.3.0
 
Loading...
Searching...
No Matches
BBox< DIM > Class Template Reference

The bounding box type that is used by KDTree as input. More...

Public Types

using point_t = util::point< double, DIM >
 Geometric point to represent coordinates.
 

Public Member Functions

constexpr point_t center () const
 Centroid.
 
constexpr bool intersects (const BBox &box) const
 Determine if the two bounding boxes intersect.
 
constexpr void operator+= (const BBox &rhs)
 Union rhs into this BBox.
 
constexpr BBoxoperator+= (const point_t &p)
 Extend box as needed to contain a point.
 
constexpr point_t size () const
 Size of the box.
 

Static Public Member Functions

static constexpr auto empty ()
 Return an empty BBox.
 

Public Attributes

point_t lower
 The upper and lower corners of the box.
 

Detailed Description

template<Dimension DIM>
class flecsi::util::BBox< DIM >

The bounding box type that is used by KDTree as input.

Member Typedef Documentation

◆ point_t

template<Dimension DIM>
using point_t = util::point<double, DIM>

Geometric point to represent coordinates.

Member Function Documentation

◆ size()

template<Dimension DIM>
constexpr point_t size ( ) const
constexpr

Size of the box.

◆ center()

template<Dimension DIM>
constexpr point_t center ( ) const
constexpr

Centroid.

◆ intersects()

template<Dimension DIM>
constexpr bool intersects ( const BBox< DIM > &  box) const
constexpr

Determine if the two bounding boxes intersect.

◆ operator+=() [1/2]

template<Dimension DIM>
constexpr BBox & operator+= ( const point_t p)
constexpr

Extend box as needed to contain a point.

◆ operator+=() [2/2]

template<Dimension DIM>
constexpr void operator+= ( const BBox< DIM > &  rhs)
constexpr

Union rhs into this BBox.

◆ empty()

template<Dimension DIM>
static constexpr auto empty ( )
staticconstexpr

Return an empty BBox.

Member Data Documentation

◆ lower

template<Dimension DIM>
point_t lower

The upper and lower corners of the box.