LSST Applications g04e9c324dd+8c5ae1fdc5,g134cb467dc+1b3060144d,g18429d2f64+f642bf4753,g199a45376c+0ba108daf9,g1fd858c14a+2dcf163641,g262e1987ae+7b8c96d2ca,g29ae962dfc+3bd6ecb08a,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+53e1a9e7c5,g4595892280+fef73a337f,g47891489e3+2efcf17695,g4d44eb3520+642b70b07e,g53246c7159+8c5ae1fdc5,g67b6fd64d1+2efcf17695,g67fd3c3899+b70e05ef52,g74acd417e5+317eb4c7d4,g786e29fd12+668abc6043,g87389fa792+8856018cbb,g89139ef638+2efcf17695,g8d7436a09f+3be3c13596,g8ea07a8fe4+9f5ccc88ac,g90f42f885a+a4e7b16d9b,g97be763408+ad77d7208f,g9dd6db0277+b70e05ef52,ga681d05dcb+a3f46e7fff,gabf8522325+735880ea63,gac2eed3f23+2efcf17695,gb89ab40317+2efcf17695,gbf99507273+8c5ae1fdc5,gd8ff7fe66e+b70e05ef52,gdab6d2f7ff+317eb4c7d4,gdc713202bf+b70e05ef52,gdfd2d52018+b10e285e0f,ge365c994fd+310e8507c4,ge410e46f29+2efcf17695,geaed405ab2+562b3308c0,gffca2db377+8c5ae1fdc5,w.2025.35
LSST Data Management Base Package
Loading...
Searching...
No Matches
lsst::geom::CoordinateExpr< N > Class Template Reference

A boolean coordinate. More...

#include <CoordinateExpr.h>

Inheritance diagram for lsst::geom::CoordinateExpr< N >:
lsst::geom::CoordinateBase< CoordinateExpr< N >, bool, 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
 
CoordinateExproperator= (CoordinateExpr const &) noexcept=default
 
CoordinateExproperator= (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.

55: Super(val) {}
A boolean coordinate.

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

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

108{ _vector.swap(other._vector); }
A CRTP base class for coordinate objects.

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

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

30 {
31 CoordinateExpr r(*this);
32 for (int n = 0; n < N; ++n) {
33 if (!other[n]) r[n] = false;
34 }
35 return r;
36}
CoordinateExpr(bool val=false) noexcept
Construct a CoordinateExpr with all elements set to the same scalar value.

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

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

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

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

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

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

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

48 {
50 for (int n = 0; n < N; ++n) {
51 if (!this->operator[](n)) r[n] = true;
52 }
53 return r;
54}

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

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

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

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

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

39 {
40 CoordinateExpr r(*this);
41 for (int n = 0; n < N; ++n) {
42 if (other[n]) r[n] = true;
43 }
44 return r;
45}

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.

32 {
33 Eigen::Array<T, N, 1> diff = (a.asEigen().array() - b.asEigen().array()).abs();
34 Eigen::Array<T, N, 1> rhs = (0.5 * (a.asEigen().array() + b.asEigen().array())).abs();
35 rhs *= rtol;
36 rhs += atol;
37 return (diff <= rhs).all();
38}
EigenVector const & asEigen() const noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
Return a fixed-size Eigen representation of the coordinate object.

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

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

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: