lsst::geom::CoordinateBase< Derived, T, 2 > Class Template Reference

Specialization of CoordinateBase for 2 dimensions. More...

#include <CoordinateBase.h>

Public Types
typedef T	Element
typedef Eigen::Matrix< T, 2, 1, Eigen::DontAlign >	EigenVector

Public Member Functions
	CoordinateBase (CoordinateBase const &other) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
	CoordinateBase (CoordinateBase &&other) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
CoordinateBase &	operator= (CoordinateBase const &other) noexcept(IS_ELEMENT_NOTHROW_ASSIGNABLE)
CoordinateBase &	operator= (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...
T const &	getX () const noexcept
T const &	getY () const noexcept
T &	getX () noexcept
T &	getY () noexcept
void	setX (T x) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
void	setY (T y) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
std::pair< T, T >	asPair () const noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
	Return a std::pair representation of the coordinate object. More...
std::tuple< T, T >	asTuple () const noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
	Return a std::tuple representation of the coordinate object. More...

Static Public Attributes
static int const	dimensions = 2
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)
template<typename Vector >
	CoordinateBase (Eigen::MatrixBase< Vector > const &vector)
void	_swap (CoordinateBase &other) noexcept

Protected Attributes
EigenVector	_vector

Detailed Description

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

Specialization of CoordinateBase for 2 dimensions.

Definition at line 129 of file CoordinateBase.h.

Member Typedef Documentation

EigenVector

template<typename Derived , typename T >

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

Definition at line 133 of file CoordinateBase.h.

Element

template<typename Derived , typename T >

typedef T lsst::geom::CoordinateBase< Derived, T, 2 >::Element

Definition at line 131 of file CoordinateBase.h.

Constructor & Destructor Documentation

CoordinateBase() [1/4]

template<typename Derived , typename T >

lsst::geom::CoordinateBase< Derived, T, 2 >::CoordinateBase ( CoordinateBase< Derived, T, 2 > const &  other )

inlinenoexcept

Definition at line 138 of file CoordinateBase.h.

            : _vector(other._vector) {}

CoordinateBase() [2/4]

template<typename Derived , typename T >

lsst::geom::CoordinateBase< Derived, T, 2 >::CoordinateBase ( CoordinateBase< Derived, T, 2 > &&  other )

inlinenoexcept

Definition at line 140 of file CoordinateBase.h.

            : _vector(std::move(other._vector)) {}

~CoordinateBase()

template<typename Derived , typename T >

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

defaultnoexcept

CoordinateBase() [3/4]

template<typename Derived , typename T >

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

inlineexplicitprotectednoexcept

Definition at line 183 of file CoordinateBase.h.

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

CoordinateBase() [4/4]

template<typename Derived , typename T >

template<typename Vector >

lsst::geom::CoordinateBase< Derived, T, 2 >::CoordinateBase ( Eigen::MatrixBase< Vector > const &  vector )

inlineexplicitprotected

Definition at line 187 of file CoordinateBase.h.

: _vector(vector) {}

Member Function Documentation

_swap()

template<typename Derived , typename T >

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

inlineprotectednoexcept

Definition at line 188 of file CoordinateBase.h.

{ _vector.swap(other._vector); }

asEigen()

template<typename Derived , typename T >

EigenVector const& lsst::geom::CoordinateBase< Derived, T, 2 >::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 163 of file CoordinateBase.h.

{ return _vector; }

asPair()

template<typename Derived , typename T >

std::pair<T, T> lsst::geom::CoordinateBase< Derived, T, 2 >::asPair ( ) const

inlinenoexcept

Return a std::pair representation of the coordinate object.

Definition at line 173 of file CoordinateBase.h.

                                                                       {
        return std::make_pair(_vector.x(), _vector.y());
    }

asTuple()

template<typename Derived , typename T >

std::tuple<T, T> lsst::geom::CoordinateBase< Derived, T, 2 >::asTuple ( ) const

inlinenoexcept

Return a std::tuple representation of the coordinate object.

Definition at line 178 of file CoordinateBase.h.

                                                                         {
        return std::make_tuple(_vector.x(), _vector.y());
    }

