lsst::geom::Extent< T, N > Class Template Reference

A coordinate class intended to represent offsets and dimensions. More...

#include <Extent.h>

Inheritance diagram for lsst::geom::Extent< 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.
	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.

Detailed Description

template<typename T, int N>
class lsst::geom::Extent< T, N >

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.

Definition at line 210 of file Extent.h.

Member Typedef Documentation

EigenVector

template<typename T , int N>

typedef Super::EigenVector lsst::geom::Extent< T, N >::EigenVector

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

template<typename T , int N>

lsst::geom::Extent< T, N >::Extent ( T val = static_cast<T>(0) )

inlineexplicitnoexcept

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

Definition at line 217 of file Extent.h.

: Super(val) {}

Extent() [2/7]

template<typename T , int N>

lsst::geom::Extent< T, N >::Extent ( EigenVector const & vector )

inlineexplicitnoexcept

Construct an Extent from an Eigen vector.

Definition at line 220 of file Extent.h.

: Super(vector) {}

Extent() [3/7]

template<typename T , int N>

lsst::geom::Extent< T, N >::Extent ( Point< T, N > const & other )

explicitnoexcept

Explicit constructor from Point.

Definition at line 31 of file Extent.cc.

        : Super(other.asEigen()) {}

Extent() [4/7]

template<typename T , int N>

template<typename U >

lsst::geom::Extent< T, N >::Extent ( Extent< U, N > const & other )

explicitnoexcept

Explicit constructor from Extent of different type (if allowed)

Extent() [5/7]

template<typename T , int N>

template<typename U >

lsst::geom::Extent< T, N >::Extent ( Point< U, N > const & other )

explicitnoexcept

Extent() [6/7]

template<typename T , int N>

lsst::geom::Extent< T, N >::Extent ( Extent< T, N > const & other )

default

Extent() [7/7]

template<typename T , int N>

lsst::geom::Extent< T, N >::Extent ( Extent< T, N > && other )

default

~Extent()

template<typename T , int N>

lsst::geom::Extent< T, N >::~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.

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

{ return _vector; }

asPoint()

template<typename T , int N>

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 89 of file Extent.cc.

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

coeffRef() [1/2]

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

inlineinherited

Definition at line 80 of file CoordinateBase.h.

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

{ return const_cast<EigenVector&>(_vector).coeffRef(n); }

computeNorm()

template<typename T , int N>

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

inline

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

Definition at line 243 of file Extent.h.

{ return this->asEigen().norm(); }

computeSquaredNorm()

template<typename T , int N>

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

inline

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

Definition at line 240 of file Extent.h.

{ return this->asEigen().squaredNorm(); }

eq() [1/2]

template<typename T , int N>

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

noexceptinherited

Definition at line 47 of file Extent.cc.

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

eq() [2/2]

template<typename T , int N>

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

inlinenoexceptinherited

Definition at line 105 of file Extent.h.

                                                                                    {
        return this->eq(Extent<T, N>(scalar));
    }

ge() [1/2]

template<typename T , int N>

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

noexceptinherited

Definition at line 82 of file Extent.cc.

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

ge() [2/2]

template<typename T , int N>

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

inlinenoexceptinherited

Definition at line 120 of file Extent.h.

                                                                                    {
        return this->ge(Extent<T, N>(scalar));
    }

gt() [1/2]

template<typename T , int N>

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

noexceptinherited

Definition at line 75 of file Extent.cc.

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

gt() [2/2]

template<typename T , int N>

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

inlinenoexceptinherited

Definition at line 117 of file Extent.h.

                                                                                    {
        return this->gt(Extent<T, N>(scalar));
    }

le() [1/2]

template<typename T , int N>

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

noexceptinherited

Definition at line 68 of file Extent.cc.

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

le() [2/2]

template<typename T , int N>

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

inlinenoexceptinherited

Definition at line 114 of file Extent.h.

                                                                                    {
        return this->le(Extent<T, N>(scalar));
    }

lt() [1/2]

template<typename T , int N>

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

noexceptinherited

Definition at line 61 of file Extent.cc.

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

lt() [2/2]

template<typename T , int N>

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

inlinenoexceptinherited

Definition at line 111 of file Extent.h.

                                                                                    {
        return this->lt(Extent<T, N>(scalar));
    }

ne() [1/2]

template<typename T , int N>

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

noexceptinherited

Definition at line 54 of file Extent.cc.

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

ne() [2/2]

template<typename T , int N>

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

inlinenoexceptinherited

Definition at line 108 of file Extent.h.

                                                                                    {
        return this->ne(Extent<T, N>(scalar));
    }

operator!=()

template<typename T , int N>

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.

{ return any(this->ne(other)); }

operator*()

template<typename T , int N>

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.

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

operator*=()

template<typename T , int N>

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.

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

operator+() [1/3]

template<typename T , int N>

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

inlinenoexceptinherited

Definition at line 146 of file Extent.h.

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

operator+() [2/3]

template<typename T , int N>

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

inlinenoexceptinherited

Definition at line 132 of file Extent.h.

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

operator+() [3/3]

template<typename T , int N>

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

noexceptinherited

Definition at line 94 of file Extent.cc.

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

operator+=()

template<typename T , int N>

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

inlinenoexceptinherited

Definition at line 138 of file Extent.h.

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

operator-() [1/2]

template<typename T , int N>

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

inlinenoexceptinherited

Definition at line 149 of file Extent.h.

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

operator-() [2/2]

template<typename T , int N>

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

inlinenoexceptinherited

Definition at line 135 of file Extent.h.

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

operator-=()

template<typename T , int N>

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

inlinenoexceptinherited

Definition at line 142 of file Extent.h.

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

operator/()

template<typename T , int N>

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.

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

operator/=()

template<typename T , int N>

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.

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

operator=() [1/2]

template<typename T , int N>

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

default

operator=() [2/2]

template<typename T , int N>

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

default

operator==()

template<typename T , int N>

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.

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

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

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

swap()

template<typename T , int N>

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

inlinenoexcept

Definition at line 245 of file Extent.h.

{ this->_swap(other); }

toString()

template<typename T , int N>

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.

                               {
        std::stringstream out;
        out << "Extent(";
        for (size_t i = 0; i < N; ++i) {
            if (i != 0) {
                out << ",";
            }
            out << (*this)[i];
        }
        out << ")";
        return out.str();
    }

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.

                                                                                {
    Eigen::Array<T, N, 1> diff = (a.asEigen().array() - b.asEigen().array()).abs();
    Eigen::Array<T, N, 1> rhs = (0.5 * (a.asEigen().array() + b.asEigen().array())).abs();
    rhs *= rtol;
    rhs += atol;
    return (diff <= rhs).all();
}

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:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/geom/g414038480c+5b5cd4fff3/include/lsst/geom/CoordinateBase.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/geom/g414038480c+5b5cd4fff3/include/lsst/geom/Extent.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/geom/g414038480c+5b5cd4fff3/src/Extent.cc