lsst.geom  21.0.0-2-g8f08a60+9402881886
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Related Functions | List of all members
lsst::geom::ExtentBase< T, N > Class Template Reference

#include <Extent.h>

Inheritance diagram for lsst::geom::ExtentBase< T, N >:
lsst::geom::CoordinateBase< Extent< T, N >, T, N > lsst::geom::Extent< double, 2 > lsst::geom::Extent< int, 2 > lsst::geom::Extent< T, N >

Public Types

typedef T Element
 
typedef Eigen::Matrix< T, N, 1, Eigen::DontAlign > EigenVector
 

Public Member Functions

 ExtentBase (ExtentBase const &)=default
 
 ExtentBase (ExtentBase &&)=default
 
ExtentBaseoperator= (ExtentBase const &)=default
 
ExtentBaseoperator= (ExtentBase &&)=default
 
 ~ExtentBase ()=default
 
computeSquaredNorm () const
 Return the squared L2 norm of the Extent (x^2 + y^2 + ...). More...
 
computeNorm () const
 Return the L2 norm of the Extent (sqrt(x^2 + y^2 + ...)). More...
 
bool operator== (Extent< T, N > const &other) const noexcept
 Standard equality comparison. More...
 
bool operator!= (Extent< T, N > const &other) const noexcept
 Standard inequality comparison. More...
 
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...
 
Named comparison functions

Note that these return CoordinateExpr, not bool.

Unlike most arithmetic and assignment operators, scalar interoperability is provided for comparisons; expressions like

if (all(extent.gt(0))) ...

are both ubiquitous and easy to interpret.

CoordinateExpr< N > eq (Extent< T, N > const &other) const noexcept
 
CoordinateExpr< N > ne (Extent< T, N > const &other) const noexcept
 
CoordinateExpr< N > lt (Extent< T, N > const &other) const noexcept
 
CoordinateExpr< N > le (Extent< T, N > const &other) const noexcept
 
CoordinateExpr< N > gt (Extent< T, N > const &other) const noexcept
 
CoordinateExpr< N > ge (Extent< T, N > const &other) const noexcept
 
CoordinateExpr< N > eq (T scalar) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 
CoordinateExpr< N > ne (T scalar) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 
CoordinateExpr< N > lt (T scalar) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 
CoordinateExpr< N > le (T scalar) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 
CoordinateExpr< N > gt (T scalar) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 
CoordinateExpr< N > ge (T scalar) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 
Additive arithmetic operators

No scalar interoperability is provided for Extent additive arithmetic operations.

Point< T, N > operator+ (Point< T, N > const &other) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 
Extent< T, N > operator+ (Extent< T, N > const &other) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 
Extent< T, N > operator- (Extent< T, N > const &other) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 
Extent< T, N > & operator+= (Extent< T, N > const &other) noexcept(Super::IS_ELEMENT_NOTHROW_ASSIGNABLE)
 
Extent< T, N > & operator-= (Extent< T, N > const &other) noexcept(Super::IS_ELEMENT_NOTHROW_ASSIGNABLE)
 
Extent< T, N > operator+ () const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 
Extent< T, N > operator- () const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 

Static Public Attributes

static int const dimensions
 
static constexpr bool IS_ELEMENT_NOTHROW_COPYABLE
 
static constexpr bool IS_ELEMENT_NOTHROW_ASSIGNABLE
 

Protected Member Functions

void _swap (CoordinateBase &other) noexcept
 

Protected Attributes

EigenVector _vector
 

Related Functions

(Note that these are not member functions.)

bool allclose (CoordinateBase< Extent< T, N >, T, N > const &a, CoordinateBase< Extent< T, N >, T, N > const &b, T rtol=static_cast< T >(1E-5), T atol=static_cast< T >(1E-8)) noexcept(std::is_nothrow_copy_constructible< T >::value &&std::is_nothrow_copy_assignable< T >::value)
 Floating-point comparison with tolerance. More...
 

Multiplicative arithmetic operators

As usual with matrices and vectors, Extent can be multiplied or divided by a scalar.

Extent< T, N > operator* (T scalar) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 Cast this object to an Extent of the same numeric type and dimensionality. More...
 
