lsst.geom  20.0.0-5-g8f08a60+4fac22bdb7
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.

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

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.

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

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

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

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

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

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

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

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.

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: