LSSTApplications  19.0.0-14-gb0260a2+6db932c395,20.0.0+235c3eae2c,20.0.0+448775ce90,20.0.0+5f56aa8f28,20.0.0+b40eaeb6a0,20.0.0+d006f05c5d,20.0.0+dbd2281351,20.0.0+dc1acf7baf,20.0.0+e2e26847c2,20.0.0+f48bb53858,20.0.0-1-g10df615+4b67200b40,20.0.0-1-g253301a+d006f05c5d,20.0.0-1-g2b7511a+f48bb53858,20.0.0-1-g4d801e7+68c50072dc,20.0.0-1-g5b95a8c+d1beabf16b,20.0.0-1-g660595b+f45b7d88f4,20.0.0-1-gc96f8cb+4df7bab894,20.0.0-1-gd1c87d7+add1f556b4,20.0.0-1-gedffbd8+eb23c4e4f2,20.0.0-11-g13aeee2+1a7c0f1887,20.0.0-14-g199c894+e853f797a7,20.0.0-15-gf5872d0+4df7bab894,20.0.0-16-g6fe20a1+b7072f60df,20.0.0-2-g4dae9ad+4df7bab894,20.0.0-2-g5ad0983+1a7c0f1887,20.0.0-2-g7818986+add1f556b4,20.0.0-2-gb095acb+63636aeed8,20.0.0-2-gdaeb0e8+7d7ca508c5,20.0.0-2-gec03fae+de92faa26f,20.0.0-23-g8d4de91b+950b69a445,20.0.0-4-gfea843c+f45b7d88f4,20.0.0-46-g00fa051+1467b54e00,20.0.0-5-g357b56b+f45b7d88f4,20.0.0-5-gfcebe35+a6a1a2f802,20.0.0-7-gc818c6e6+57cf537add,20.0.0-7-gcda7bf1+738fa57269,20.0.0-9-g61a2a9a3d+7fa50e000d,w.2020.38
LSSTDataManagementBasePackage
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Related Functions | List of all members
lsst::geom::Extent< T, 3 > Class Template Reference

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

#include <Extent.h>

Inheritance diagram for lsst::geom::Extent< T, 3 >:
lsst::geom::ExtentBase< T, 3 > 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, 3 > const &other) noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 Explicit constructor from Point. More...
 
template<typename U >
 Extent (Extent< U, 3 > const &other) noexcept(IS_NOTHROW_CONVERTIBLE< T, U >)
 Explicit constructor from Extent of different type (if allowed) More...
 
template<typename U >
 Extent (Point< U, 3 > const &other) noexcept(IS_NOTHROW_CONVERTIBLE< T, U >)
 
 Extent (T x, T y, T z) noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 Construct from three scalars. More...
 
 Extent (T const xyz[3]) noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 Construct from a three-element array. More...
 
 Extent (std::tuple< T, T, T > const &xyz) 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)
 
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, 3 >

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

See geomOps for mathematical operators on Extent.

Definition at line 307 of file Extent.h.

Member Typedef Documentation

◆ EigenVector

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

Definition at line 311 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/10]

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

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

Definition at line 314 of file Extent.h.

314 : Super(val) {}

◆ Extent() [2/10]

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

Construct an Extent from an Eigen vector.

Definition at line 317 of file Extent.h.

317 : Super(vector) {}

◆ Extent() [3/10]

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

Explicit constructor from Point.

◆ Extent() [4/10]

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

Explicit constructor from Extent of different type (if allowed)

Definition at line 373 of file Extent.h.

373  {
375  "can only construct from Extent of different but integral type");
376  this->setX(static_cast<T>(other.getX()));
377  this->setY(static_cast<T>(other.getY()));
378  this->setZ(static_cast<T>(other.getZ()));
379 };

◆ Extent() [5/10]

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

Definition at line 384 of file Extent.h.

384  {
386  "can only construct from Extent of different but integral type");
387  this->setX(static_cast<T>(other.getX()));
388  this->setY(static_cast<T>(other.getY()));
389  this->setZ(static_cast<T>(other.getZ()));
390 };

◆ Extent() [6/10]

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

Construct from three scalars.

Definition at line 329 of file Extent.h.

330  : Super(EigenVector(x, y, z)) {}

◆ Extent() [7/10]

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

Construct from a three-element array.

Definition at line 333 of file Extent.h.

334  : Super(EigenVector(xyz[0], xyz[1], xyz[2])) {}

