LSST Applications g0265f82a02+c6dfa2ddaf,g1162b98a3f+b2075782a9,g2079a07aa2+1b2e822518,g2bbee38e9b+c6dfa2ddaf,g337abbeb29+c6dfa2ddaf,g3ddfee87b4+a60788ef87,g50ff169b8f+2eb0e556e8,g52b1c1532d+90ebb246c7,g555ede804d+a60788ef87,g591dd9f2cf+ba8caea58f,g5ec818987f+864ee9cddb,g858d7b2824+9ee1ab4172,g876c692160+a40945ebb7,g8a8a8dda67+90ebb246c7,g8cdfe0ae6a+4fd9e222a8,g99cad8db69+5e309b7bc6,g9ddcbc5298+a1346535a5,ga1e77700b3+df8f93165b,ga8c6da7877+aa12a14d27,gae46bcf261+c6dfa2ddaf,gb0e22166c9+8634eb87fb,gb3f2274832+d0da15e3be,gba4ed39666+1ac82b564f,gbb8dafda3b+5dfd9c994b,gbeb006f7da+97157f9740,gc28159a63d+c6dfa2ddaf,gc86a011abf+9ee1ab4172,gcf0d15dbbd+a60788ef87,gdaeeff99f8+1cafcb7cd4,gdc0c513512+9ee1ab4172,ge79ae78c31+c6dfa2ddaf,geb67518f79+ba1859f325,geb961e4c1e+f9439d1e6f,gee10cc3b42+90ebb246c7,gf1cff7945b+9ee1ab4172,w.2024.12
LSST Data Management Base Package
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Related Symbols | List of all members
lsst::geom::PointBase< T, N > Class Template Reference

#include <Point.h>

Inheritance diagram for lsst::geom::PointBase< T, N >:
lsst::geom::CoordinateBase< Point< T, N >, T, N > lsst::geom::Point< int, 2 > lsst::geom::Point< double, 2 > lsst::geom::Point< T, N >

Public Types

typedef T Element
 
typedef Eigen::Matrix< T, N, 1, Eigen::DontAlign > EigenVector
 

Public Member Functions

 PointBase (PointBase const &)=default
 
 PointBase (PointBase &&)=default
 
PointBaseoperator= (PointBase const &)=default
 
PointBaseoperator= (PointBase &&)=default
 
 ~PointBase ()=default
 
bool operator== (Point< T, N > const &other) const noexcept
 Standard equality comparison.
 
bool operator!= (Point< T, N > const &other) const noexcept
 Standard inequality comparison.
 
T & operator[] (int n)
 
T const & operator[] (int n) const
 
T & coeffRef (int n)
 
T const & coeffRef (int n) const
 
EigenVector const & asEigen () const noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
 Return a fixed-size Eigen representation of the coordinate object.
 
Named vectorized 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(point.gt(0))) ...

are both ubiquitous and easy to interpret.

CoordinateExpr< N > eq (Point< T, N > const &other) const noexcept
 
CoordinateExpr< N > ne (Point< T, N > const &other) const noexcept
 
CoordinateExpr< N > lt (Point< T, N > const &other) const noexcept
 
CoordinateExpr< N > le (Point< T, N > const &other) const noexcept
 
CoordinateExpr< N > gt (Point< T, N > const &other) const noexcept
 
CoordinateExpr< N > ge (Point< T, N > const &other) const noexcept
 
CoordinateExpr< N > eq (T scalar) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 
CoordinateExpr< N > ne (T scalar) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 
CoordinateExpr< N > lt (T scalar) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 
CoordinateExpr< N > le (T scalar) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 
CoordinateExpr< N > gt (T scalar) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 
CoordinateExpr< N > ge (T scalar) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 

Static Public Attributes

static int const dimensions
 
static bool constexpr IS_ELEMENT_NOTHROW_COPYABLE
 
static bool constexpr IS_ELEMENT_NOTHROW_ASSIGNABLE
 

Protected Member Functions

void _swap (CoordinateBase &other) noexcept
 

Protected Attributes

EigenVector _vector
 

Related Symbols

(Note that these are not member symbols.)

bool allclose (CoordinateBase< Point< T, N >, T, N > const &a, CoordinateBase< Point< T, N >, T, N > const &b, T rtol=static_cast< T >(1E-5), T atol=static_cast< T >(1E-8)) noexcept(std::is_nothrow_copy_constructible< T >::value &&std::is_nothrow_copy_assignable< T >::value)
 Floating-point comparison with tolerance.
 

Arithmetic operators

No scalar interoperability is provided for Point arithmetic operations.

Extent< T, N > operator- (Point< T, N > const &other) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 Cast this object to an Extent of the same numeric type and dimensionality.
 
Point< T, N > operator+ (Extent< T, N > const &other) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 Cast this object to an Extent of the same numeric type and dimensionality.
 
Point< T, N > operator- (Extent< T, N > const &other) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 Cast this object to an Extent of the same numeric type and dimensionality.
 
Point< T, N > & operator+= (Extent< T, N > const &other) noexcept(Super::IS_ELEMENT_NOTHROW_ASSIGNABLE)
 Cast this object to an Extent of the same numeric type and dimensionality.
 
Point< T, N > & operator-= (Extent< T, N > const &other) noexcept(Super::IS_ELEMENT_NOTHROW_ASSIGNABLE)
 Cast this object to an Extent of the same numeric type and dimensionality.
 
Extent< T, N > asExtent () const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 Cast this object to an Extent of the same numeric type and dimensionality.
 
void shift (Extent< T, N > const &offset) noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 Shift the point by the given offset.
 
void scale (double factor) noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 Cast this object to an Extent of the same numeric type and dimensionality.
 
double distanceSquared (PointBase< T, N > const &other) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 Cast this object to an Extent of the same numeric type and dimensionality.
 
std::string toString () const
 Cast this object to an Extent of the same numeric type and dimensionality.
 
 PointBase (T val=static_cast< T >(0)) noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 Cast this object to an Extent of the same numeric type and dimensionality.
 
template<typename Vector >
 PointBase (Eigen::MatrixBase< Vector > const &vector)
 Cast this object to an Extent of the same numeric type and dimensionality.
 

Detailed Description

template<typename T, int N>
class lsst::geom::PointBase< T, N >

Definition at line 38 of file Point.h.

Member Typedef Documentation

◆ EigenVector

typedef Eigen::Matrix<T, N, 1, Eigen::DontAlign> lsst::geom::CoordinateBase< Point< T, N > , T, N >::EigenVector
inherited

Definition at line 59 of file CoordinateBase.h.

◆ Element

typedef T lsst::geom::CoordinateBase< Point< T, N > , T, N >::Element
inherited

Definition at line 57 of file CoordinateBase.h.

Constructor & Destructor Documentation

◆ PointBase() [1/4]

template<typename T , int N>
lsst::geom::PointBase< T, N >::PointBase ( PointBase< T, N > const & )
default

◆ PointBase() [2/4]

template<typename T , int N>
lsst::geom::PointBase< T, N >::PointBase ( PointBase< T, N > && )
default

◆ ~PointBase()

template<typename T , int N>
lsst::geom::PointBase< T, N >::~PointBase ( )
default

◆ PointBase() [3/4]

template<typename T , int N>
lsst::geom::PointBase< T, N >::PointBase ( T val = static_cast<T>(0))
inlineexplicitprotectednoexcept

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

Definition at line 157 of file Point.h.

157: Super(val) {}
ImageT val
Definition CR.cc:146

◆ PointBase() [4/4]

template<typename T , int N>
template<typename Vector >
lsst::geom::PointBase< T, N >::PointBase ( Eigen::MatrixBase< Vector > const & vector)
inlineexplicitprotected

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

Definition at line 160 of file Point.h.

160: Super(vector) {}

Member Function Documentation

◆ _swap()

void lsst::geom::CoordinateBase< Point< T, N > , T, N >::_swap ( CoordinateBase< Point< T, N >, T, N > & other)
inlineprotectednoexceptinherited

Definition at line 108 of file CoordinateBase.h.

◆ asEigen()

EigenVector const & lsst::geom::CoordinateBase< Point< T, N > , T, 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.

◆ asExtent()

template<typename T , int N>
Extent< T, N > lsst::geom::PointBase< T, N >::asExtent ( ) const
inlinenoexcept

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

Definition at line 127 of file Point.h.

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

◆ coeffRef() [1/2]

T & lsst::geom::CoordinateBase< Point< T, N > , T, N >::coeffRef ( int n)
inlineinherited

Definition at line 80 of file CoordinateBase.h.

◆ coeffRef() [2/2]

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

Definition at line 81 of file CoordinateBase.h.

◆ distanceSquared()

template<typename T , int N>
double lsst::geom::PointBase< T, N >::distanceSquared ( PointBase< T, N > const & other) const
inlinenoexcept

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

Definition at line 138 of file Point.h.

138 {
139 // the cast to double is lame but Eigen seems to require they be the same type
140 return (this->asEigen() - other.asEigen()).squaredNorm();
141 }
EigenVector const & asEigen() const noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
Return a fixed-size Eigen representation of the coordinate object.

◆ eq() [1/2]

template<typename T , int N>
CoordinateExpr< N > lsst::geom::PointBase< T, N >::eq ( Point< T, N > const & other) const
noexcept

Definition at line 76 of file Point.cc.

76 {
77 CoordinateExpr<N> r;
78 for (int n = 0; n < N; ++n) r[n] = this->_vector[n] == other[n];
79 return r;
80}

◆ eq() [2/2]

template<typename T , int N>
CoordinateExpr< N > lsst::geom::PointBase< T, N >::eq ( T scalar) const
inlinenoexcept

Definition at line 81 of file Point.h.

81 {
82 return this->eq(Point<T, N>(scalar));
83 }
CoordinateExpr< N > eq(Point< T, N > const &other) const noexcept
Definition Point.cc:76

◆ ge() [1/2]

template<typename T , int N>
CoordinateExpr< N > lsst::geom::PointBase< T, N >::ge ( Point< T, N > const & other) const
noexcept

Definition at line 111 of file Point.cc.

111 {
112 CoordinateExpr<N> r;
113 for (int n = 0; n < N; ++n) r[n] = this->_vector[n] >= other[n];
114 return r;
115}

◆ ge() [2/2]

template<typename T , int N>
CoordinateExpr< N > lsst::geom::PointBase< T, N >::ge ( T scalar) const
inlinenoexcept

Definition at line 96 of file Point.h.

96 {
97 return this->ge(Point<T, N>(scalar));
98 }
CoordinateExpr< N > ge(Point< T, N > const &other) const noexcept
Definition Point.cc:111

◆ gt() [1/2]

template<typename T , int N>
CoordinateExpr< N > lsst::geom::PointBase< T, N >::gt ( Point< T, N > const & other) const
noexcept

Definition at line 104 of file Point.cc.

104 {
105 CoordinateExpr<N> r;
106 for (int n = 0; n < N; ++n) r[n] = this->_vector[n] > other[n];
107 return r;
108}

◆ gt() [2/2]

template<typename T , int N>
CoordinateExpr< N > lsst::geom::PointBase< T, N >::gt ( T scalar) const
inlinenoexcept

Definition at line 93 of file Point.h.

93 {
94 return this->gt(Point<T, N>(scalar));
95 }
CoordinateExpr< N > gt(Point< T, N > const &other) const noexcept
Definition Point.cc:104

◆ le() [1/2]

template<typename T , int N>
CoordinateExpr< N > lsst::geom::PointBase< T, N >::le ( Point< T, N > const & other) const
noexcept

Definition at line 97 of file Point.cc.

97 {
98 CoordinateExpr<N> r;
99 for (int n = 0; n < N; ++n) r[n] = this->_vector[n] <= other[n];
100 return r;
101}

◆ le() [2/2]

template<typename T , int N>
CoordinateExpr< N > lsst::geom::PointBase< T, N >::le ( T scalar) const
inlinenoexcept

Definition at line 90 of file Point.h.

90 {
91 return this->le(Point<T, N>(scalar));
92 }
CoordinateExpr< N > le(Point< T, N > const &other) const noexcept
Definition Point.cc:97

◆ lt() [1/2]

template<typename T , int N>
CoordinateExpr< N > lsst::geom::PointBase< T, N >::lt ( Point< T, N > const & other) const
noexcept

Definition at line 90 of file Point.cc.

90 {
91 CoordinateExpr<N> r;
92 for (int n = 0; n < N; ++n) r[n] = this->_vector[n] < other[n];
93 return r;
94}

◆ lt() [2/2]

template<typename T , int N>
CoordinateExpr< N > lsst::geom::PointBase< T, N >::lt ( T scalar) const
inlinenoexcept

Definition at line 87 of file Point.h.

87 {
88 return this->lt(Point<T, N>(scalar));
89 }
CoordinateExpr< N > lt(Point< T, N > const &other) const noexcept
Definition Point.cc:90

◆ ne() [1/2]

template<typename T , int N>
CoordinateExpr< N > lsst::geom::PointBase< T, N >::ne ( Point< T, N > const & other) const
noexcept

Definition at line 83 of file Point.cc.

83 {
84 CoordinateExpr<N> r;
85 for (int n = 0; n < N; ++n) r[n] = this->_vector[n] != other[n];
86 return r;
87}

◆ ne() [2/2]

template<typename T , int N>
CoordinateExpr< N > lsst::geom::PointBase< T, N >::ne ( T scalar) const
inlinenoexcept

Definition at line 84 of file Point.h.

