LSST Applications g1cfbe01172+01aa18f939,g20cdd03214+31e6b93548,g28da252d5a+ea8665a95b,g2bbee38e9b+9ec6cc348d,g2bc492864f+9ec6cc348d,g347aa1857d+9ec6cc348d,g3a166c0a6a+9ec6cc348d,g4322eb9e3a+65eff1e020,g461a3dce89+b86e4b8053,g50ff169b8f+f991eae79d,g52b1c1532d+b86e4b8053,g607f77f49a+31e6b93548,g78056777b3+8ae2798781,g858d7b2824+31e6b93548,g8cd86fa7b1+4851e61ca4,g9ddcbc5298+f24b38b85a,ga1e77700b3+3309dba821,gae0086650b+b86e4b8053,gb0e22166c9+6076c0b52b,gbb886bcc26+dccb771098,gbd462c55f0+dc07f8e65d,gc0c51c7ec2+31e6b93548,gc120e1dc64+a417ce3171,gc28159a63d+9ec6cc348d,gc2a6998b7e+f95f64aeae,gcdd4ae20e8+507450c4cd,gcf0d15dbbd+507450c4cd,gd1535ee943+bcf88ba65f,gd598c5cd71+66126f91fb,gdaeeff99f8+006e14e809,gdbce86181e+39d5515b1a,ge3d4d395c2+b12d4d6a95,ge79ae78c31+9ec6cc348d,gf048a9a2f4+d9c36e6b63,gfbcc870c63+ea41c4420b,w.2024.27
LSST Data Management Base Package
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Related Symbols | List of all members
lsst::geom::CoordinateBase< Derived, T, N > Class Template Reference

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

#include <CoordinateBase.h>

Inheritance diagram for lsst::geom::CoordinateBase< Derived, T, N >:
lsst::geom::ExtentBase< int, N > lsst::geom::ExtentBase< double, N > lsst::geom::PointBase< int, N > lsst::geom::PointBase< double, N >

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.
 

Static Public Attributes

static int const dimensions = N
 
static bool constexpr IS_ELEMENT_NOTHROW_COPYABLE = std::is_nothrow_copy_constructible<T>::value
 
static bool constexpr 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.
 
template<typename Vector >
 CoordinateBase (Eigen::MatrixBase< Vector > const &vector)
 Initialize all elements from an N-d Eigen vector.
 
void _swap (CoordinateBase &other) noexcept
 

Protected Attributes

EigenVector _vector
 

Related Symbols

(Note that these are not member symbols.)

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.
 

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 ( T 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 Symbol Documentation

◆ allclose()

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) ) 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
T atol(T... args)
Angle abs(Angle const &a)
Definition Angle.h:113

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>
bool constexpr 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>
bool constexpr 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: