stator
A math, geometry, and utility library
Public Member Functions | Protected Attributes | List of all members
stator::geometry::AABox< Scalar, D > Class Template Reference

An axis-aligned box/block (including its interior volume). More...

#include <box.hpp>

Public Member Functions

 AABox (const Vector< Scalar, D > &max, const Vector< Scalar, D > &min)
 
Vector< Scalar, D > dimensions () const
 
const Vector< Scalar, D > & max () const
 
const Vector< Scalar, D > & min () const
 

Protected Attributes

Vector< Scalar, D > max_
 
Vector< Scalar, D > min_
 

Detailed Description

template<typename Scalar, size_t D>
class stator::geometry::AABox< Scalar, D >

Template Parameters
ScalarThe scalar type used for computation of properties of the object.
DThe dimensionality of the ball.

Definition at line 36 of file box.hpp.

Constructor & Destructor Documentation

◆ AABox()

template<typename Scalar, size_t D>
stator::geometry::AABox< Scalar, D >::AABox ( const Vector< Scalar, D > &  max,
const Vector< Scalar, D > &  min 
)
inline

Definition at line 38 of file box.hpp.

Member Function Documentation

◆ dimensions()

template<typename Scalar, size_t D>
Vector<Scalar, D> stator::geometry::AABox< Scalar, D >::dimensions ( ) const
inline

Definition at line 45 of file box.hpp.

◆ max()

template<typename Scalar, size_t D>
const Vector<Scalar, D>& stator::geometry::AABox< Scalar, D >::max ( ) const
inline

Definition at line 42 of file box.hpp.

◆ min()

template<typename Scalar, size_t D>
const Vector<Scalar, D>& stator::geometry::AABox< Scalar, D >::min ( ) const
inline

Definition at line 43 of file box.hpp.

Member Data Documentation

◆ max_

template<typename Scalar, size_t D>
Vector<Scalar, D> stator::geometry::AABox< Scalar, D >::max_
protected

Definition at line 48 of file box.hpp.

◆ min_

template<typename Scalar, size_t D>
Vector<Scalar, D> stator::geometry::AABox< Scalar, D >::min_
protected

Definition at line 49 of file box.hpp.


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