coeffRef() [1/2]

template<typename Derived , typename T >

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

inline

Definition at line 154 of file CoordinateBase.h.

{ return _vector.coeffRef(n); }

coeffRef() [2/2]

template<typename Derived , typename T >

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

inline

Definition at line 155 of file CoordinateBase.h.

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

getX() [1/2]

template<typename Derived , typename T >

T const& lsst::geom::CoordinateBase< Derived, T, 2 >::getX ( ) const

inlinenoexcept

Definition at line 165 of file CoordinateBase.h.

{ return _vector.x(); }

getX() [2/2]

template<typename Derived , typename T >

T& lsst::geom::CoordinateBase< Derived, T, 2 >::getX ( )

inlinenoexcept

Definition at line 167 of file CoordinateBase.h.

{ return _vector.x(); }

getY() [1/2]

template<typename Derived , typename T >

T const& lsst::geom::CoordinateBase< Derived, T, 2 >::getY ( ) const

inlinenoexcept

Definition at line 166 of file CoordinateBase.h.

{ return _vector.y(); }

getY() [2/2]

template<typename Derived , typename T >

T& lsst::geom::CoordinateBase< Derived, T, 2 >::getY ( )

inlinenoexcept

Definition at line 168 of file CoordinateBase.h.

{ return _vector.y(); }

operator=() [1/2]

template<typename Derived , typename T >

CoordinateBase& lsst::geom::CoordinateBase< Derived, T, 2 >::operator= ( CoordinateBase< Derived, T, 2 > &&  other )

inlinenoexcept

Definition at line 146 of file CoordinateBase.h.

                                                                                              {
        _vector = std::move(other._vector);
        return *this;
    }

operator=() [2/2]

template<typename Derived , typename T >

CoordinateBase& lsst::geom::CoordinateBase< Derived, T, 2 >::operator= ( CoordinateBase< Derived, T, 2 > const &  other )

inlinenoexcept

Definition at line 142 of file CoordinateBase.h.

                                                                                                   {
        _vector = other._vector;
        return *this;
    }

operator[]() [1/2]

template<typename Derived , typename T >

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

inline

Definition at line 152 of file CoordinateBase.h.

{ return _vector[n]; }

operator[]() [2/2]

template<typename Derived , typename T >

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

inline

Definition at line 153 of file CoordinateBase.h.

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

setX()

template<typename Derived , typename T >

void lsst::geom::CoordinateBase< Derived, T, 2 >::setX ( T  x )

inlinenoexcept

Definition at line 169 of file CoordinateBase.h.

{ _vector.x() = x; }

setY()

template<typename Derived , typename T >

void lsst::geom::CoordinateBase< Derived, T, 2 >::setY ( T  y )

inlinenoexcept

Definition at line 170 of file CoordinateBase.h.

{ _vector.y() = y; }

Member Data Documentation

_vector

template<typename Derived , typename T >

EigenVector lsst::geom::CoordinateBase< Derived, T, 2 >::_vector

protected

Definition at line 189 of file CoordinateBase.h.

dimensions

template<typename Derived , typename T >

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

static

Definition at line 132 of file CoordinateBase.h.

IS_ELEMENT_NOTHROW_ASSIGNABLE

template<typename Derived , typename T >

constexpr bool lsst::geom::CoordinateBase< Derived, T, 2 >::IS_ELEMENT_NOTHROW_ASSIGNABLE = std::is_nothrow_copy_assignable<T>::value

staticconstexpr

Definition at line 135 of file CoordinateBase.h.

IS_ELEMENT_NOTHROW_COPYABLE

template<typename Derived , typename T >

constexpr bool lsst::geom::CoordinateBase< Derived, T, 2 >::IS_ELEMENT_NOTHROW_COPYABLE = std::is_nothrow_copy_constructible<T>::value

staticconstexpr

Definition at line 134 of file CoordinateBase.h.

---

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

• /j/snowflake/release/lsstsw/stack/cb4e2dc/Linux64/geom/20.0.0-3-gbd60e8c+187b78b4b8/include/lsst/geom/CoordinateBase.h