LSST Applications g04c3c9f7ca+2075667efa,g1e125bf412+5f448d5fcf,g2079a07aa2+3e9fd84d81,g2305ad1205+b635cf1488,g2bbee38e9b+6c6beb4891,g337abbeb29+6c6beb4891,g33d1c0ed96+6c6beb4891,g3a166c0a6a+6c6beb4891,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+42f171e1e6,g5c3423f6d4+d536b04327,g607f77f49a+d536b04327,g6f43f06aed+ca1339dc19,g858d7b2824+d536b04327,g8ee334c5b4+d7f9608c2f,g9963eaa53e+b3dc1655d3,g998f4353bf+d536b04327,g99cad8db69+8ef2408349,g9ddcbc5298+9a081db1e4,ga1e77700b3+2cbb763275,gadfd92a7e4+aec2f3b930,gae0086650b+585e252eca,gb0e22166c9+0e73c8378f,gb3b7280ab2+cb5fdb229e,gbb8dafda3b+a327199e22,gc120e1dc64+88074880ea,gc28159a63d+6c6beb4891,gcdd4ae20e8+bd241b2308,gcde1bda545+903e937d91,gcf0d15dbbd+bd241b2308,gdaeeff99f8+f9a426f77a,gddc38dedce+585e252eca,ge79ae78c31+6c6beb4891,gfbcc870c63+b310236976,w.2024.23
LSST Data Management Base Package
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Related Symbols | 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< int, 2 > lsst::geom::Extent< double, 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 + ...).
 
computeNorm () const
 Return the L2 norm of the Extent (sqrt(x^2 + y^2 + ...)).
 
bool operator== (Extent< T, N > const &other) const noexcept
 Standard equality comparison.
 
bool operator!= (Extent< T, N > const &other) const noexcept
 Standard inequality comparison.
 
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.
 
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 bool constexpr IS_ELEMENT_NOTHROW_COPYABLE
 
static bool constexpr IS_ELEMENT_NOTHROW_ASSIGNABLE
 

Protected Member Functions

void _swap (CoordinateBase &other) noexcept
 

Protected Attributes

EigenVector _vector
 

Related Symbols

(Note that these are not member symbols.)

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.
 

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.
 
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.
 
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.
 
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.
 
Point< T, N > asPoint () const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 Cast this object to an Extent of the same numeric type and dimensionality.
 
std::string toString () const
 Cast this object to an Extent of the same numeric type and dimensionality.
 
 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.
 
template<typename Vector >
 ExtentBase (Eigen::MatrixBase< Vector > const &vector)
 Construct an Extent from an Eigen vector.
 

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

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

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

199: Super(vector) {}

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 ( ) const
noexcept

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

Definition at line 89 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.

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

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

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

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]

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.

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]

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

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]

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.

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]

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

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]

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.

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]

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

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]

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.

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]

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

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]

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.

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]

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

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]

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.

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]

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

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!=()

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.

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

◆ operator*()

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

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*=()

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

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]

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

Definition at line 146 of file Extent.h.

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

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

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

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

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

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

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

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

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

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

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

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

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

◆ operator/()

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

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/=()

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

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

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.

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

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 Symbol Documentation

◆ allclose()

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

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

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