lsst.geom ga1e77700b3+4b180a49bb
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< double, 2 > lsst::geom::Point< int, 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.

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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: