LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
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 &other) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
 
 CoordinateBase (CoordinateBase &&other) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
 
CoordinateBaseoperator= (CoordinateBase const &other) noexcept(IS_ELEMENT_NOTHROW_ASSIGNABLE)
 
CoordinateBaseoperator= (CoordinateBase &&other) noexcept(IS_ELEMENT_NOTHROW_ASSIGNABLE)
 
 ~CoordinateBase () noexcept=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 noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
 Return a fixed-size Eigen representation of the coordinate object. More...
 
T const & getX () const noexcept
 
T const & getY () const noexcept
 
T const & getZ () const noexcept
 
T & getX () noexcept
 
T & getY () noexcept
 
T & getZ () noexcept
 
void setX (T x) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
 
void setY (T y) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
 
void setZ (T z) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
 
std::tuple< T, T, T > asTuple () const noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
 Return a std::tuple representation of the coordinate object. More...
 

Static Public Attributes

static int const dimensions = 3
 
static constexpr bool IS_ELEMENT_NOTHROW_COPYABLE = std::is_nothrow_copy_constructible<T>::value
 
static constexpr bool IS_ELEMENT_NOTHROW_ASSIGNABLE = std::is_nothrow_copy_assignable<T>::value
 

Protected Member Functions

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

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 196 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 200 of file CoordinateBase.h.

◆ Element

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

Definition at line 198 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 &  other)
inlinenoexcept

Definition at line 205 of file CoordinateBase.h.

206  : _vector(other._vector) {}

◆ CoordinateBase() [2/4]

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

Definition at line 207 of file CoordinateBase.h.

208  : _vector(std::move(other._vector)) {}
T move(T... args)

◆ ~CoordinateBase()

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

◆ CoordinateBase() [3/4]

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

Definition at line 248 of file CoordinateBase.h.

249  : _vector(EigenVector::Constant(val)) {}
ImageT val
Definition: CR.cc:146

◆ 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 252 of file CoordinateBase.h.

252 : _vector(vector) {}

Member Function Documentation

◆ _swap()

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

Definition at line 253 of file CoordinateBase.h.

253 { _vector.swap(other._vector); }

◆ asEigen()

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

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 230 of file CoordinateBase.h.

230 { return _vector; }

◆ asTuple()

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

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

Definition at line 243 of file CoordinateBase.h.

243  {
244  return std::make_tuple(_vector.x(), _vector.y(), _vector.z());
245  }
T make_tuple(T... args)

◆ coeffRef() [1/2]

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

Definition at line 221 of file CoordinateBase.h.

221 { return _vector.coeffRef(n); }

◆ coeffRef() [2/2]

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

Definition at line 222 of file CoordinateBase.h.

222 { return const_cast<EigenVector&>(_vector).coeffRef(n); }
Eigen::Matrix< T, 3, 1, Eigen::DontAlign > EigenVector

◆ getX() [1/2]

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

Definition at line 232 of file CoordinateBase.h.

232 { return _vector.x(); }

◆ getX() [2/2]

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

Definition at line 235 of file CoordinateBase.h.

235 { return _vector.x(); }

◆ getY() [1/2]

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

Definition at line 233 of file CoordinateBase.h.

233 { return _vector.y(); }

◆ getY() [2/2]

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

Definition at line 236 of file CoordinateBase.h.

236 { return _vector.y(); }

◆ getZ() [1/2]

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

Definition at line 234 of file CoordinateBase.h.

234 { return _vector.z(); }

◆ getZ() [2/2]

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

Definition at line 237 of file CoordinateBase.h.

237 { return _vector.z(); }

◆ operator=() [1/2]

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

Definition at line 213 of file CoordinateBase.h.

213  {
214  _vector = std::move(other._vector);
215  return *this;
216  }

◆ operator=() [2/2]

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

Definition at line 209 of file CoordinateBase.h.

209  {
210  _vector = other._vector;
211  return *this;
212  }

◆ operator[]() [1/2]

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

Definition at line 219 of file CoordinateBase.h.

219 { return _vector[n]; }

◆ operator[]() [2/2]

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

Definition at line 220 of file CoordinateBase.h.

220 { return const_cast<EigenVector&>(_vector)[n]; }

◆ setX()

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

Definition at line 238 of file CoordinateBase.h.

238 { _vector.x() = x; }
double x

◆ setY()

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

Definition at line 239 of file CoordinateBase.h.

239 { _vector.y() = y; }
int y
Definition: SpanSet.cc:48

◆ setZ()

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

Definition at line 240 of file CoordinateBase.h.

240 { _vector.z() = z; }
double z
Definition: Match.cc:44

Member Data Documentation

◆ _vector

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

Definition at line 254 of file CoordinateBase.h.

◆ dimensions

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

Definition at line 199 of file CoordinateBase.h.

◆ IS_ELEMENT_NOTHROW_ASSIGNABLE

template<typename Derived , typename T >
constexpr bool lsst::geom::CoordinateBase< Derived, T, 3 >::IS_ELEMENT_NOTHROW_ASSIGNABLE = std::is_nothrow_copy_assignable<T>::value
staticconstexpr

Definition at line 202 of file CoordinateBase.h.

◆ IS_ELEMENT_NOTHROW_COPYABLE

template<typename Derived , typename T >
constexpr bool lsst::geom::CoordinateBase< Derived, T, 3 >::IS_ELEMENT_NOTHROW_COPYABLE = std::is_nothrow_copy_constructible<T>::value
staticconstexpr

Definition at line 201 of file CoordinateBase.h.


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