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

A boolean coordinate. More...

#include <CoordinateExpr.h>

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

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

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

Static Public Attributes
static int const	dimensions
static int const	dimensions
static bool constexpr	IS_ELEMENT_NOTHROW_COPYABLE
static bool constexpr	IS_ELEMENT_NOTHROW_COPYABLE
static bool constexpr	IS_ELEMENT_NOTHROW_ASSIGNABLE
static bool constexpr	IS_ELEMENT_NOTHROW_ASSIGNABLE

Protected Member Functions
void	_swap (CoordinateBase &other) noexcept
void	_swap (CoordinateBase &other) noexcept

Protected Attributes
EigenVector	_vector
EigenVector	_vector

Related Symbols
(Note that these are not member symbols.)
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)) noexcept(std::is_nothrow_copy_constructible< bool >::value &&std::is_nothrow_copy_assignable< bool >::value)
	Floating-point comparison with tolerance.
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)) noexcept(std::is_nothrow_copy_constructible< bool >::value &&std::is_nothrow_copy_assignable< bool >::value)
	Floating-point comparison with tolerance.

Detailed Description

template<int N>
class lsst::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 50 of file CoordinateExpr.h.

Member Typedef Documentation

EigenVector

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

inherited

Definition at line 59 of file CoordinateBase.h.

Element

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

inherited

Definition at line 57 of file CoordinateBase.h.

Constructor & Destructor Documentation

CoordinateExpr() [1/4]

template<int N>

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

inlineexplicitnoexcept

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

Definition at line 55 of file CoordinateExpr.h.

: Super(val) {}

CoordinateExpr() [2/4]

template<int N>

template<typename Vector>

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

inlineexplicit

Construct a CoordinateExpr from an Eigen vector.

Definition at line 59 of file CoordinateExpr.h.

: Super(vector) {}

CoordinateExpr() [3/4]

template<int N>

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

defaultnoexcept

CoordinateExpr() [4/4]

template<int N>

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

defaultnoexcept

~CoordinateExpr()

template<int N>

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

defaultnoexcept

Member Function Documentation

_swap() [1/2]

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

inlineprotectednoexceptinherited

Definition at line 108 of file CoordinateBase.h.

{ _vector.swap(other._vector); }

_swap() [2/2]

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

inlineprotectednoexceptinherited

Definition at line 108 of file CoordinateBase.h.

{ _vector.swap(other._vector); }

and_()

template<int N>

CoordinateExpr< N > lsst::geom::CoordinateExpr< N >::and_ ( CoordinateExpr< N > const & rhs ) const

noexcept

Definition at line 30 of file CoordinateExpr.cc.

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

asEigen() [1/2]

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

asEigen() [2/2]

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

coeffRef() [1/4]

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

inlineinherited

Definition at line 80 of file CoordinateBase.h.

{ return _vector.coeffRef(n); }

coeffRef() [2/4]

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

inlineinherited

Definition at line 80 of file CoordinateBase.h.

{ return _vector.coeffRef(n); }

coeffRef() [3/4]

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

inlineinherited

Definition at line 81 of file CoordinateBase.h.

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

coeffRef() [4/4]

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

inlineinherited

Definition at line 81 of file CoordinateBase.h.

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

not_()

template<int N>

CoordinateExpr< N > lsst::geom::CoordinateExpr< N >::not_ ( ) const

noexcept

Definition at line 48 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::geom::CoordinateExpr< N >::operator= ( CoordinateExpr< N > && )

defaultnoexcept

operator=() [2/2]

template<int N>

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

defaultnoexcept

operator[]() [1/4]

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

inlineinherited

Definition at line 78 of file CoordinateBase.h.

{ return _vector[n]; }

operator[]() [2/4]

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

inlineinherited

Definition at line 78 of file CoordinateBase.h.

{ return _vector[n]; }

operator[]() [3/4]

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

inlineinherited

Definition at line 79 of file CoordinateBase.h.

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

operator[]() [4/4]

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

inlineinherited

Definition at line 79 of file CoordinateBase.h.

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

or_()

template<int N>

CoordinateExpr< N > lsst::geom::CoordinateExpr< N >::or_ ( CoordinateExpr< N > const & rhs ) const

noexcept

Definition at line 39 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 Symbol Documentation

allclose() [1/2]

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

allclose() [2/2]

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 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 [1/2]

EigenVector lsst::geom::CoordinateBase< CoordinateExpr< N >, bool, N >::_vector

protectedinherited

Definition at line 109 of file CoordinateBase.h.

_vector [2/2]

EigenVector lsst::geom::CoordinateBase< CoordinateExpr< N >, bool, N >::_vector

protectedinherited

Definition at line 109 of file CoordinateBase.h.

dimensions [1/2]

int const lsst::geom::CoordinateBase< CoordinateExpr< N >, bool, N >::dimensions

staticinherited

Definition at line 58 of file CoordinateBase.h.

dimensions [2/2]

int const lsst::geom::CoordinateBase< CoordinateExpr< N >, bool, N >::dimensions

staticinherited

Definition at line 58 of file CoordinateBase.h.

IS_ELEMENT_NOTHROW_ASSIGNABLE [1/2]

bool constexpr lsst::geom::CoordinateBase< CoordinateExpr< N >, bool, N >::IS_ELEMENT_NOTHROW_ASSIGNABLE

staticconstexprinherited

Definition at line 61 of file CoordinateBase.h.

IS_ELEMENT_NOTHROW_ASSIGNABLE [2/2]

bool constexpr lsst::geom::CoordinateBase< CoordinateExpr< N >, bool, N >::IS_ELEMENT_NOTHROW_ASSIGNABLE

staticconstexprinherited

Definition at line 61 of file CoordinateBase.h.

IS_ELEMENT_NOTHROW_COPYABLE [1/2]

bool constexpr lsst::geom::CoordinateBase< CoordinateExpr< N >, bool, N >::IS_ELEMENT_NOTHROW_COPYABLE

staticconstexprinherited

Definition at line 60 of file CoordinateBase.h.

IS_ELEMENT_NOTHROW_COPYABLE [2/2]

bool constexpr lsst::geom::CoordinateBase< CoordinateExpr< N >, bool, 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-12.0.0/Linux/geom/gac66b60396+966efe6077/include/lsst/geom/CoordinateExpr.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.0.0/Linux/geom/gac66b60396+966efe6077/src/CoordinateExpr.cc