LSST Applications g0b6bd0c080+a72a5dd7e6,g1182afd7b4+2a019aa3bb,g17e5ecfddb+2b8207f7de,g1d67935e3f+06cf436103,g38293774b4+ac198e9f13,g396055baef+6a2097e274,g3b44f30a73+6611e0205b,g480783c3b1+98f8679e14,g48ccf36440+89c08d0516,g4b93dc025c+98f8679e14,g5c4744a4d9+a302e8c7f0,g613e996a0d+e1c447f2e0,g6c8d09e9e7+25247a063c,g7271f0639c+98f8679e14,g7a9cd813b8+124095ede6,g9d27549199+a302e8c7f0,ga1cf026fa3+ac198e9f13,ga32aa97882+7403ac30ac,ga786bb30fb+7a139211af,gaa63f70f4e+9994eb9896,gabf319e997+ade567573c,gba47b54d5d+94dc90c3ea,gbec6a3398f+06cf436103,gc6308e37c7+07dd123edb,gc655b1545f+ade567573c,gcc9029db3c+ab229f5caf,gd01420fc67+06cf436103,gd877ba84e5+06cf436103,gdb4cecd868+6f279b5b48,ge2d134c3d5+cc4dbb2e3f,ge448b5faa6+86d1ceac1d,gecc7e12556+98f8679e14,gf3ee170dca+25247a063c,gf4ac96e456+ade567573c,gf9f5ea5b4d+ac198e9f13,gff490e6085+8c2580be5c,w.2022.27
LSST Data Management Base Package
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Related Functions | List of all members
lsst::geom::Extent< T, 2 > Class Template Reference

A coordinate class intended to represent offsets and dimensions (2-d specialization). More...

#include <Extent.h>

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

Public Types

typedef Super::EigenVector EigenVector
 
typedef T Element
 

Public Member Functions

 Extent (T val=static_cast< T >(0)) noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 Construct an Extent with all elements set to the same scalar value. More...
 
 Extent (EigenVector const &vector) noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 Construct an Extent from an Eigen vector. More...
 
 Extent (Point< T, 2 > const &other) noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 Explicit constructor from Point. More...
 
template<typename U >
 Extent (Extent< U, 2 > const &other) noexcept(IS_NOTHROW_CONVERTIBLE< T, U >)
 Explicit constructor from Extent of different type (if allowed) More...
 
template<typename U >
 Extent (Point< U, 2 > const &other) noexcept(IS_NOTHROW_CONVERTIBLE< T, U >)
 
 Extent (T x, T y) noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 Construct from two scalars. More...
 
 Extent (T const xy[2]) noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 Construct from a two-element array. More...
 
 Extent (std::pair< T, T > const &xy) noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 Construct from a std::pair. More...
 
 Extent (std::tuple< T, T > const &xy) noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 Construct from std::tuple. More...
 
 Extent (Extent const &other)=default
 
 Extent (Extent &&other)=default
 
 ~Extent ()=default
 
Extentoperator= (Extent const &other)=default
 
Extentoperator= (Extent &&other)=default
 
void swap (Extent &other) noexcept
 
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 > eq (T scalar) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 
CoordinateExpr< N > ne (Extent< T, N > const &other) const noexcept
 
CoordinateExpr< N > ne (T scalar) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 
CoordinateExpr< N > lt (Extent< T, N > const &other) const noexcept
 
CoordinateExpr< N > lt (T scalar) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 
CoordinateExpr< N > le (Extent< T, N > const &other) const noexcept
 
CoordinateExpr< N > le (T scalar) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 
CoordinateExpr< N > gt (Extent< T, N > const &other) const noexcept
 
CoordinateExpr< N > gt (T scalar) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 
CoordinateExpr< N > ge (Extent< T, N > const &other) const noexcept
 
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+ () 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- () 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)
 
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...
 

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

Detailed Description

template<typename T>
class lsst::geom::Extent< T, 2 >