Extent< T, N > & operator*= (T scalar) noexcept(Super::IS_ELEMENT_NOTHROW_ASSIGNABLE)
 Cast this object to an Extent of the same numeric type and dimensionality. More...
 
Extent< T, N > operator/ (T scalar) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 Cast this object to an Extent of the same numeric type and dimensionality. More...
 
Extent< T, N > & operator/= (T scalar) noexcept(Super::IS_ELEMENT_NOTHROW_ASSIGNABLE)
 Cast this object to an Extent of the same numeric type and dimensionality. More...
 
Point< T, N > asPoint () const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 Cast this object to an Extent of the same numeric type and dimensionality. More...
 
std::string toString () const
 Cast this object to an Extent of the same numeric type and dimensionality. More...
 
 ExtentBase (T val=static_cast< T >(0)) noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 Construct an Extent<T,N> with all elements set to the same scalar value. More...
 
template<typename Vector >
 ExtentBase (Eigen::MatrixBase< Vector > const &vector)
 Construct an Extent from an Eigen vector. More...
 

Detailed Description

template<typename T, int N>
class lsst::geom::ExtentBase< T, N >

Definition at line 56 of file Extent.h.

Member Typedef Documentation

◆ EigenVector

typedef Eigen::Matrix<T, N, 1, Eigen::DontAlign> lsst::geom::CoordinateBase< Extent< T, N > , T, N >::EigenVector
inherited

Definition at line 59 of file CoordinateBase.h.

◆ Element

typedef T lsst::geom::CoordinateBase< Extent< T, N > , T, N >::Element
inherited

Definition at line 57 of file CoordinateBase.h.

Constructor & Destructor Documentation

◆ ExtentBase() [1/4]

template<typename T , int N>
lsst::geom::ExtentBase< T, N >::ExtentBase ( ExtentBase< T, N > const &  )
default

◆ ExtentBase() [2/4]

template<typename T , int N>
lsst::geom::ExtentBase< T, N >::ExtentBase ( ExtentBase< T, N > &&  )
default

◆ ~ExtentBase()

template<typename T , int N>
lsst::geom::ExtentBase< T, N >::~ExtentBase ( )
default

◆ ExtentBase() [3/4]

template<typename T , int N>
lsst::geom::ExtentBase< T, N >::ExtentBase ( val = static_cast<T>(0))
inlineexplicitprotectednoexcept

Construct an Extent<T,N> with all elements set to the same scalar value.

Definition at line 194 of file Extent.h.

◆ ExtentBase() [4/4]

template<typename T , int N>
template<typename Vector >
lsst::geom::ExtentBase< T, N >::ExtentBase ( Eigen::MatrixBase< Vector > const &  vector)
inlineexplicitprotected

Construct an Extent from an Eigen vector.

Definition at line 199 of file Extent.h.

Member Function Documentation

◆ _swap()

void lsst::geom::CoordinateBase< Extent< T, N > , T, N >::_swap ( CoordinateBase< Extent< T, N >, T, N > &  other)
inlineprotectednoexceptinherited

Definition at line 108 of file CoordinateBase.h.

◆ asEigen()

EigenVector const& lsst::geom::CoordinateBase< Extent< T, N > , T, N >::asEigen ( ) const
inlinenoexceptinherited

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

◆ asPoint()

template<typename T , int N>
Point< T, N > lsst::geom::ExtentBase< T, N >::asPoint
noexcept

Cast this object to an Extent of the same numeric type and dimensionality.

Definition at line 89 of file Extent.cc.

◆ coeffRef() [1/2]

T& lsst::geom::CoordinateBase< Extent< T, N > , T, N >::coeffRef ( int  n)
inlineinherited

Definition at line 80 of file CoordinateBase.h.

◆ coeffRef() [2/2]

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

Definition at line 81 of file CoordinateBase.h.

◆ computeNorm()

template<typename T , int N>
T lsst::geom::ExtentBase< T, N >::computeNorm ( ) const
inline

Return the L2 norm of the Extent (sqrt(x^2 + y^2 + ...)).

Definition at line 70 of file Extent.h.

◆ computeSquaredNorm()

template<typename T , int N>
T lsst::geom::ExtentBase< T, N >::computeSquaredNorm ( ) const
inline

