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

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

#include <CoordinateBase.h>

Inheritance diagram for lsst::afw::geom::Extent< T, N >:

Public Types
typedef Super::EigenVector	EigenVector
typedef T	Element

Public Member Functions
	Extent (T val=static_cast< T >(0))
	Construct an Extent with all elements set to the same scalar value. More...
	Extent (EigenVector const &vector)
	Construct an Extent from an Eigen vector. More...
	Extent (Point< T, N > const &other)
	Explicit constructor from Point. More...
template<typename U >
	Extent (Extent< U, N > const &other)
	Explicit constructor from Extent of different type (if allowed) More...
template<typename U >
	Extent (Point< U, N > const &other)
	Extent (Extent const &other)
	Extent (Extent &&other)
	~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 + ...). More...
T	computeNorm () const
	Return the L2 norm of the Extent (sqrt(x^2 + y^2 + ...)). More...
void	swap (Extent &other)
bool	operator== (Extent< T, N > const &other) const
	Standard equality comparison. More...
bool	operator!= (Extent< T, N > const &other) const
	Standard inequality comparison. More...
Point< T, N >	asPoint () const
	Cast this object to an Extent of the same numeric type and dimensionality. More...
std::string	toString () const
T &	operator[] (int n)
T const &	operator[] (int n) const
T &	coeffRef (int n)
T const &	coeffRef (int n) const
EigenVector const &	asEigen () const
	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
CoordinateExpr< N >	eq (T scalar) const
CoordinateExpr< N >	ne (Extent< T, N > const &other) const
CoordinateExpr< N >	ne (T scalar) const
CoordinateExpr< N >	lt (Extent< T, N > const &other) const
CoordinateExpr< N >	lt (T scalar) const
CoordinateExpr< N >	le (Extent< T, N > const &other) const
CoordinateExpr< N >	le (T scalar) const
CoordinateExpr< N >	gt (Extent< T, N > const &other) const
CoordinateExpr< N >	gt (T scalar) const
CoordinateExpr< N >	ge (Extent< T, N > const &other) const
CoordinateExpr< N >	ge (T scalar) const
Additive arithmetic operators
No scalar interoperability is provided for Extent additive arithmetic operations.
Point< T, N >	operator+ (Point< T, N > const &other) const
Extent< T, N >	operator+ (Extent< T, N > const &other) const
Extent< T, N >	operator+ () const
Extent< T, N >	operator- (Extent< T, N > const &other) const
Extent< T, N >	operator- () const
Extent< T, N > &	operator+= (Extent< T, N > const &other)
Extent< T, N > &	operator-= (Extent< T, N > const &other)
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
Extent< T, N > &	operator*= (T scalar)
Extent< T, N >	operator/ (T scalar) const
Extent< T, N > &	operator/= (T scalar)

Static Public Attributes
static int const	dimensions

Protected Member Functions
void	_swap (CoordinateBase &other)

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))
	Floating-point comparison with tolerance. More...

Detailed Description

template<typename T, int N>
class lsst::afw::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 Operators on Point and Extent for mathematical operators on Extent.

Definition at line 44 of file CoordinateBase.h.

Member Typedef Documentation

EigenVector

template<typename T, int N>

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

Definition at line 197 of file Extent.h.

Element

typedef T lsst::afw::geom::CoordinateBase< Extent< T, N > , T, N >::Element

inherited

Definition at line 54 of file CoordinateBase.h.

Constructor & Destructor Documentation

Extent() [1/7]

template<typename T, int N>

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

inlineexplicit

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

Definition at line 200 of file Extent.h.

: Super(val) {}

Extent() [2/7]

template<typename T, int N>

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

inlineexplicit

Construct an Extent from an Eigen vector.

Definition at line 203 of file Extent.h.

: Super(vector) {}

Extent() [3/7]

template<typename T, int N>

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

explicit

Explicit constructor from Point.

Definition at line 32 of file Extent.cc.

: Super(other.asEigen()) {}

Extent() [4/7]

template<typename T, int N>

template<typename U >

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

explicit

Explicit constructor from Extent of different type (if allowed)

Extent() [5/7]

template<typename T, int N>

template<typename U >

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

explicit

Extent() [6/7]

template<typename T, int N>

lsst::afw::geom::Extent< T, N >::Extent

(

Extent< T, N > const &

other

)

Extent() [7/7]

template<typename T, int N>

lsst::afw::geom::Extent< T, N >::Extent

(

Extent< T, N > &&

other

)

~Extent()

template<typename T, int N>

lsst::afw::geom::Extent< T, N >::~Extent ( )

default

Member Function Documentation

_swap()

void lsst::afw::geom::CoordinateBase< Extent< T, N > , T, N >::_swap ( CoordinateBase< Extent< T, N >, T, N > &  other )

inlineprotectedinherited

Definition at line 93 of file CoordinateBase.h.

{ _vector.swap(other._vector); }

asEigen()

EigenVector const& lsst::afw::geom::CoordinateBase< Extent< T, N > , T, N >::asEigen ( ) const

inlineinherited

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 75 of file CoordinateBase.h.

{ return _vector; }

asPoint()

template<typename T , int N>

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

inherited

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

Definition at line 87 of file Extent.cc.

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

coeffRef() [1/2]

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

inlineinherited

Definition at line 66 of file CoordinateBase.h.

{ return _vector.coeffRef(n); }

coeffRef() [2/2]

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

inlineinherited

Definition at line 67 of file CoordinateBase.h.

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

computeNorm()

template<typename T, int N>

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

inline

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

Definition at line 225 of file Extent.h.

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

computeSquaredNorm()

template<typename T, int N>

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

inline

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

Definition at line 222 of file Extent.h.

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

eq() [1/2]

template<typename T, int N>

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

inherited

Definition at line 45 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::afw::geom::ExtentBase< T, N >::eq ( T  scalar ) const

inlineinherited

Definition at line 109 of file Extent.h.

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

ge() [1/2]

template<typename T, int N>

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

inherited

Definition at line 80 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::afw::geom::ExtentBase< T, N >::ge ( T  scalar ) const

inlineinherited

Definition at line 114 of file Extent.h.

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

gt() [1/2]

template<typename T, int N>

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

inherited

Definition at line 73 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::afw::geom::ExtentBase< T, N >::gt ( T  scalar ) const

inlineinherited

Definition at line 113 of file Extent.h.

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

le() [1/2]

template<typename T, int N>

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

inherited

Definition at line 66 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::afw::geom::ExtentBase< T, N >::le ( T  scalar ) const

inlineinherited

Definition at line 112 of file Extent.h.

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

lt() [1/2]

template<typename T, int N>

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

inherited

Definition at line 59 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::afw::geom::ExtentBase< T, N >::lt ( T  scalar ) const

inlineinherited

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::afw::geom::ExtentBase< T, N >::ne ( Extent< T, N > const &  other ) const

inherited

Definition at line 52 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::afw::geom::ExtentBase< T, N >::ne ( T  scalar ) const

inlineinherited

Definition at line 110 of file Extent.h.

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

operator!=()

template<typename T, int N>

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

inlineinherited

Standard inequality comparison.

Returns true iff any(this->ne(other));

Definition at line 88 of file Extent.h.

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

operator*()

template<typename T, int N>

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

inlineinherited

Definition at line 148 of file Extent.h.

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

operator*=()

template<typename T, int N>

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

inlineinherited

Definition at line 149 of file Extent.h.

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

operator+() [1/3]

template<typename T, int N>

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

inherited

Definition at line 92 of file Extent.cc.

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

operator+() [2/3]

template<typename T, int N>

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

inlineinherited

Definition at line 124 of file Extent.h.

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

operator+() [3/3]

template<typename T, int N>

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

inlineinherited

Definition at line 138 of file Extent.h.

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

operator+=()

template<typename T, int N>

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

inlineinherited

Definition at line 130 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::afw::geom::ExtentBase< T, N >::operator- ( Extent< T, N > const &  other ) const

inlineinherited

Definition at line 127 of file Extent.h.

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

operator-() [2/2]

template<typename T, int N>

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

inlineinherited

Definition at line 139 of file Extent.h.

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

operator-=()

template<typename T, int N>

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

inlineinherited

Definition at line 134 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::afw::geom::ExtentBase< T, N >::operator/ ( T  scalar ) const

inlineinherited

Definition at line 153 of file Extent.h.

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

operator/=()

template<typename T, int N>

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

inlineinherited

Definition at line 154 of file Extent.h.

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

operator=() [1/2]

template<typename T, int N>

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

default

operator=() [2/2]

template<typename T, int N>

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

default

operator==()

template<typename T, int N>

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

inlineinherited

Standard equality comparison.

Returns true iff all(this->eq(other));

Definition at line 81 of file Extent.h.

{ return all(this->eq(other)); }

operator[]() [1/2]

T& lsst::afw::geom::CoordinateBase< Extent< T, N > , T, N >::operator[] ( int  n )

inlineinherited

Definition at line 64 of file CoordinateBase.h.

{ return _vector[n]; }

operator[]() [2/2]

T const& lsst::afw::geom::CoordinateBase< Extent< T, N > , T, N >::operator[] ( int  n ) const

inlineinherited

Definition at line 65 of file CoordinateBase.h.

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

swap()

template<typename T, int N>

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

inline

Definition at line 227 of file Extent.h.

{ this->_swap(other); }

toString()

template<typename T, int N>

std::string lsst::afw::geom::ExtentBase< T, N >::toString ( ) const

inlineinherited

Definition at line 163 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 Function 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 32 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::afw::geom::CoordinateBase< Extent< T, N > , T, N >::_vector

protectedinherited

Definition at line 94 of file CoordinateBase.h.

dimensions

int const lsst::afw::geom::CoordinateBase< Extent< T, N > , T, N >::dimensions

staticinherited

Definition at line 55 of file CoordinateBase.h.

---

The documentation for this class was generated from the following files:

• /home/jenkins-slave/snowflake/release/lsstsw/stack/Linux64/afw/15.0-29-ga12a2b06e/include/lsst/afw/geom/CoordinateBase.h
• /home/jenkins-slave/snowflake/release/lsstsw/stack/Linux64/afw/15.0-29-ga12a2b06e/include/lsst/afw/geom/Extent.h
• /home/jenkins-slave/snowflake/release/lsstsw/stack/Linux64/afw/15.0-29-ga12a2b06e/src/geom/Extent.cc