lsst.geom gf0d0fc72e1+e8d1976569
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, 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)
 
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...
 
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.

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

◆ ~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 ( val = static_cast<T>(0))
inlineexplicitprotectednoexcept

Definition at line 248 of file CoordinateBase.h.

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

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.

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

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

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

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

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

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

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

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

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

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

◆ operator=() [1/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.

◆ operator=() [2/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.

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

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

◆ setX()

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

Definition at line 238 of file CoordinateBase.h.

◆ setY()

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

Definition at line 239 of file CoordinateBase.h.

◆ setZ()

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

Definition at line 240 of file CoordinateBase.h.

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
staticconstexpr

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
staticconstexpr

Definition at line 201 of file CoordinateBase.h.


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