lsst::afw::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 &)=default
	CoordinateBase (CoordinateBase &&)=default
CoordinateBase &	operator= (CoordinateBase const &)=default
CoordinateBase &	operator= (CoordinateBase &&)=default
	~CoordinateBase ()=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
	Return a fixed-size Eigen representation of the coordinate object. More...

Static Public Attributes
static int const	dimensions = N

Protected Member Functions
	CoordinateBase (T val=static_cast< T >(0))
	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)

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))
	Floating-point comparison with tolerance. More...

Detailed Description

template<typename Derived, typename T, int N>
class lsst::afw::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 52 of file CoordinateBase.h.

Member Typedef Documentation

EigenVector

template<typename Derived, typename T, int N>

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

Definition at line 56 of file CoordinateBase.h.

Element

template<typename Derived, typename T, int N>

typedef T lsst::afw::geom::CoordinateBase< Derived, T, N >::Element

Definition at line 54 of file CoordinateBase.h.

Constructor & Destructor Documentation

CoordinateBase() [1/4]

template<typename Derived, typename T, int N>

lsst::afw::geom::CoordinateBase< Derived, T, N >::CoordinateBase ( CoordinateBase< Derived, T, N > const &  )

default

CoordinateBase() [2/4]

template<typename Derived, typename T, int N>

lsst::afw::geom::CoordinateBase< Derived, T, N >::CoordinateBase ( CoordinateBase< Derived, T, N > &&  )

default

~CoordinateBase()

template<typename Derived, typename T, int N>

lsst::afw::geom::CoordinateBase< Derived, T, N >::~CoordinateBase ( )

default

CoordinateBase() [3/4]

template<typename Derived, typename T, int N>

lsst::afw::geom::CoordinateBase< Derived, T, N >::CoordinateBase ( T  val = static_cast<T>(0) )

inlineexplicitprotected

Initialize all elements to a scalar.

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

Definition at line 83 of file CoordinateBase.h.

: _vector(EigenVector::Constant(val)) {}

CoordinateBase() [4/4]

template<typename Derived, typename T, int N>

template<typename Vector >

lsst::afw::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 91 of file CoordinateBase.h.

: _vector(vector) {}

Member Function Documentation

_swap()

template<typename Derived, typename T, int N>

void lsst::afw::geom::CoordinateBase< Derived, T, N >::_swap ( CoordinateBase< Derived, T, N > &  other )

inlineprotected

Definition at line 93 of file CoordinateBase.h.

{ _vector.swap(other._vector); }

asEigen()

template<typename Derived, typename T, int N>

EigenVector const& lsst::afw::geom::CoordinateBase< Derived, T, N >::asEigen ( ) const

inline

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

{ return _vector; }

coeffRef() [1/2]

template<typename Derived, typename T, int N>

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

inline

Definition at line 66 of file CoordinateBase.h.

{ return _vector.coeffRef(n); }

coeffRef() [2/2]

template<typename Derived, typename T, int N>

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

inline

Definition at line 67 of file CoordinateBase.h.

{ return const_cast<EigenVector&>(_vector).coeffRef(n); }

operator=() [1/2]

template<typename Derived, typename T, int N>

CoordinateBase& lsst::afw::geom::CoordinateBase< Derived, T, N >::operator= ( CoordinateBase< Derived, T, N > const &  )

default

operator=() [2/2]

template<typename Derived, typename T, int N>

CoordinateBase& lsst::afw::geom::CoordinateBase< Derived, T, N >::operator= ( CoordinateBase< Derived, T, N > &&  )

default

operator[]() [1/2]

template<typename Derived, typename T, int N>

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

inline

Definition at line 64 of file CoordinateBase.h.

{ return _vector[n]; }

operator[]() [2/2]

template<typename Derived, typename T, int N>

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

inline

Definition at line 65 of file CoordinateBase.h.

{ 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, T  rtol = static_cast< T >(1E-5), T  atol = static_cast< T >(1E-8)  )

related

Floating-point comparison with tolerance.

Interface, naming, and default tolerances matches Numpy.

Definition at line 32 of file CoordinateBase.cc.

                      {
    Eigen::Array<T, N, 1> diff = (a.asEigen().array() - b.asEigen().array()).abs();
    Eigen::Array<T, N, 1> rhs = (0.5 * (a.asEigen().array() + b.asEigen().array())).abs();
    rhs *= rtol;
    rhs += atol;
    return (diff <= rhs).all();
}

Member Data Documentation

_vector

template<typename Derived, typename T, int N>

EigenVector lsst::afw::geom::CoordinateBase< Derived, T, N >::_vector

protected

Definition at line 94 of file CoordinateBase.h.

dimensions

template<typename Derived, typename T, int N>

int const lsst::afw::geom::CoordinateBase< Derived, T, N >::dimensions = N

static

Definition at line 55 of file CoordinateBase.h.

---

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

• /home/jenkins-slave/snowflake/release/lsstsw/stack/Linux64/afw/15.0-29-ga12a2b06e/include/lsst/afw/geom/CoordinateBase.h