lsst.geom  16.0+1
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
lsst::geom::CoordinateBase< Derived, T, 3 > Class Template Reference

Specialization of CoordinateBase for 3 dimensions. More...

#include <CoordinateBase.h>

Public Types

typedef T Element
 
typedef Eigen::Matrix< T, 3, 1, Eigen::DontAlign > EigenVector
 

Public Member Functions

 CoordinateBase (CoordinateBase const &)=default
 
 CoordinateBase (CoordinateBase &&)=default
 
CoordinateBaseoperator= (CoordinateBase const &)=default
 
CoordinateBaseoperator= (CoordinateBase &&)=default
 
 ~CoordinateBase ()=default
 
T & operator[] (int n)
 
T const & operator[] (int n) const
 
T & coeffRef (int n)
 
T const & coeffRef (int n) const
 
EigenVector const & asEigen () const
 Return a fixed-size Eigen representation of the coordinate object. More...
 
T const & getX () const
 
T const & getY () const
 
T const & getZ () const
 
T & getX ()
 
T & getY ()
 
T & getZ ()
 
void setX (T x)
 
void setY (T y)
 
void setZ (T z)
 
std::tuple< T, T, T > asTuple () const
 Return a std::tuple representation of the coordinate object. More...
 

Static Public Attributes

static int const dimensions = 3
 

Protected Member Functions

 CoordinateBase (T val=static_cast< T >(0))
 
template<typename Vector >
 CoordinateBase (Eigen::MatrixBase< Vector > const &vector)
 
void _swap (CoordinateBase &other)
 

Protected Attributes

EigenVector _vector
 

Detailed Description

template<typename Derived, typename T>
class lsst::geom::CoordinateBase< Derived, T, 3 >

Specialization of CoordinateBase for 3 dimensions.

Definition at line 159 of file CoordinateBase.h.

Member Typedef Documentation

◆ EigenVector

template<typename Derived , typename T >
typedef Eigen::Matrix<T, 3, 1, Eigen::DontAlign> lsst::geom::CoordinateBase< Derived, T, 3 >::EigenVector

Definition at line 163 of file CoordinateBase.h.

◆ Element

template<typename Derived , typename T >
typedef T lsst::geom::CoordinateBase< Derived, T, 3 >::Element

Definition at line 161 of file CoordinateBase.h.

Constructor & Destructor Documentation

◆ CoordinateBase() [1/4]

template<typename Derived , typename T >
lsst::geom::CoordinateBase< Derived, T, 3 >::CoordinateBase ( CoordinateBase< Derived, T, 3 > const &  )
default

◆ CoordinateBase() [2/4]

template<typename Derived , typename T >
lsst::geom::CoordinateBase< Derived, T, 3 >::CoordinateBase ( CoordinateBase< Derived, T, 3 > &&  )
default

◆ ~CoordinateBase()

template<typename Derived , typename T >
lsst::geom::CoordinateBase< Derived, T, 3 >::~CoordinateBase ( )
default

◆ CoordinateBase() [3/4]

template<typename Derived , typename T >
lsst::geom::CoordinateBase< Derived, T, 3 >::CoordinateBase ( val = static_cast<T>(0))
inlineexplicitprotected

Definition at line 198 of file CoordinateBase.h.

◆ CoordinateBase() [4/4]

template<typename Derived , typename T >
template<typename Vector >
lsst::geom::CoordinateBase< Derived, T, 3 >::CoordinateBase ( Eigen::MatrixBase< Vector > const &  vector)
inlineexplicitprotected

Definition at line 201 of file CoordinateBase.h.

Member Function Documentation

◆ _swap()

template<typename Derived , typename T >
void lsst::geom::CoordinateBase< Derived, T, 3 >::_swap ( CoordinateBase< Derived, T, 3 > &  other)
inlineprotected

Definition at line 202 of file CoordinateBase.h.

◆ asEigen()

template<typename Derived , typename T >
EigenVector const& lsst::geom::CoordinateBase< Derived, T, 3 >::asEigen ( ) const
inline

Return a fixed-size Eigen representation of the coordinate object.

The fact that this returns by const reference rather than by value should not be considered part of the API; this is merely an optimization enabled by the implementation.

Definition at line 182 of file CoordinateBase.h.

◆ asTuple()

template<typename Derived , typename T >
std::tuple<T, T, T> lsst::geom::CoordinateBase< Derived, T, 3 >::asTuple ( ) const
inline

Return a std::tuple representation of the coordinate object.

Definition at line 195 of file CoordinateBase.h.

◆ coeffRef() [1/2]

template<typename Derived , typename T >
T& lsst::geom::CoordinateBase< Derived, T, 3 >::coeffRef ( int  n)
inline

Definition at line 173 of file CoordinateBase.h.

◆ coeffRef() [2/2]

template<typename Derived , typename T >
T const& lsst::geom::CoordinateBase< Derived, T, 3 >::coeffRef ( int  n) const
inline

Definition at line 174 of file CoordinateBase.h.

◆ getX() [1/2]

template<typename Derived , typename T >
T const& lsst::geom::CoordinateBase< Derived, T, 3 >::getX ( ) const
inline

Definition at line 184 of file CoordinateBase.h.

◆ getX() [2/2]

template<typename Derived , typename T >
T& lsst::geom::CoordinateBase< Derived, T, 3 >::getX ( )
inline

Definition at line 187 of file CoordinateBase.h.

◆ getY() [1/2]

template<typename Derived , typename T >
T const& lsst::geom::CoordinateBase< Derived, T, 3 >::getY ( ) const
inline

Definition at line 185 of file CoordinateBase.h.

◆ getY() [2/2]

template<typename Derived , typename T >
T& lsst::geom::CoordinateBase< Derived, T, 3 >::getY ( )
inline

Definition at line 188 of file CoordinateBase.h.

◆ getZ() [1/2]

template<typename Derived , typename T >
T const& lsst::geom::CoordinateBase< Derived, T, 3 >::getZ ( ) const
inline

Definition at line 186 of file CoordinateBase.h.

◆ getZ() [2/2]

template<typename Derived , typename T >
T& lsst::geom::CoordinateBase< Derived, T, 3 >::getZ ( )
inline

Definition at line 189 of file CoordinateBase.h.

◆ operator=() [1/2]

template<typename Derived , typename T >
CoordinateBase& lsst::geom::CoordinateBase< Derived, T, 3 >::operator= ( CoordinateBase< Derived, T, 3 > const &  )
default

◆ operator=() [2/2]

template<typename Derived , typename T >
CoordinateBase& lsst::geom::CoordinateBase< Derived, T, 3 >::operator= ( CoordinateBase< Derived, T, 3 > &&  )
default

◆ operator[]() [1/2]

template<typename Derived , typename T >
T& lsst::geom::CoordinateBase< Derived, T, 3 >::operator[] ( int  n)
inline

Definition at line 171 of file CoordinateBase.h.

◆ operator[]() [2/2]

template<typename Derived , typename T >
T const& lsst::geom::CoordinateBase< Derived, T, 3 >::operator[] ( int  n) const
inline

Definition at line 172 of file CoordinateBase.h.

◆ setX()

template<typename Derived , typename T >
void lsst::geom::CoordinateBase< Derived, T, 3 >::setX ( x)
inline

Definition at line 190 of file CoordinateBase.h.

◆ setY()

template<typename Derived , typename T >
void lsst::geom::CoordinateBase< Derived, T, 3 >::setY ( y)
inline

Definition at line 191 of file CoordinateBase.h.

◆ setZ()

template<typename Derived , typename T >
void lsst::geom::CoordinateBase< Derived, T, 3 >::setZ ( z)
inline

Definition at line 192 of file CoordinateBase.h.

Member Data Documentation

◆ _vector

template<typename Derived , typename T >
EigenVector lsst::geom::CoordinateBase< Derived, T, 3 >::_vector
protected

Definition at line 203 of file CoordinateBase.h.

◆ dimensions

template<typename Derived , typename T >
int const lsst::geom::CoordinateBase< Derived, T, 3 >::dimensions = 3
static

Definition at line 162 of file CoordinateBase.h.


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