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

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, 3 > const &other) noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
	Explicit constructor from Point.
template<typename U >
	Extent (Extent< U, 3 > const &other) noexcept(IS_NOTHROW_CONVERTIBLE< T, U >)
	Explicit constructor from Extent of different type (if allowed)
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.
	Extent (T const xyz[3]) noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
	Construct from a three-element array.
	Extent (std::tuple< T, T, T > const &xyz) noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
	Construct from std::tuple.
	Extent (Extent const &other)=default
	Extent (Extent &&other)=default
	~Extent ()=default
Extent &	operator= (Extent const &other)=default
Extent &	operator= (Extent &&other)=default
void	swap (Extent &other) noexcept
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 + ...)).
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.

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

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

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

                                                                                     {
    static_assert((!std::is_same<T, U>::value && std::is_integral<U>::value),
                  "can only construct from Extent of different but integral type");
    this->setX(static_cast<T>(other.getX()));
    this->setY(static_cast<T>(other.getY()));
    this->setZ(static_cast<T>(other.getZ()));
};

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.

                                                                                    {
    static_assert((!std::is_same<T, U>::value && std::is_integral<U>::value),
                  "can only construct from Extent of different but integral type");
    this->setX(static_cast<T>(other.getX()));
    this->setY(static_cast<T>(other.getY()));
    this->setZ(static_cast<T>(other.getZ()));
};

Extent() [6/10]

template<typename T >

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

inlineexplicitnoexcept

Construct from three scalars.

Definition at line 329 of file Extent.h.

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

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

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

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

Point< T, N > lsst::geom::ExtentBase< T, N >::asPoint ( ) const

noexceptinherited

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

Definition at line 177 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()

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.

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.

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.

eq() [2/2]

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

inlinenoexceptinherited

Definition at line 105 of file Extent.h.

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.

ge() [2/2]

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

inlinenoexceptinherited

Definition at line 120 of file Extent.h.

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.

gt() [2/2]

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

inlinenoexceptinherited

Definition at line 117 of file Extent.h.

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.

le() [2/2]

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

inlinenoexceptinherited

Definition at line 114 of file Extent.h.

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.

lt() [2/2]

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

inlinenoexceptinherited

Definition at line 111 of file Extent.h.

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.

ne() [2/2]

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

inlinenoexceptinherited

Definition at line 108 of file Extent.h.

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.

operator*()

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

inlinenoexceptinherited

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

Definition at line 160 of file Extent.h.

operator*=()

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

inlinenoexceptinherited

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

Definition at line 163 of file Extent.h.

operator+() [1/3]

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

inlinenoexceptinherited

Definition at line 146 of file Extent.h.

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.

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.

operator+=()

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

inlinenoexceptinherited

Definition at line 138 of file Extent.h.

operator-() [1/2]

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

inlinenoexceptinherited

Definition at line 149 of file Extent.h.

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.

operator-=()

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

inlinenoexceptinherited

Definition at line 142 of file Extent.h.

operator/()

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

inlinenoexceptinherited

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

Definition at line 167 of file Extent.h.

operator/=()

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

inlinenoexceptinherited

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 >

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.

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.

swap()

template<typename T >

void lsst::geom::Extent< T, 3 >::swap ( Extent< T, 3 > & other )

inlinenoexcept

Definition at line 348 of file Extent.h.

{ this->_swap(other); }

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.

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/geom/ga1e77700b3+15fc3df1f7/include/lsst/geom/Extent.h