LSSTApplications  17.0+11,17.0+34,17.0+56,17.0+57,17.0+59,17.0+7,17.0-1-g377950a+33,17.0.1-1-g114240f+2,17.0.1-1-g4d4fbc4+28,17.0.1-1-g55520dc+49,17.0.1-1-g5f4ed7e+52,17.0.1-1-g6dd7d69+17,17.0.1-1-g8de6c91+11,17.0.1-1-gb9095d2+7,17.0.1-1-ge9fec5e+5,17.0.1-1-gf4e0155+55,17.0.1-1-gfc65f5f+50,17.0.1-1-gfc6fb1f+20,17.0.1-10-g87f9f3f+1,17.0.1-11-ge9de802+16,17.0.1-16-ga14f7d5c+4,17.0.1-17-gc79d625+1,17.0.1-17-gdae4c4a+8,17.0.1-2-g26618f5+29,17.0.1-2-g54f2ebc+9,17.0.1-2-gf403422+1,17.0.1-20-g2ca2f74+6,17.0.1-23-gf3eadeb7+1,17.0.1-3-g7e86b59+39,17.0.1-3-gb5ca14a,17.0.1-3-gd08d533+40,17.0.1-30-g596af8797,17.0.1-4-g59d126d+4,17.0.1-4-gc69c472+5,17.0.1-6-g5afd9b9+4,17.0.1-7-g35889ee+1,17.0.1-7-gc7c8782+18,17.0.1-9-gc4bbfb2+3,w.2019.22
LSSTDataManagementBasePackage
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
lsst::geom::CoordinateBase< Derived, T, 3 > Class Template Reference

Specialization of CoordinateBase for 3 dimensions. More...

#include <CoordinateBase.h>

Public Types

typedef T Element
 
typedef Eigen::Matrix< T, 3, 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 const & getZ () const noexcept
 
T & getX () noexcept
 
T & getY () noexcept
 
T & getZ () noexcept
 
void setX (T x) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
 
void setY (T y) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
 
void setZ (T z) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
 
std::tuple< T, 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 = 3
 
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, 3 >

Specialization of CoordinateBase for 3 dimensions.

Definition at line 196 of file CoordinateBase.h.

Member Typedef Documentation

◆ EigenVector

template<typename Derived , typename T >
typedef Eigen::Matrix<T, 3, 1, Eigen::DontAlign> lsst::geom::CoordinateBase< Derived, T, 3 >::EigenVector

Definition at line 200 of file CoordinateBase.h.

◆ Element

template<typename Derived , typename T >
typedef T lsst::geom::CoordinateBase< Derived, T, 3 >::Element

Definition at line 198 of file CoordinateBase.h.

Constructor & Destructor Documentation

◆ CoordinateBase() [1/4]

template<typename Derived , typename T >
lsst::geom::CoordinateBase< Derived, T, 3 >::CoordinateBase ( CoordinateBase< Derived, T, 3 > const &  other)
inlinenoexcept

Definition at line 205 of file CoordinateBase.h.

206  : _vector(other._vector) {}
other
ItemVariant const * other
Definition: Schema.cc:56

◆ CoordinateBase() [2/4]

template<typename Derived , typename T >
lsst::geom::CoordinateBase< Derived, T, 3 >::CoordinateBase ( CoordinateBase< Derived, T, 3 > &&  other)
inlinenoexcept

Definition at line 207 of file CoordinateBase.h.

208  : _vector(std::move(other._vector)) {}
std::move
T move(T... args)
other
ItemVariant const * other
Definition: Schema.cc:56

◆ ~CoordinateBase()

template<typename Derived , typename T >
lsst::geom::CoordinateBase< Derived, T, 3 >::~CoordinateBase ( )
defaultnoexcept

◆ CoordinateBase() [3/4]

template<typename Derived , typename T >
lsst::geom::CoordinateBase< Derived, T, 3 >::CoordinateBase ( T  val = static_cast<T>(0))
inlineexplicitprotectednoexcept

