|
LSST Applications 26.0.0,g0265f82a02+6660c170cc,g07994bdeae+30b05a742e,g0a0026dc87+17526d298f,g0a60f58ba1+17526d298f,g0e4bf8285c+96dd2c2ea9,g0ecae5effc+c266a536c8,g1e7d6db67d+6f7cb1f4bb,g26482f50c6+6346c0633c,g2bbee38e9b+6660c170cc,g2cc88a2952+0a4e78cd49,g3273194fdb+f6908454ef,g337abbeb29+6660c170cc,g337c41fc51+9a8f8f0815,g37c6e7c3d5+7bbafe9d37,g44018dc512+6660c170cc,g4a941329ef+4f7594a38e,g4c90b7bd52+5145c320d2,g58be5f913a+bea990ba40,g635b316a6c+8d6b3a3e56,g67924a670a+bfead8c487,g6ae5381d9b+81bc2a20b4,g93c4d6e787+26b17396bd,g98cecbdb62+ed2cb6d659,g98ffbb4407+81bc2a20b4,g9ddcbc5298+7f7571301f,ga1e77700b3+99e9273977,gae46bcf261+6660c170cc,gb2715bf1a1+17526d298f,gc86a011abf+17526d298f,gcf0d15dbbd+96dd2c2ea9,gdaeeff99f8+0d8dbea60f,gdb4ec4c597+6660c170cc,ge23793e450+96dd2c2ea9,gf041782ebf+171108ac67
LSST Data Management Base Package
|
A coordinate class intended to represent offsets and dimensions. More...
#include <Extent.h>
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. | |
| Extent (EigenVector const &vector) noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE) | |
| Construct an Extent from an Eigen vector. | |
| Extent (Point< T, N > const &other) noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE) | |
| Explicit constructor from Point. | |
| template<typename U > | |
| Extent (Extent< U, N > const &other) noexcept(IS_NOTHROW_CONVERTIBLE< T, U >) | |
| Explicit constructor from Extent of different type (if allowed) | |
| template<typename U > | |
| Extent (Point< U, N > const &other) noexcept(IS_NOTHROW_CONVERTIBLE< T, U >) | |
| Extent (Extent const &other)=default | |
| Extent (Extent &&other)=default | |
| ~Extent ()=default | |
| Extent & | operator= (Extent const &other)=default |
| Extent & | operator= (Extent &&other)=default |
| T | computeSquaredNorm () const |
| Return the squared L2 norm of the Extent (x^2 + y^2 + ...). | |
| T | computeNorm () const |
| Return the L2 norm of the Extent (sqrt(x^2 + y^2 + ...)). | |
| void | swap (Extent &other) noexcept |
| 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 > | 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. | |
| 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. | |
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. | |
A coordinate class intended to represent offsets and dimensions.
Much of the functionality of Extent is provided by its CRTP base class, ExtentBase.
See geomOps for mathematical operators on Extent.
| typedef Super::EigenVector lsst::geom::Extent< T, N >::EigenVector |
|
inherited |
Definition at line 57 of file CoordinateBase.h.
|
inlineexplicitnoexcept |
|
inlineexplicitnoexcept |
|
explicitnoexcept |
|
explicitnoexcept |
Explicit constructor from Extent of different type (if allowed)
|
explicitnoexcept |
|
default |
|
default |
|
default |
|
inlineprotectednoexceptinherited |
Definition at line 108 of file CoordinateBase.h.
|
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.
|
noexceptinherited |
|
inlineinherited |
Definition at line 80 of file CoordinateBase.h.
|
inlineinherited |
Definition at line 81 of file CoordinateBase.h.
|
inline |
Return the L2 norm of the Extent (sqrt(x^2 + y^2 + ...)).
Definition at line 243 of file Extent.h.
|
inline |
|
noexceptinherited |
|
inlinenoexceptinherited |
Definition at line 105 of file Extent.h.
|
noexceptinherited |
|
inlinenoexceptinherited |
Definition at line 120 of file Extent.h.
|
noexceptinherited |
|
inlinenoexceptinherited |
Definition at line 117 of file Extent.h.
|
noexceptinherited |
|
inlinenoexceptinherited |
Definition at line 114 of file Extent.h.
|
noexceptinherited |
|
inlinenoexceptinherited |
Definition at line 111 of file Extent.h.
|
noexceptinherited |
|
inlinenoexceptinherited |
Definition at line 108 of file Extent.h.
|
inlinenoexceptinherited |
Standard inequality comparison.
Returns true iff any(this->ne(other));
Definition at line 84 of file Extent.h.
|
inlinenoexceptinherited |
|
inlinenoexceptinherited |
|
inlinenoexceptinherited |
|
inlinenoexceptinherited |
|
noexceptinherited |
|
inlinenoexceptinherited |
|
inlinenoexceptinherited |
|
inlinenoexceptinherited |
|
inlinenoexceptinherited |
|
inlinenoexceptinherited |
|
inlinenoexceptinherited |
|
default |
|
default |
|
inlinenoexceptinherited |
Standard equality comparison.
Returns true iff all(this->eq(other));
Definition at line 77 of file Extent.h.
|
inlineinherited |
Definition at line 78 of file CoordinateBase.h.
|
inlineinherited |
Definition at line 79 of file CoordinateBase.h.
|
inlinenoexcept |
Definition at line 245 of file Extent.h.
|
inlineinherited |
Cast this object to an Extent of the same numeric type and dimensionality.
Definition at line 179 of file Extent.h.
|
related |
Floating-point comparison with tolerance.
Interface, naming, and default tolerances matches Numpy.
Definition at line 120 of file CoordinateBase.cc.
|
protectedinherited |
Definition at line 109 of file CoordinateBase.h.
|
staticinherited |
Definition at line 58 of file CoordinateBase.h.
|
staticconstexprinherited |
Definition at line 61 of file CoordinateBase.h.
|
staticconstexprinherited |
Definition at line 60 of file CoordinateBase.h.