Return the squared L2 norm of the Extent (x^2 + y^2 + ...).

Definition at line 67 of file Extent.h.

◆ eq() [1/2]

template<typename T , int N>
CoordinateExpr< N > lsst::geom::ExtentBase< T, N >::eq ( Extent< T, N > const &  other) const
noexcept

Definition at line 47 of file Extent.cc.

◆ eq() [2/2]

template<typename T , int N>
CoordinateExpr<N> lsst::geom::ExtentBase< T, N >::eq ( scalar) const
inlinenoexcept

Definition at line 105 of file Extent.h.

◆ ge() [1/2]

template<typename T , int N>
CoordinateExpr< N > lsst::geom::ExtentBase< T, N >::ge ( Extent< T, N > const &  other) const
noexcept

Definition at line 82 of file Extent.cc.

◆ ge() [2/2]

template<typename T , int N>
CoordinateExpr<N> lsst::geom::ExtentBase< T, N >::ge ( scalar) const
inlinenoexcept

Definition at line 120 of file Extent.h.

◆ gt() [1/2]

template<typename T , int N>
CoordinateExpr< N > lsst::geom::ExtentBase< T, N >::gt ( Extent< T, N > const &  other) const
noexcept

Definition at line 75 of file Extent.cc.

◆ gt() [2/2]

template<typename T , int N>
CoordinateExpr<N> lsst::geom::ExtentBase< T, N >::gt ( scalar) const
inlinenoexcept

Definition at line 117 of file Extent.h.

◆ le() [1/2]

template<typename T , int N>
CoordinateExpr< N > lsst::geom::ExtentBase< T, N >::le ( Extent< T, N > const &  other) const
noexcept

Definition at line 68 of file Extent.cc.

◆ le() [2/2]

template<typename T , int N>
CoordinateExpr<N> lsst::geom::ExtentBase< T, N >::le ( scalar) const
inlinenoexcept

Definition at line 114 of file Extent.h.

◆ lt() [1/2]

template<typename T , int N>
CoordinateExpr< N > lsst::geom::ExtentBase< T, N >::lt ( Extent< T, N > const &  other) const
noexcept

Definition at line 61 of file Extent.cc.

◆ lt() [2/2]

template<typename T , int N>
CoordinateExpr<N> lsst::geom::ExtentBase< T, N >::lt ( scalar) const
inlinenoexcept

Definition at line 111 of file Extent.h.

◆ ne() [1/2]

template<typename T , int N>
CoordinateExpr< N > lsst::geom::ExtentBase< T, N >::ne ( Extent< T, N > const &  other) const
noexcept

Definition at line 54 of file Extent.cc.

◆ ne() [2/2]

template<typename T , int N>
CoordinateExpr<N> lsst::geom::ExtentBase< T, N >::ne ( scalar) const
inlinenoexcept

Definition at line 108 of file Extent.h.

◆ operator!=()

template<typename T , int N>
bool lsst::geom::ExtentBase< T, N >::operator!= ( Extent< T, N > const &  other) const
inlinenoexcept

Standard inequality comparison.

Returns true iff any(this->ne(other));

Definition at line 84 of file Extent.h.

◆ operator*()

template<typename T , int N>
Extent<T, N> lsst::geom::ExtentBase< T, N >::operator* ( scalar) const
inlinenoexcept

Cast this object to an Extent of the same numeric type and dimensionality.

Definition at line 160 of file Extent.h.

◆ operator*=()

template<typename T , int N>
Extent<T, N>& lsst::geom::ExtentBase< T, N >::operator*= ( scalar)
inlinenoexcept

Cast this object to an Extent of the same numeric type and dimensionality.

Definition at line 163 of file Extent.h.

◆ operator+() [1/3]

template<typename T , int N>
Extent<T, N> lsst::geom::ExtentBase< T, N >::operator+ ( ) const
inlinenoexcept

Definition at line 146 of file Extent.h.

◆ operator+() [2/3]

template<typename T , int N>
Extent<T, N> lsst::geom::ExtentBase< T, N >::operator+ ( Extent< T, N > const &  other) const
inlinenoexcept

Definition at line 132 of file Extent.h.