Definition at line 248 of file CoordinateBase.h.

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

◆ CoordinateBase() [4/4]

template<typename Derived , typename T >
template<typename Vector >
lsst::geom::CoordinateBase< Derived, T, 3 >::CoordinateBase ( Eigen::MatrixBase< Vector > const &  vector)
inlineexplicitprotected

Definition at line 252 of file CoordinateBase.h.

252 : _vector(vector) {}

Member Function Documentation

◆ _swap()

template<typename Derived , typename T >
void lsst::geom::CoordinateBase< Derived, T, 3 >::_swap ( CoordinateBase< Derived, T, 3 > &  other)
inlineprotectednoexcept

Definition at line 253 of file CoordinateBase.h.

253 { _vector.swap(other._vector); }
other
ItemVariant const * other
Definition: Schema.cc:56

◆ asEigen()

template<typename Derived , typename T >
EigenVector const& lsst::geom::CoordinateBase< Derived, T, 3 >::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 230 of file CoordinateBase.h.

230 { return _vector; }

◆ asTuple()

template<typename Derived , typename T >
std::tuple<T, T, T> lsst::geom::CoordinateBase< Derived, T, 3 >::asTuple ( ) const
inlinenoexcept

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

Definition at line 243 of file CoordinateBase.h.

243  {
244  return std::make_tuple(_vector.x(), _vector.y(), _vector.z());
245  }
std::make_tuple
T make_tuple(T... args)

◆ coeffRef() [1/2]

template<typename Derived , typename T >
T& lsst::geom::CoordinateBase< Derived, T, 3 >::coeffRef ( int  n)
inline

Definition at line 221 of file CoordinateBase.h.

221 { return _vector.coeffRef(n); }

◆ coeffRef() [2/2]

template<typename Derived , typename T >
T const& lsst::geom::CoordinateBase< Derived, T, 3 >::coeffRef ( int  n) const
inline

Definition at line 222 of file CoordinateBase.h.

222 { return const_cast<EigenVector&>(_vector).coeffRef(n); }
lsst::geom::CoordinateBase< Derived, T, 3 >::EigenVector
Eigen::Matrix< T, 3, 1, Eigen::DontAlign > EigenVector
Definition: CoordinateBase.h:200

◆ getX() [1/2]

template<typename Derived , typename T >
T const& lsst::geom::CoordinateBase< Derived, T, 3 >::getX ( ) const
inlinenoexcept

Definition at line 232 of file CoordinateBase.h.

232 { return _vector.x(); }

◆ getX() [2/2]

template<typename Derived , typename T >
T& lsst::geom::CoordinateBase< Derived, T, 3 >::getX ( )
inlinenoexcept

Definition at line 235 of file CoordinateBase.h.

235 { return _vector.x(); }

◆ getY() [1/2]

template<typename Derived , typename T >
T const& lsst::geom::CoordinateBase< Derived, T, 3 >::getY ( ) const
inlinenoexcept

Definition at line 233 of file CoordinateBase.h.

233 { return _vector.y(); }

◆ getY() [2/2]

template<typename Derived , typename T >
T& lsst::geom::CoordinateBase< Derived, T, 3 >::getY ( )
inlinenoexcept

Definition at line 236 of file CoordinateBase.h.

236 { return _vector.y(); }

◆ getZ() [1/2]

template<typename Derived , typename T >
T const& lsst::geom::CoordinateBase< Derived, T, 3 >::getZ ( ) const
inlinenoexcept

Definition at line 234 of file CoordinateBase.h.

234 { return _vector.z(); }

◆ getZ() [2/2]

template<typename Derived , typename T >
T& lsst::geom::CoordinateBase< Derived, T, 3 >::getZ ( )
inlinenoexcept

Definition at line 237 of file CoordinateBase.h.

237 { return _vector.z(); }

◆ operator=() [1/2]

template<typename Derived , typename T >
CoordinateBase& lsst::geom::CoordinateBase< Derived, T, 3 >::operator= ( CoordinateBase< Derived, T, 3 > const &  other)
inlinenoexcept

Definition at line 209 of file CoordinateBase.h.

209  {
210  _vector = other._vector;
211  return *this;
212  }
other
ItemVariant const * other
Definition: Schema.cc:56

◆ operator=() [2/2]

template<typename Derived , typename T >
CoordinateBase& lsst::geom::CoordinateBase< Derived, T, 3 >::operator= ( CoordinateBase< Derived, T, 3 > &&  other)
inlinenoexcept

Definition at line 213 of file CoordinateBase.h.

213  {
214  _vector = std::move(other._vector);
215  return *this;
216  }
std::move
T move(T... args)
other
ItemVariant const * other
Definition: Schema.cc:56

◆ operator[]() [1/2]

template<typename Derived , typename T >
T& lsst::geom::CoordinateBase< Derived, T, 3 >::operator[] ( int  n)
inline

Definition at line 219 of file CoordinateBase.h.

219 { return _vector[n]; }

◆ operator[]() [2/2]

template<typename Derived , typename T >
T const& lsst::geom::CoordinateBase< Derived, T, 3 >::operator[] ( int  n) const
inline

Definition at line 220 of file CoordinateBase.h.

220 { return const_cast<EigenVector&>(_vector)[n]; }
lsst::geom::CoordinateBase< Derived, T, 3 >::EigenVector
Eigen::Matrix< T, 3, 1, Eigen::DontAlign > EigenVector
Definition: CoordinateBase.h:200

◆ setX()

template<typename Derived , typename T >
void lsst::geom::CoordinateBase< Derived, T, 3 >::setX ( T  x)
inlinenoexcept

Definition at line 238 of file CoordinateBase.h.

238 { _vector.x() = x; }
x
double x
Definition: ChebyshevBoundedField.cc:277

◆ setY()

template<typename Derived , typename T >
void lsst::geom::CoordinateBase< Derived, T, 3 >::setY ( T  y)
inlinenoexcept

Definition at line 239 of file CoordinateBase.h.

239 { _vector.y() = y; }
y
int y
Definition: SpanSet.cc:49

◆ setZ()

template<typename Derived , typename T >
void lsst::geom::CoordinateBase< Derived, T, 3 >::setZ ( T  z)
inlinenoexcept

Definition at line 240 of file CoordinateBase.h.

240 { _vector.z() = z; }
z
double z
Definition: Match.cc:44

Member Data Documentation

◆ _vector

template<typename Derived , typename T >
EigenVector lsst::geom::CoordinateBase< Derived, T, 3 >::_vector
protected

Definition at line 254 of file CoordinateBase.h.

◆ dimensions

template<typename Derived , typename T >
int const lsst::geom::CoordinateBase< Derived, T, 3 >::dimensions = 3
static

Definition at line 199 of file CoordinateBase.h.

◆ IS_ELEMENT_NOTHROW_ASSIGNABLE

template<typename Derived , typename T >
bool constexpr lsst::geom::CoordinateBase< Derived, T, 3 >::IS_ELEMENT_NOTHROW_ASSIGNABLE = std::is_nothrow_copy_assignable<T>::value
static

Definition at line 202 of file CoordinateBase.h.

◆ IS_ELEMENT_NOTHROW_COPYABLE

template<typename Derived , typename T >
bool constexpr lsst::geom::CoordinateBase< Derived, T, 3 >::IS_ELEMENT_NOTHROW_COPYABLE = std::is_nothrow_copy_constructible<T>::value
static

Definition at line 201 of file CoordinateBase.h.

The documentation for this class was generated from the following file:
Generated on Sat Jun 8 2019 08:10:03 for LSSTApplications by   doxygen 1.8.13