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 | Related Functions | List of all members
lsst::geom::CoordinateBase< Derived, T, N > Class Template Reference

A CRTP base class for coordinate objects. More...

#include <CoordinateBase.h>

Public Types

typedef T Element
 
typedef Eigen::Matrix< T, N, 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...
 

Static Public Attributes

static int const dimensions = N
 
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)
 Initialize all elements to a scalar. More...
 
template<typename Vector >
 CoordinateBase (Eigen::MatrixBase< Vector > const &vector)
 Initialize all elements from an N-d Eigen vector. More...
 
void _swap (CoordinateBase &other) noexcept
 

Protected Attributes

EigenVector _vector
 

Related Functions

(Note that these are not member functions.)

template<typename Derived , typename T , int N>
bool allclose (CoordinateBase< Derived, T, N > const &a, CoordinateBase< Derived, T, N > const &b, T rtol=static_cast< T >(1E-5), T atol=static_cast< T >(1E-8)) noexcept(std::is_nothrow_copy_constructible< T >::value &&std::is_nothrow_copy_assignable< T >::value)
 Floating-point comparison with tolerance. More...
 

Detailed Description

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

A CRTP base class for coordinate objects.

CoordinateBase has partial specializations for 2 and 3 dimensions so its subclasses don't have to.

Definition at line 54 of file CoordinateBase.h.

Member Typedef Documentation

◆ EigenVector

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

Definition at line 59 of file CoordinateBase.h.

◆ Element

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

Definition at line 57 of file CoordinateBase.h.

Constructor & Destructor Documentation

◆ CoordinateBase() [1/4]

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

Definition at line 64 of file CoordinateBase.h.

65  : _vector(other._vector) {}

◆ CoordinateBase() [2/4]

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

Definition at line 66 of file CoordinateBase.h.

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

◆ ~CoordinateBase()

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

◆ CoordinateBase() [3/4]

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

Initialize all elements to a scalar.

A public constructor with the same signature is expected for subclasses.

Definition at line 97 of file CoordinateBase.h.

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

◆ CoordinateBase() [4/4]

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

Initialize all elements from an N-d Eigen vector.

A public constructor with the same signature is expected for subclasses.

Definition at line 106 of file CoordinateBase.h.

106 : _vector(vector) {}

Member Function Documentation

◆ _swap()

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

Definition at line 108 of file CoordinateBase.h.

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

◆ asEigen()

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

89 { return _vector; }

◆ coeffRef() [1/2]

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

Definition at line 80 of file CoordinateBase.h.

80 { return _vector.coeffRef(n); }

◆ coeffRef() [2/2]

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

Definition at line 81 of file CoordinateBase.h.

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

◆ operator=() [1/2]

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

Definition at line 72 of file CoordinateBase.h.

72  {
73  _vector = std::move(other._vector);
74  return *this;
75  }

◆ operator=() [2/2]

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

Definition at line 68 of file CoordinateBase.h.

68  {
69  _vector = other._vector;
70  return *this;
71  }

◆ operator[]() [1/2]

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

Definition at line 78 of file CoordinateBase.h.

78 { return _vector[n]; }

◆ operator[]() [2/2]

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

Definition at line 79 of file CoordinateBase.h.

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

Friends And Related Function Documentation

◆ allclose()

template<typename Derived , typename T , int N>
bool allclose ( CoordinateBase< Derived, T, N > const &  a,
CoordinateBase< Derived, T, N > const &  b,
rtol = static_cast< T >(1E-5),
atol = static_cast< T >(1E-8) 
) const &&
related

Floating-point comparison with tolerance.

Interface, naming, and default tolerances matches Numpy.

Definition at line 30 of file CoordinateBase.cc.

32  {
33  Eigen::Array<T, N, 1> diff = (a.asEigen().array() - b.asEigen().array()).abs();
34  Eigen::Array<T, N, 1> rhs = (0.5 * (a.asEigen().array() + b.asEigen().array())).abs();
35  rhs *= rtol;
36  rhs += atol;
37  return (diff <= rhs).all();
38 }
table::Key< int > b
table::Key< int > a
T atol(T... args)
Angle abs(Angle const &a)
Definition: Angle.h:106

Member Data Documentation

◆ _vector

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

Definition at line 109 of file CoordinateBase.h.

◆ dimensions

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

Definition at line 58 of file CoordinateBase.h.

◆ IS_ELEMENT_NOTHROW_ASSIGNABLE

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

Definition at line 61 of file CoordinateBase.h.

◆ IS_ELEMENT_NOTHROW_COPYABLE

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

Definition at line 60 of file CoordinateBase.h.


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