◆ Extent() [8/10]

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

Construct from std::tuple.

Definition at line 337 of file Extent.h.

338  : Super(EigenVector(std::get<0>(xyz), std::get<1>(xyz), std::get<2>(xyz))) {}

◆ Extent() [9/10]

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

◆ Extent() [10/10]

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

◆ ~Extent()

template<typename T >
lsst::geom::Extent< T, 3 >::~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); }

◆ computeNorm()

T lsst::geom::ExtentBase< T, N >::computeNorm
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)); }

◆ computeSquaredNorm()

T lsst::geom::ExtentBase< T, N >::computeSquaredNorm
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(); }

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

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

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

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

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

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

◆ 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)); }

◆ 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+
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-
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, 3 >::operator= ( Extent< T, 3 > &&  other)
default

◆ operator=() [2/2]

template<typename T >
Extent& lsst::geom::Extent< T, 3 >::operator= ( Extent< T, 3 > 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)); }

◆ 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, 3 >::swap ( Extent< T, 3 > &  other)
inlinenoexcept

Definition at line 348 of file Extent.h.

348 { this->_swap(other); }

◆ toString()

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

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

Definition at line 179 of file Extent.h.

179  {
180  std::stringstream out;
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  }

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.

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 }

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:
y
int y
Definition: SpanSet.cc:49
std::is_same
lsst::geom::ExtentBase< T, 3 >::eq
CoordinateExpr< N > eq(Extent< T, N > const &other) const noexcept
Definition: Extent.cc:47
lsst::sphgeom::abs
Angle abs(Angle const &a)
Definition: Angle.h:106
lsst::geom::ExtentBase< T, 3 >::ge
CoordinateExpr< N > ge(Extent< T, N > const &other) const noexcept
Definition: Extent.cc:82
std::stringstream
STL class.
lsst::geom::detail::computeExtentNorm
int computeExtentNorm(Extent< int, N > const &s)
Definition: Extent.h:46
val
ImageT val
Definition: CR.cc:146
lsst::geom::all
bool all(CoordinateExpr< N > const &expr) noexcept
Return true if all elements are true.
Definition: CoordinateExpr.h:81
z
double z
Definition: Match.cc:44
x
double x
Definition: ChebyshevBoundedField.cc:277
lsst::geom::Extent< T, 3 >::EigenVector
Super::EigenVector EigenVector
Definition: Extent.h:311
other
ItemVariant const * other
Definition: Schema.cc:56
std::atol
T atol(T... args)
lsst::geom::any
bool any(CoordinateExpr< N > const &expr) noexcept
Return true if any elements are true.
Definition: CoordinateExpr.h:89
lsst::geom::CoordinateBase< Extent< T, N >, T, N >::_swap
void _swap(CoordinateBase &other) noexcept
Definition: CoordinateBase.h:108
lsst::geom::CoordinateBase< Extent< T, N >, T, N >::_vector
EigenVector _vector
Definition: CoordinateBase.h:109
std::is_integral
lsst::geom::ExtentBase< T, 3 >::le
CoordinateExpr< N > le(Extent< T, N > const &other) const noexcept
Definition: Extent.cc:68
b
table::Key< int > b
Definition: TransmissionCurve.cc:467
lsst::geom::CoordinateBase< Extent< T, N >, T, N >::EigenVector
Eigen::Matrix< T, N, 1, Eigen::DontAlign > EigenVector
Definition: CoordinateBase.h:59
lsst::geom::CoordinateBase< Extent< T, N >, T, N >::coeffRef
T & coeffRef(int n)
Definition: CoordinateBase.h:80
a
table::Key< int > a
Definition: TransmissionCurve.cc:466
lsst::geom::ExtentBase< T, 3 >::ne
CoordinateExpr< N > ne(Extent< T, N > const &other) const noexcept
Definition: Extent.cc:54
std::stringstream::str
T str(T... args)
lsst::geom::ExtentBase< T, 3 >::gt
CoordinateExpr< N > gt(Extent< T, N > const &other) const noexcept
Definition: Extent.cc:75
lsst::geom::CoordinateBase< Extent< T, N >, T, N >::asEigen
EigenVector const & asEigen() const noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
Return a fixed-size Eigen representation of the coordinate object.
Definition: CoordinateBase.h:89
lsst::geom::ExtentBase< T, 3 >::lt
CoordinateExpr< N > lt(Extent< T, N > const &other) const noexcept
Definition: Extent.cc:61