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

A point. More...

#include <point.hpp>

Public Member Functions

 Point ()
 Default constructor. More...
 
 Point (const Vector< Scalar, D > &center=Vector< Scalar, D >::Zero().eval())
 RAII constructor. More...
 
const Vector< Scalar, D > & center () const
 Get function for the point's location. More...
 

Protected Attributes

Vector< Scalar, D > center_
 Center of the ball. More...
 

Detailed Description

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

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

Definition at line 35 of file point.hpp.

Constructor & Destructor Documentation

◆ Point() [1/2]

template<typename Scalar, size_t D>
stator::geometry::Point< Scalar, D >::Point ( )
inline

This constructor deliberately leaves the object uninitialised to allow convenient stack-based construction without comprimising the detection of uninitialised accesses by tools such as valgrind.

Definition at line 44 of file point.hpp.

◆ Point() [2/2]

template<typename Scalar, size_t D>
stator::geometry::Point< Scalar, D >::Point ( const Vector< Scalar, D > &  center = Vector<Scalar, D>::Zero().eval())
inline

Definition at line 47 of file point.hpp.

Member Function Documentation

◆ center()

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

Definition at line 50 of file point.hpp.

Member Data Documentation

◆ center_

template<typename Scalar, size_t D>
Vector<Scalar, D> stator::geometry::Point< Scalar, D >::center_
protected

Definition at line 54 of file point.hpp.


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