◆ operator+() [3/3]

template<typename T , int N>
Point< T, N > lsst::geom::ExtentBase< T, N >::operator+ ( Point< T, N > const &  other) const
noexcept

Definition at line 94 of file Extent.cc.

◆ operator+=()

template<typename T , int N>
Extent<T, N>& lsst::geom::ExtentBase< T, N >::operator+= ( Extent< T, N > const &  other)
inlinenoexcept

Definition at line 138 of file Extent.h.

◆ operator-() [1/2]

template<typename T , int N>
Extent<T, N> lsst::geom::ExtentBase< T, N >::operator- ( ) const
inlinenoexcept

Definition at line 149 of file Extent.h.

◆ operator-() [2/2]

template<typename T , int N>
Extent<T, N> lsst::geom::ExtentBase< T, N >::operator- ( Extent< T, N > const &  other) const
inlinenoexcept

Definition at line 135 of file Extent.h.

◆ operator-=()

template<typename T , int N>
Extent<T, N>& lsst::geom::ExtentBase< T, N >::operator-= ( Extent< T, N > const &  other)
inlinenoexcept

Definition at line 142 of file Extent.h.

◆ operator/()

template<typename T , int N>
Extent<T, N> lsst::geom::ExtentBase< T, N >::operator/ ( scalar) const
inlinenoexcept

Cast this object to an Extent of the same numeric type and dimensionality.

Definition at line 167 of file Extent.h.

◆ operator/=()

template<typename T , int N>
Extent<T, N>& lsst::geom::ExtentBase< T, N >::operator/= ( scalar)
inlinenoexcept

Cast this object to an Extent of the same numeric type and dimensionality.

Definition at line 170 of file Extent.h.

◆ operator=() [1/2]

template<typename T , int N>
ExtentBase& lsst::geom::ExtentBase< T, N >::operator= ( ExtentBase< T, N > &&  )
default

◆ operator=() [2/2]

template<typename T , int N>
ExtentBase& lsst::geom::ExtentBase< T, N >::operator= ( ExtentBase< T, N > const &  )
default

◆ operator==()

template<typename T , int N>
bool lsst::geom::ExtentBase< T, N >::operator== ( Extent< T, N > const &  other) const
inlinenoexcept

Standard equality comparison.

Returns true iff all(this->eq(other));

Definition at line 77 of file Extent.h.

◆ operator[]() [1/2]

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

Definition at line 78 of file CoordinateBase.h.

◆ operator[]() [2/2]

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

Definition at line 79 of file CoordinateBase.h.

◆ toString()

template<typename T , int N>
std::string lsst::geom::ExtentBase< T, N >::toString ( ) const
inline

Cast this object to an Extent of the same numeric type and dimensionality.

Definition at line 179 of file Extent.h.

Friends And Related Function Documentation

◆ allclose()

bool allclose ( CoordinateBase< Derived, T, N > const &  a,
CoordinateBase< Derived, T, N > const &  b,
rtol = static_cast<T>(1E-5),
atol = static_cast<T>(1E-8) 
)
related

Floating-point comparison with tolerance.

Interface, naming, and default tolerances matches Numpy.

Definition at line 120 of file CoordinateBase.cc.

Member Data Documentation

◆ _vector

EigenVector lsst::geom::CoordinateBase< Extent< T, N > , T, N >::_vector
protectedinherited

Definition at line 109 of file CoordinateBase.h.

◆ dimensions

int const lsst::geom::CoordinateBase< Extent< T, N > , T, N >::dimensions
staticinherited

Definition at line 58 of file CoordinateBase.h.

◆ IS_ELEMENT_NOTHROW_ASSIGNABLE

constexpr bool lsst::geom::CoordinateBase< Extent< T, N > , T, N >::IS_ELEMENT_NOTHROW_ASSIGNABLE
staticconstexprinherited

Definition at line 61 of file CoordinateBase.h.

◆ IS_ELEMENT_NOTHROW_COPYABLE

constexpr bool lsst::geom::CoordinateBase< Extent< T, N > , T, N >::IS_ELEMENT_NOTHROW_COPYABLE
staticconstexprinherited

Definition at line 60 of file CoordinateBase.h.


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