84 {
85 return this->ne(Point<T, N>(scalar));
86 }
CoordinateExpr< N > ne(Point< T, N > const &other) const noexcept
Definition Point.cc:83

◆ operator!=()

template<typename T , int N>
bool lsst::geom::PointBase< T, N >::operator!= ( Point< T, N > const & other) const
inlinenoexcept

Standard inequality comparison.

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

Definition at line 60 of file Point.h.

60{ return any(this->ne(other)); }
bool any(CoordinateExpr< N > const &expr) noexcept
Return true if any elements are true.

◆ operator+()

template<typename T , int N>
Point< T, N > lsst::geom::PointBase< T, N >::operator+ ( Extent< T, N > const & other) const
inlinenoexcept

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

Definition at line 110 of file Point.h.

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

◆ operator+=()

template<typename T , int N>
Point< T, N > & lsst::geom::PointBase< T, N >::operator+= ( Extent< T, N > const & other)
inlinenoexcept

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

Definition at line 116 of file Point.h.

116 {
117 this->_vector += other.asEigen();
118 return static_cast<Point<T, N> &>(*this);
119 }

◆ operator-() [1/2]

template<typename T , int N>
Point< T, N > lsst::geom::PointBase< T, N >::operator- ( Extent< T, N > const & other) const
inlinenoexcept

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

Definition at line 113 of file Point.h.

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

◆ operator-() [2/2]

template<typename T , int N>
Extent< T, N > lsst::geom::PointBase< T, N >::operator- ( Point< T, N > const & other) const
inlinenoexcept

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

Definition at line 107 of file Point.h.

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

◆ operator-=()

template<typename T , int N>
Point< T, N > & lsst::geom::PointBase< T, N >::operator-= ( Extent< T, N > const & other)
inlinenoexcept

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

Definition at line 120 of file Point.h.

120 {
121 this->_vector -= other.asEigen();
122 return static_cast<Point<T, N> &>(*this);
123 }

◆ operator=() [1/2]

template<typename T , int N>
PointBase & lsst::geom::PointBase< T, N >::operator= ( PointBase< T, N > && )
default

◆ operator=() [2/2]

template<typename T , int N>
PointBase & lsst::geom::PointBase< T, N >::operator= ( PointBase< T, N > const & )
default

◆ operator==()

template<typename T , int N>
bool lsst::geom::PointBase< T, N >::operator== ( Point< T, N > const & other) const
inlinenoexcept

Standard equality comparison.

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

Definition at line 53 of file Point.h.

53{ return all(this->eq(other)); }
bool all(CoordinateExpr< N > const &expr) noexcept
Return true if all elements are true.

◆ operator[]() [1/2]

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

Definition at line 78 of file CoordinateBase.h.

◆ operator[]() [2/2]

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

Definition at line 79 of file CoordinateBase.h.

◆ scale()

template<typename T , int N>
void lsst::geom::PointBase< T, N >::scale ( double factor)
inlinenoexcept

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

Definition at line 136 of file Point.h.

136{ this->_vector *= factor; }

◆ shift()

template<typename T , int N>
void lsst::geom::PointBase< T, N >::shift ( Extent< T, N > const & offset)
inlinenoexcept

Shift the point by the given offset.

Definition at line 132 of file Point.h.

132 {
133 this->_vector += offset.asEigen();
134 }

◆ toString()

template<typename T , int N>
std::string lsst::geom::PointBase< T, N >::toString ( ) const
inline

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

Definition at line 143 of file Point.h.

143 {
145 out << "Point(";
146 for (size_t i = 0; i < N; ++i) {
147 if (i != 0) {
148 out << ",";
149 }
150 out << (*this)[i];
151 }
152 out << ")";
153 return out.str();
154 }
T str(T... args)

Friends And Related Symbol Documentation

◆ allclose()

bool allclose ( CoordinateBase< Point< T, N > , T, N > const & a,
CoordinateBase< Point< 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 120 of file CoordinateBase.cc.

Member Data Documentation

◆ _vector

EigenVector lsst::geom::CoordinateBase< Point< T, N > , T, N >::_vector
protectedinherited

Definition at line 109 of file CoordinateBase.h.

◆ dimensions

int const lsst::geom::CoordinateBase< Point< T, N > , T, N >::dimensions
staticinherited

Definition at line 58 of file CoordinateBase.h.

◆ IS_ELEMENT_NOTHROW_ASSIGNABLE

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

Definition at line 61 of file CoordinateBase.h.

◆ IS_ELEMENT_NOTHROW_COPYABLE

bool constexpr lsst::geom::CoordinateBase< Point< T, N > , T, 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: