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

#include <Extent.h>

Inheritance diagram for lsst::geom::ExtentBase< 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
ExtentBase &	operator= (ExtentBase const &)=default
ExtentBase &	operator= (ExtentBase &&)=default
	~ExtentBase ()=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 + ...)).
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.

            : Super(val) {}

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.

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

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

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.

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

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.

{ 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

noexcept

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

inlinenoexcept

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

noexcept

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

inlinenoexcept

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

noexcept

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

inlinenoexcept

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

noexcept

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

inlinenoexcept

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

noexcept

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

inlinenoexcept

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

noexcept

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

inlinenoexcept

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

inlinenoexcept

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

inlinenoexcept

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 )

inlinenoexcept

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

inlinenoexcept

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

inlinenoexcept

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

noexcept

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 )

inlinenoexcept

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

inlinenoexcept

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

inlinenoexcept

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 )

inlinenoexcept

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

inlinenoexcept

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 )

inlinenoexcept

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>

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.

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

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.

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

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+077ccc18e7/include/lsst/geom/Extent.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/geom/g414038480c+077ccc18e7/src/Extent.cc