LSST Applications g042eb84c57+730a74494b,g04e9c324dd+8c5ae1fdc5,g134cb467dc+1f1e3e7524,g199a45376c+0ba108daf9,g1fd858c14a+fa7d31856b,g210f2d0738+f66ac109ec,g262e1987ae+83a3acc0e5,g29ae962dfc+d856a2cb1f,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+a1e0c9f713,g47891489e3+0d594cb711,g4d44eb3520+c57ec8f3ed,g4d7b6aa1c5+f66ac109ec,g53246c7159+8c5ae1fdc5,g56a1a4eaf3+fd7ad03fde,g64539dfbff+f66ac109ec,g67b6fd64d1+0d594cb711,g67fd3c3899+f66ac109ec,g6985122a63+0d594cb711,g74acd417e5+3098891321,g786e29fd12+668abc6043,g81db2e9a8d+98e2ab9f28,g87389fa792+8856018cbb,g89139ef638+0d594cb711,g8d7436a09f+80fda9ce03,g8ea07a8fe4+760ca7c3fc,g90f42f885a+033b1d468d,g97be763408+a8a29bda4b,g99822b682c+e3ec3c61f9,g9d5c6a246b+0d5dac0c3d,ga41d0fce20+9243b26dd2,gbf99507273+8c5ae1fdc5,gd7ef33dd92+0d594cb711,gdab6d2f7ff+3098891321,ge410e46f29+0d594cb711,geaed405ab2+c4bbc419c6,gf9a733ac38+8c5ae1fdc5,w.2025.38
LSST Data Management Base Package
Loading...
Searching...
No Matches
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.
 

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.

A CRTP base class for coordinate objects.

◆ 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.

◆ ~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.

◆ 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 {
74 return *this;
75 }
T move(T... args)

◆ 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 {
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}
EigenVector const & asEigen() const noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
Return a fixed-size Eigen representation of the coordinate object.

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: