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, 2 > Class Template Reference

Specialization of CoordinateBase for 2 dimensions. More...

#include <CoordinateBase.h>

Public Types

typedef T Element
 
typedef Eigen::Matrix< T, 2, 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 & getX ()
 
T & getY ()
 
void setX (T x)
 
void setY (T y)
 
std::pair< T, T > asPair () const
 Return a std::pair representation of the coordinate object. More...
 
std::tuple< T, T > asTuple () const
 Return a std::tuple representation of the coordinate object. More...
 

Static Public Attributes

static int const dimensions = 2
 

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, 2 >

Specialization of CoordinateBase for 2 dimensions.

Definition at line 108 of file CoordinateBase.h.

Member Typedef Documentation

◆ EigenVector

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

Definition at line 112 of file CoordinateBase.h.

◆ Element

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

Definition at line 110 of file CoordinateBase.h.

Constructor & Destructor Documentation

◆ CoordinateBase() [1/4]

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

◆ CoordinateBase() [2/4]

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

◆ ~CoordinateBase()

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

◆ CoordinateBase() [3/4]

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

Definition at line 147 of file CoordinateBase.h.

◆ CoordinateBase() [4/4]

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

Definition at line 150 of file CoordinateBase.h.

Member Function Documentation

◆ _swap()

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

Definition at line 151 of file CoordinateBase.h.

◆ asEigen()

template<typename Derived , typename T >
EigenVector const& lsst::geom::CoordinateBase< Derived, T, 2 >::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 131 of file CoordinateBase.h.

◆ asPair()

template<typename Derived , typename T >
std::pair<T, T> lsst::geom::CoordinateBase< Derived, T, 2 >::asPair ( ) const
inline

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

Definition at line 141 of file CoordinateBase.h.

◆ asTuple()

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

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

Definition at line 144 of file CoordinateBase.h.

◆ coeffRef() [1/2]

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

Definition at line 122 of file CoordinateBase.h.

◆ coeffRef() [2/2]

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

Definition at line 123 of file CoordinateBase.h.

◆ getX() [1/2]

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

Definition at line 133 of file CoordinateBase.h.

◆ getX() [2/2]

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

Definition at line 135 of file CoordinateBase.h.

◆ getY() [1/2]

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

Definition at line 134 of file CoordinateBase.h.

◆ getY() [2/2]

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

Definition at line 136 of file CoordinateBase.h.

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ operator[]() [1/2]

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

Definition at line 120 of file CoordinateBase.h.

◆ operator[]() [2/2]

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

Definition at line 121 of file CoordinateBase.h.

◆ setX()

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

Definition at line 137 of file CoordinateBase.h.

◆ setY()

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

Definition at line 138 of file CoordinateBase.h.

Member Data Documentation

◆ _vector

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

Definition at line 152 of file CoordinateBase.h.

◆ dimensions

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

Definition at line 111 of file CoordinateBase.h.


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