A coordinate class intended to represent offsets and dimensions (2-d specialization).

See geomOps for mathematical operators on Extent.

Definition at line 254 of file Extent.h.

Member Typedef Documentation

◆ EigenVector

template<typename T >
typedef Super::EigenVector lsst::geom::Extent< T, 2 >::EigenVector

Definition at line 258 of file Extent.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

◆ Extent() [1/11]

template<typename T >
lsst::geom::Extent< T, 2 >::Extent ( val = static_cast<T>(0))
inlineexplicitnoexcept

Construct an Extent with all elements set to the same scalar value.

Definition at line 261 of file Extent.h.

261: Super(val) {}
ImageT val
Definition: CR.cc:146

◆ Extent() [2/11]

template<typename T >
lsst::geom::Extent< T, 2 >::Extent ( EigenVector const &  vector)
inlineexplicitnoexcept

Construct an Extent from an Eigen vector.

Definition at line 264 of file Extent.h.

264: Super(vector) {}

◆ Extent() [3/11]

template<typename T >
lsst::geom::Extent< T, 2 >::Extent ( Point< T, 2 > const &  other)
explicitnoexcept

Explicit constructor from Point.

◆ Extent() [4/11]

template<typename T >
template<typename U >
lsst::geom::Extent< T, 2 >::Extent ( Extent< U, 2 > const &  other)
explicitnoexcept

Explicit constructor from Extent of different type (if allowed)

Definition at line 354 of file Extent.h.

354 {
356 "can only construct from Extent of different but integral type");
357 this->setX(static_cast<T>(other.getX()));
358 this->setY(static_cast<T>(other.getY()));
359};

◆ Extent() [5/11]

template<typename T >
template<typename U >
lsst::geom::Extent< T, 2 >::Extent ( Point< U, 2 > const &  other)
explicitnoexcept

Definition at line 363 of file Extent.h.

363 {
365 "can only construct from Extent of different but integral type");
366 this->setX(static_cast<T>(other.getX()));
367 this->setY(static_cast<T>(other.getY()));
368};

◆ Extent() [6/11]

template<typename T >
lsst::geom::Extent< T, 2 >::Extent ( x,
y 
)
inlineexplicitnoexcept

Construct from two scalars.

Definition at line 276 of file Extent.h.

276: Super(EigenVector(x, y)) {}
double x
int y
Definition: SpanSet.cc:48
Super::EigenVector EigenVector
Definition: Extent.h:258

◆ Extent() [7/11]

template<typename T >
lsst::geom::Extent< T, 2 >::Extent ( T const  xy[2])
inlineexplicitnoexcept

Construct from a two-element array.

Definition at line 279 of file Extent.h.

280 : Super(EigenVector(xy[0], xy[1])) {}

◆ Extent() [8/11]

template<typename T >
lsst::geom::Extent< T, 2 >::Extent ( std::pair< T, T > const &  xy)
inlineexplicitnoexcept

Construct from a std::pair.

Definition at line 283 of file Extent.h.

284 : Super(EigenVector(xy.first, xy.second)) {}

◆ Extent() [9/11]

template<typename T >
lsst::geom::Extent< T, 2 >::Extent ( std::tuple< T, T > const &  xy)
inlineexplicitnoexcept

Construct from std::tuple.

Definition at line 287 of file Extent.h.

288 : Super(EigenVector(std::get<0>(xy), std::get<1>(xy))) {}

◆ Extent() [10/11]

template<typename T >
lsst::geom::Extent< T, 2 >::Extent ( Extent< T, 2 > const &  other)
default

◆ Extent() [11/11]

template<typename T >
lsst::geom::Extent< T, 2 >::Extent ( Extent< T, 2 > &&  other)
default

◆ ~Extent()

template<typename T >
lsst::geom::Extent< T, 2 >::~Extent ( )
default

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.

108{ _vector.swap(other._vector); }

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

89{ return _vector; }

◆ asPoint()

Point< T, N > lsst::geom::ExtentBase< T, N >::asPoint
noexceptinherited

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

Definition at line 177 of file Extent.cc.

89 {
90 return Point<T, N>(static_cast<Extent<T, N> const &>(*this));
91}

◆ coeffRef() [1/2]

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

Definition at line 80 of file CoordinateBase.h.

80{ return _vector.coeffRef(n); }

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

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

◆ computeNorm()

T lsst::geom::ExtentBase< T, N >::computeNorm ( ) const
inlineinherited

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

Definition at line 70 of file Extent.h.

70{ return detail::computeExtentNorm(static_cast<Extent<T, N> const &>(*this)); }
int computeExtentNorm(Extent< int, N > const &s)
Definition: Extent.h:46

◆ computeSquaredNorm()

T lsst::geom::ExtentBase< T, N >::computeSquaredNorm ( ) const
inlineinherited

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

Definition at line 67 of file Extent.h.

67{ return this->asEigen().squaredNorm(); }
EigenVector const & asEigen() const noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
Return a fixed-size Eigen representation of the coordinate object.

◆ eq() [1/2]

CoordinateExpr< N > lsst::geom::ExtentBase< T, N >::eq ( Extent< T, N > const &  other) const
noexceptinherited

Definition at line 99 of file Extent.cc.

47 {
48 CoordinateExpr<N> r;
49 for (int n = 0; n < N; ++n) r[n] = this->_vector[n] == other[n];
50 return r;
51}

◆ eq() [2/2]

CoordinateExpr< N > lsst::geom::ExtentBase< T, N >::eq ( scalar) const
inlinenoexceptinherited

Definition at line 105 of file Extent.h.

105 {
106 return this->eq(Extent<T, N>(scalar));
107 }
CoordinateExpr< N > eq(Extent< T, N > const &other) const noexcept
Definition: Extent.cc:47

◆ ge() [1/2]

CoordinateExpr< N > lsst::geom::ExtentBase< T, N >::ge ( Extent< T, N > const &  other) const
noexceptinherited

Definition at line 104 of file Extent.cc.

82 {
83 CoordinateExpr<N> r;
84 for (int n = 0; n < N; ++n) r[n] = this->_vector[n] >= other[n];
85 return r;
86}

◆ ge() [2/2]

CoordinateExpr< N > lsst::geom::ExtentBase< T, N >::ge ( scalar) const
inlinenoexceptinherited

Definition at line 120 of file Extent.h.

120 {
121 return this->ge(Extent<T, N>(scalar));
122 }
CoordinateExpr< N > ge(Extent< T, N > const &other) const noexcept
Definition: Extent.cc:82

◆ gt() [1/2]

CoordinateExpr< N > lsst::geom::ExtentBase< T, N >::gt ( Extent< T, N > const &  other) const
noexceptinherited

Definition at line 103 of file Extent.cc.

75 {
76 CoordinateExpr<N> r;
77 for (int n = 0; n < N; ++n) r[n] = this->_vector[n] > other[n];
78 return r;
79}

◆ gt() [2/2]

CoordinateExpr< N > lsst::geom::ExtentBase< T, N >::gt ( scalar) const
inlinenoexceptinherited

Definition at line 117 of file Extent.h.

117 {
118 return this->gt(Extent<T, N>(scalar));
119 }
CoordinateExpr< N > gt(Extent< T, N > const &other) const noexcept
Definition: Extent.cc:75

◆ le() [1/2]

CoordinateExpr< N > lsst::geom::ExtentBase< T, N >::le ( Extent< T, N > const &  other) const
noexceptinherited

Definition at line 102 of file Extent.cc.

68 {
69 CoordinateExpr<N> r;
70 for (int n = 0; n < N; ++n) r[n] = this->_vector[n] <= other[n];
71 return r;
72}

◆ le() [2/2]

CoordinateExpr< N > lsst::geom::ExtentBase< T, N >::le ( scalar) const
inlinenoexceptinherited

Definition at line 114 of file Extent.h.

114 {
115 return this->le(Extent<T, N>(scalar));
116 }
CoordinateExpr< N > le(Extent< T, N > const &other) const noexcept
Definition: Extent.cc:68

◆ lt() [1/2]

CoordinateExpr< N > lsst::geom::ExtentBase< T, N >::lt ( Extent< T, N > const &  other) const
noexceptinherited

Definition at line 101 of file Extent.cc.

61 {
62 CoordinateExpr<N> r;
63 for (int n = 0; n < N; ++n) r[n] = this->_vector[n] < other[n];
64 return r;
65}

◆ lt() [2/2]

CoordinateExpr< N > lsst::geom::ExtentBase< T, N >::lt ( scalar) const
inlinenoexceptinherited

Definition at line 111 of file Extent.h.

111 {
112 return this->lt(Extent<T, N>(scalar));
113 }
CoordinateExpr< N > lt(Extent< T, N > const &other) const noexcept
Definition: Extent.cc:61

◆ ne() [1/2]

CoordinateExpr< N > lsst::geom::ExtentBase< T, N >::ne ( Extent< T, N > const &  other) const
noexceptinherited

Definition at line 100 of file Extent.cc.

54 {
55 CoordinateExpr<N> r;
56 for (int n = 0; n < N; ++n) r[n] = this->_vector[n] != other[n];
57 return r;
58}

◆ ne() [2/2]

CoordinateExpr< N > lsst::geom::ExtentBase< T, N >::ne ( scalar) const
inlinenoexceptinherited

Definition at line 108 of file Extent.h.

108 {
109 return this->ne(Extent<T, N>(scalar));
110 }
CoordinateExpr< N > ne(Extent< T, N > const &other) const noexcept
Definition: Extent.cc:54

◆ operator!=()

bool lsst::geom::ExtentBase< T, N >::operator!= ( Extent< T, N > const &  other) const
inlinenoexceptinherited

Standard inequality comparison.

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

Definition at line 84 of file Extent.h.

84{ return any(this->ne(other)); }
bool any(CoordinateExpr< N > const &expr) noexcept
Return true if any elements are true.

◆ operator*()

Extent< T, N > lsst::geom::ExtentBase< T, N >::operator* ( scalar) const
inlinenoexceptinherited

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

Definition at line 160 of file Extent.h.

160 {
161 return Extent<T, N>(this->_vector * scalar);
162 }

◆ operator*=()

Extent< T, N > & lsst::geom::ExtentBase< T, N >::operator*= ( scalar)
inlinenoexceptinherited

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

Definition at line 163 of file Extent.h.

163 {
164 this->_vector *= scalar;
165 return static_cast<Extent<T, N> &>(*this);
166 }

◆ operator+() [1/3]

Extent< T, N > lsst::geom::ExtentBase< T, N >::operator+ ( ) const
inlinenoexceptinherited

Definition at line 146 of file Extent.h.

146 {
147 return static_cast<Extent<T, N> const &>(*this);
148 }

◆ operator+() [2/3]

Extent< T, N > lsst::geom::ExtentBase< T, N >::operator+ ( Extent< T, N > const &  other) const
inlinenoexceptinherited

Definition at line 132 of file Extent.h.

132 {
133 return Extent<T, N>(this->_vector + other._vector);
134 }

◆ operator+() [3/3]

Point< T, N > lsst::geom::ExtentBase< T, N >::operator+ ( Point< T, N > const &  other) const
noexceptinherited

Definition at line 131 of file Extent.cc.

95 {
96 return Point<T, N>(this->_vector + other.asEigen());
97}

◆ operator+=()

Extent< T, N > & lsst::geom::ExtentBase< T, N >::operator+= ( Extent< T, N > const &  other)
inlinenoexceptinherited

Definition at line 138 of file Extent.h.

138 {
139 this->_vector += other._vector;
140 return static_cast<Extent<T, N> &>(*this);
141 }

◆ operator-() [1/2]

Extent< T, N > lsst::geom::ExtentBase< T, N >::operator- ( ) const
inlinenoexceptinherited

Definition at line 149 of file Extent.h.

149 {
150 return Extent<T, N>(-this->_vector);
151 }

◆ operator-() [2/2]

Extent< T, N > lsst::geom::ExtentBase< T, N >::operator- ( Extent< T, N > const &  other) const
inlinenoexceptinherited

Definition at line 135 of file Extent.h.

135 {
136 return Extent<T, N>(this->_vector - other._vector);
137 }

◆ operator-=()

Extent< T, N > & lsst::geom::ExtentBase< T, N >::operator-= ( Extent< T, N > const &  other)
inlinenoexceptinherited

Definition at line 142 of file Extent.h.

142 {
143 this->_vector -= other._vector;
144 return static_cast<Extent<T, N> &>(*this);
145 }

◆ operator/()

Extent< T, N > lsst::geom::ExtentBase< T, N >::operator/ ( scalar) const
inlinenoexceptinherited

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

Definition at line 167 of file Extent.h.

167 {
168 return Extent<T, N>(this->_vector / scalar);
169 }

◆ operator/=()

Extent< T, N > & lsst::geom::ExtentBase< T, N >::operator/= ( scalar)
inlinenoexceptinherited

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

Definition at line 170 of file Extent.h.

170 {
171 this->_vector /= scalar;
172 return static_cast<Extent<T, N> &>(*this);
173 }

◆ operator=() [1/2]

template<typename T >
Extent & lsst::geom::Extent< T, 2 >::operator= ( Extent< T, 2 > &&  other)
default

◆ operator=() [2/2]

template<typename T >
Extent & lsst::geom::Extent< T, 2 >::operator= ( Extent< T, 2 > const &  other)
default

◆ operator==()

bool lsst::geom::ExtentBase< T, N >::operator== ( Extent< T, N > const &  other) const
inlinenoexceptinherited

Standard equality comparison.

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

Definition at line 77 of file Extent.h.

77{ return all(this->eq(other)); }
bool all(CoordinateExpr< N > const &expr) noexcept
Return true if all elements are true.

◆ operator[]() [1/2]

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

Definition at line 78 of file CoordinateBase.h.

78{ return _vector[n]; }

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

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

◆ swap()

template<typename T >
void lsst::geom::Extent< T, 2 >::swap ( Extent< T, 2 > &  other)
inlinenoexcept

Definition at line 298 of file Extent.h.

298{ this->_swap(other); }
void _swap(CoordinateBase &other) noexcept

◆ toString()

std::string lsst::geom::ExtentBase< T, N >::toString ( ) const
inlineinherited

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

Definition at line 179 of file Extent.h.

179 {
181 out << "Extent(";
182 for (size_t i = 0; i < N; ++i) {
183 if (i != 0) {
184 out << ",";
185 }
186 out << (*this)[i];
187 }
188 out << ")";
189 return out.str();
190 }
T str(T... args)

Friends And Related Function Documentation

◆ allclose()

bool allclose ( CoordinateBase< Extent< T, N > , T, N > const &  a,
CoordinateBase< Extent< T, N > , 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.

32 {
33 Eigen::Array<T, N, 1> diff = (a.asEigen().array() - b.asEigen().array()).abs();
34 Eigen::Array<T, N, 1> rhs = (0.5 * (a.asEigen().array() + b.asEigen().array())).abs();
35 rhs *= rtol;
36 rhs += atol;
37 return (diff <= rhs).all();
38}
table::Key< int > b
table::Key< int > a
T atol(T... args)
Angle abs(Angle const &a)
Definition: Angle.h:106

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 file: