lsst::afw::geom::CoordinateExpr< N > Class Template Reference

A boolean coordinate. More...

#include <CoordinateExpr.h>

Inheritance diagram for lsst::afw::geom::CoordinateExpr< N >:

Public Types
typedef bool	Element
typedef Eigen::Matrix< bool, N, 1, Eigen::DontAlign >	EigenVector

Public Member Functions
	CoordinateExpr (bool val=false)
	Construct a CoordinateExpr with all elements set to the same scalar value. More...
template<typename Vector >
	CoordinateExpr (Eigen::MatrixBase< Vector > const &vector)
	Construct a CoordinateExpr from an Eigen vector. More...
	CoordinateExpr (CoordinateExpr const &)=default
	CoordinateExpr (CoordinateExpr &&)=default
CoordinateExpr &	operator= (CoordinateExpr const &)=default
CoordinateExpr &	operator= (CoordinateExpr &&)=default
	~CoordinateExpr ()=default
bool &	operator[] (int n)
bool const &	operator[] (int n) const
bool &	coeffRef (int n)
bool const &	coeffRef (int n) const
EigenVector const &	asEigen () const
	Return a fixed-size Eigen representation of the coordinate object. More...
Logical operators
These operators do not provide interoperability with scalars.
CoordinateExpr	and_ (CoordinateExpr const &rhs) const
CoordinateExpr	or_ (CoordinateExpr const &rhs) const
CoordinateExpr	not_ () const

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< CoordinateExpr< N >, bool, N > const &a, CoordinateBase< CoordinateExpr< N >, bool, N > const &b, bool rtol=static_cast< bool >(1E-5), bool atol=static_cast< bool >(1E-8))
	Floating-point comparison with tolerance. More...

Detailed Description

template<int N>
class lsst::afw::geom::CoordinateExpr< N >

A boolean coordinate.

CoordinateExpr is intended to be used as a temporary in coordinate comparisons:

Point2D a(3.5,1.2);
Point2D b(-1.5,4.3);
std::cout << all(a.lt(b)) << std::endl;  // false
std::cout << any(a.lt(b)) << std::endl;  // true

CoordinateExpr is not a true lazy-evaluation expression template, as that seems unnecessary when the object is typically only two bools large (smaller than the raw pointers necessary to implement a lazy solution). The consequence is that there's no short-circuiting of logical operators, but I don't think that will even remotely matter for most use cases. The any() and all() functions do support short-circuiting.

Definition at line 54 of file CoordinateExpr.h.

Member Typedef Documentation

EigenVector

typedef Eigen::Matrix<bool , N, 1, Eigen::DontAlign> lsst::afw::geom::CoordinateBase< CoordinateExpr< N > , bool , N >::EigenVector

inherited

Definition at line 56 of file CoordinateBase.h.

Element

typedef bool lsst::afw::geom::CoordinateBase< CoordinateExpr< N > , bool , N >::Element

inherited

Definition at line 54 of file CoordinateBase.h.

Constructor & Destructor Documentation

CoordinateExpr() [1/4]

template<int N>

lsst::afw::geom::CoordinateExpr< N >::CoordinateExpr ( bool  val = false )

inlineexplicit

Construct a CoordinateExpr with all elements set to the same scalar value.

Definition at line 59 of file CoordinateExpr.h.

: Super(val) {}

CoordinateExpr() [2/4]

template<int N>

template<typename Vector >

lsst::afw::geom::CoordinateExpr< N >::CoordinateExpr ( Eigen::MatrixBase< Vector > const &  vector )

inlineexplicit

Construct a CoordinateExpr from an Eigen vector.

Definition at line 63 of file CoordinateExpr.h.

: Super(vector) {}

CoordinateExpr() [3/4]

template<int N>

lsst::afw::geom::CoordinateExpr< N >::CoordinateExpr ( CoordinateExpr< N > const &  )

default

CoordinateExpr() [4/4]

template<int N>

lsst::afw::geom::CoordinateExpr< N >::CoordinateExpr ( CoordinateExpr< N > &&  )

default

~CoordinateExpr()

template<int N>

lsst::afw::geom::CoordinateExpr< N >::~CoordinateExpr ( )

default

Member Function Documentation

_swap()

void lsst::afw::geom::CoordinateBase< CoordinateExpr< N > , bool , N >::_swap ( CoordinateBase< CoordinateExpr< N >, bool, N > &  other )

inlineprotectedinherited

Definition at line 93 of file CoordinateBase.h.

{ _vector.swap(other._vector); }

and_()

template<int N>

CoordinateExpr< N > lsst::afw::geom::CoordinateExpr< N >::and_

(

CoordinateExpr< N > const &

rhs

)

const

Definition at line 32 of file CoordinateExpr.cc.

                                                                              {
    CoordinateExpr r(*this);
    for (int n = 0; n < N; ++n) {
        if (!other[n]) r[n] = false;
    }
    return r;
}

asEigen()

EigenVector const& lsst::afw::geom::CoordinateBase< CoordinateExpr< N > , bool , 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; }

coeffRef() [1/2]

bool & lsst::afw::geom::CoordinateBase< CoordinateExpr< N > , bool , N >::coeffRef ( int  n )

inlineinherited

Definition at line 66 of file CoordinateBase.h.

{ return _vector.coeffRef(n); }

coeffRef() [2/2]

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

inlineinherited

Definition at line 67 of file CoordinateBase.h.

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

not_()

template<int N>

CoordinateExpr< N > lsst::afw::geom::CoordinateExpr< N >::not_

(

)

const

Definition at line 50 of file CoordinateExpr.cc.

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

operator=() [1/2]

template<int N>

CoordinateExpr& lsst::afw::geom::CoordinateExpr< N >::operator= ( CoordinateExpr< N > const &  )

default

operator=() [2/2]

template<int N>

CoordinateExpr& lsst::afw::geom::CoordinateExpr< N >::operator= ( CoordinateExpr< N > &&  )

default

operator[]() [1/2]

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

inlineinherited

Definition at line 64 of file CoordinateBase.h.

{ return _vector[n]; }

operator[]() [2/2]

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

inlineinherited

Definition at line 65 of file CoordinateBase.h.

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

or_()

template<int N>

CoordinateExpr< N > lsst::afw::geom::CoordinateExpr< N >::or_

(

CoordinateExpr< N > const &

rhs

)

const

Definition at line 41 of file CoordinateExpr.cc.

                                                                             {
    CoordinateExpr r(*this);
    for (int n = 0; n < N; ++n) {
        if (other[n]) r[n] = true;
    }
    return r;
}

Friends And Related Function Documentation

allclose()

bool allclose ( CoordinateBase< CoordinateExpr< N > , bool , N > const &  a, CoordinateBase< CoordinateExpr< N > , bool , N > const &  b, bool  rtol = static_cast<T>(1E-5), bool  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< CoordinateExpr< N > , bool , N >::_vector

protectedinherited

Definition at line 94 of file CoordinateBase.h.

dimensions

int const lsst::afw::geom::CoordinateBase< CoordinateExpr< N > , bool , 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/CoordinateExpr.h
• /home/jenkins-slave/snowflake/release/lsstsw/stack/Linux64/afw/15.0-29-ga12a2b06e/src/geom/CoordinateExpr.cc