LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Related Functions | List of all members
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. More...
 
template<typename Vector >
 CoordinateExpr (Eigen::MatrixBase< Vector > const &vector)
 Construct a CoordinateExpr from an Eigen vector. More...
 
 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 & 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. More...
 
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 constexpr bool IS_ELEMENT_NOTHROW_COPYABLE
 
static constexpr bool IS_ELEMENT_NOTHROW_ASSIGNABLE
 

Protected Member Functions

void _swap (CoordinateBase &other) noexcept
 

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)) noexcept(std::is_nothrow_copy_constructible< bool >::value &&std::is_nothrow_copy_assignable< bool >::value)
 Floating-point comparison with tolerance. More...
 

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) {}
ImageT val
Definition: CR.cc:146

◆ 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()

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

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

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

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); }
Eigen::Matrix< bool, N, 1, Eigen::DontAlign > EigenVector

◆ not_()

template<int N>
CoordinateExpr< N > lsst::geom::CoordinateExpr< N >::not_
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/2]

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

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 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 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 }
table::Key< int > b
table::Key< int > a
T atol(T... args)
Angle abs(Angle const &a)
Definition: Angle.h:106

Member Data Documentation

◆ _vector

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

Definition at line 109 of file CoordinateBase.h.

◆ dimensions

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

Definition at line 58 of file CoordinateBase.h.

◆ IS_ELEMENT_NOTHROW_ASSIGNABLE

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

Definition at line 61 of file CoordinateBase.h.

◆ IS_ELEMENT_NOTHROW_COPYABLE

constexpr bool 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: