LSST Applications g0265f82a02+093ff98f47,g02d81e74bb+10352d6f39,g1f3e9fa97e+40b0fc677d,g2079a07aa2+14824f138e,g2bbee38e9b+093ff98f47,g337abbeb29+093ff98f47,g3ddfee87b4+064c02c7ee,g487adcacf7+7e842ebf4b,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g568d43a26c+1d7ac31cb0,g591dd9f2cf+fb1f69e2ea,g858d7b2824+10352d6f39,g8a8a8dda67+a6fc98d2e7,g8cdfe0ae6a+66d966b544,g99cad8db69+7ce8a7c20a,g9ddcbc5298+d4bad12328,ga1e77700b3+246acaaf9c,ga2e4dd1c03+064c02c7ee,ga8c6da7877+04f6ba86dc,gae46bcf261+093ff98f47,gb0e22166c9+3863383f4c,gba4ed39666+9664299f35,gbb8dafda3b+db40f59a7d,gbeb006f7da+e6a448e96d,gbf5cecdb8a+10352d6f39,gc0f3af6251+10a3fd39cd,gc120e1dc64+5839e50a77,gc28159a63d+093ff98f47,gcf0d15dbbd+064c02c7ee,gd2a12a3803+0c2c227a2b,gdaeeff99f8+a38ce5ea23,ge79ae78c31+093ff98f47,gee10cc3b42+a6fc98d2e7,gf1cff7945b+10352d6f39,w.2024.15
LSST Data Management Base Package
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
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)
 
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.
 
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.
 
std::tuple< T, T > asTuple () const noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
 Return a std::tuple representation of the coordinate object.
 

Static Public Attributes

static int const dimensions = 2
 
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)
 
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.

139 : _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.

141 : _vector(std::move(other._vector)) {}
T move(T... args)

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

184 : _vector(EigenVector::Constant(val)) {}
ImageT val
Definition CR.cc:146

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

187: _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.

188{ _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.

163{ 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.

173 {
174 return std::make_pair(_vector.x(), _vector.y());
175 }
T make_pair(T... args)

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

178 {
179 return std::make_tuple(_vector.x(), _vector.y());
180 }
T make_tuple(T... args)

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

154{ 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.

155{ return const_cast<EigenVector&>(_vector).coeffRef(n); }
Eigen::Matrix< T, 2, 1, Eigen::DontAlign > EigenVector

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

165{ 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.

167{ 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.

166{ 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.

168{ 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.

146 {
147 _vector = std::move(other._vector);
148 return *this;
149 }

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

142 {
143 _vector = other._vector;
144 return *this;
145 }

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

152{ 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.

153{ 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.

169{ _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.

170{ _vector.y() = y; }
int y
Definition SpanSet.cc:48

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