LSST Applications g042eb84c57+730a74494b,g04e9c324dd+8c5ae1fdc5,g134cb467dc+1f1e3e7524,g199a45376c+0ba108daf9,g1fd858c14a+fa7d31856b,g210f2d0738+f66ac109ec,g262e1987ae+83a3acc0e5,g29ae962dfc+d856a2cb1f,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+a1e0c9f713,g47891489e3+0d594cb711,g4d44eb3520+c57ec8f3ed,g4d7b6aa1c5+f66ac109ec,g53246c7159+8c5ae1fdc5,g56a1a4eaf3+fd7ad03fde,g64539dfbff+f66ac109ec,g67b6fd64d1+0d594cb711,g67fd3c3899+f66ac109ec,g6985122a63+0d594cb711,g74acd417e5+3098891321,g786e29fd12+668abc6043,g81db2e9a8d+98e2ab9f28,g87389fa792+8856018cbb,g89139ef638+0d594cb711,g8d7436a09f+80fda9ce03,g8ea07a8fe4+760ca7c3fc,g90f42f885a+033b1d468d,g97be763408+a8a29bda4b,g99822b682c+e3ec3c61f9,g9d5c6a246b+0d5dac0c3d,ga41d0fce20+9243b26dd2,gbf99507273+8c5ae1fdc5,gd7ef33dd92+0d594cb711,gdab6d2f7ff+3098891321,ge410e46f29+0d594cb711,geaed405ab2+c4bbc419c6,gf9a733ac38+8c5ae1fdc5,w.2025.38
LSST Data Management Base Package
Loading...
Searching...
No Matches
CoordinateBase.h
Go to the documentation of this file.
1/*
2 * Developed for the LSST Data Management System.
3 * This product includes software developed by the LSST Project
4 * (https://www.lsst.org).
5 * See the COPYRIGHT file at the top-level directory of this distribution
6 * for details of code ownership.
7 *
8 * This program is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation, either version 3 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program. If not, see <https://www.gnu.org/licenses/>.
20 */
21
22/*
23 * A CRTP base class for coordinate objects, providing partial specializations for 2D and 3D.
24 */
25#ifndef LSST_GEOM_COORDINATEBASE_H
26#define LSST_GEOM_COORDINATEBASE_H
27
28#include <iostream>
29#include <type_traits>
30#include <tuple>
31#include <utility>
32
33#include "Eigen/Core"
34
35namespace lsst {
36namespace geom {
37
38template <typename T, int N = 2>
39class Point;
40template <typename T, int N = 2>
41class Extent;
42
44template <typename T, typename U>
45bool constexpr IS_NOTHROW_CONVERTIBLE =
47
53template <typename Derived, typename T, int N>
55public:
56 static_assert(N > 0, "CoordinateBase must have a positive length.");
57 typedef T Element;
58 static int const dimensions = N;
59 typedef Eigen::Matrix<T, N, 1, Eigen::DontAlign> EigenVector;
62
63 // Can't use both =default and noexcept until Eigen supports noexcept
69 _vector = other._vector;
70 return *this;
71 }
73 _vector = std::move(other._vector);
74 return *this;
75 }
76 ~CoordinateBase() noexcept = default;
77
78 T& operator[](int n) { return _vector[n]; }
79 T const& operator[](int n) const { return const_cast<EigenVector&>(_vector)[n]; }
80 T& coeffRef(int n) { return _vector.coeffRef(n); }
81 T const& coeffRef(int n) const { return const_cast<EigenVector&>(_vector).coeffRef(n); }
82
89 EigenVector const& asEigen() const noexcept(IS_ELEMENT_NOTHROW_COPYABLE) { return _vector; }
90
91protected:
97 explicit CoordinateBase(T val = static_cast<T>(0)) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
98 : _vector(EigenVector::Constant(val)) {}
99
105 template <typename Vector>
106 explicit CoordinateBase(Eigen::MatrixBase<Vector> const& vector) : _vector(vector) {}
107
108 void _swap(CoordinateBase& other) noexcept { _vector.swap(other._vector); }
110};
111
119template <typename Derived, typename T, int N>
121 T rtol = static_cast<T>(1E-5),
122 T atol = static_cast<T>(1E-8)) noexcept(std::is_nothrow_copy_constructible<T>::value&&
123 std::is_nothrow_copy_assignable<T>::value);
124
128template <typename Derived, typename T>
129class CoordinateBase<Derived, T, 2> {
130public:
131 typedef T Element;
132 static int const dimensions = 2;
133 typedef Eigen::Matrix<T, 2, 1, Eigen::DontAlign> EigenVector;
136
137 // Can't use both =default and noexcept until Eigen supports noexcept
143 _vector = other._vector;
144 return *this;
145 }
147 _vector = std::move(other._vector);
148 return *this;
149 }
150 ~CoordinateBase() noexcept = default;
151
152 T& operator[](int n) { return _vector[n]; }
153 T const& operator[](int n) const { return const_cast<EigenVector&>(_vector)[n]; }
154 T& coeffRef(int n) { return _vector.coeffRef(n); }
155 T const& coeffRef(int n) const { return const_cast<EigenVector&>(_vector).coeffRef(n); }
156
163 EigenVector const& asEigen() const noexcept(IS_ELEMENT_NOTHROW_COPYABLE) { return _vector; }
164
165 T const& getX() const noexcept { return _vector.x(); }
166 T const& getY() const noexcept { return _vector.y(); }
167 T& getX() noexcept { return _vector.x(); }
168 T& getY() noexcept { return _vector.y(); }
169 void setX(T x) noexcept(IS_ELEMENT_NOTHROW_COPYABLE) { _vector.x() = x; }
170 void setY(T y) noexcept(IS_ELEMENT_NOTHROW_COPYABLE) { _vector.y() = y; }
171
174 return std::make_pair(_vector.x(), _vector.y());
175 }
176
181
182protected:
183 explicit CoordinateBase(T val = static_cast<T>(0)) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
184 : _vector(EigenVector::Constant(val)) {}
185
186 template <typename Vector>
187 explicit CoordinateBase(Eigen::MatrixBase<Vector> const& vector) : _vector(vector) {}
188 void _swap(CoordinateBase& other) noexcept { _vector.swap(other._vector); }
190};
191
195template <typename Derived, typename T>
196class CoordinateBase<Derived, T, 3> {
197public:
198 typedef T Element;
199 static int const dimensions = 3;
200 typedef Eigen::Matrix<T, 3, 1, Eigen::DontAlign> EigenVector;
203
204 // Can't use both =default and noexcept until Eigen supports noexcept
210 _vector = other._vector;
211 return *this;
212 }
214 _vector = std::move(other._vector);
215 return *this;
216 }
217 ~CoordinateBase() noexcept = default;
218
219 T& operator[](int n) { return _vector[n]; }
220 T const& operator[](int n) const { return const_cast<EigenVector&>(_vector)[n]; }
221 T& coeffRef(int n) { return _vector.coeffRef(n); }
222 T const& coeffRef(int n) const { return const_cast<EigenVector&>(_vector).coeffRef(n); }
223
230 EigenVector const& asEigen() const noexcept(IS_ELEMENT_NOTHROW_COPYABLE) { return _vector; }
231
232 T const& getX() const noexcept { return _vector.x(); }
233 T const& getY() const noexcept { return _vector.y(); }
234 T const& getZ() const noexcept { return _vector.z(); }
235 T& getX() noexcept { return _vector.x(); }
236 T& getY() noexcept { return _vector.y(); }
237 T& getZ() noexcept { return _vector.z(); }
238 void setX(T x) noexcept(IS_ELEMENT_NOTHROW_COPYABLE) { _vector.x() = x; }
239 void setY(T y) noexcept(IS_ELEMENT_NOTHROW_COPYABLE) { _vector.y() = y; }
240 void setZ(T z) noexcept(IS_ELEMENT_NOTHROW_COPYABLE) { _vector.z() = z; }
241
246
247protected:
248 explicit CoordinateBase(T val = static_cast<T>(0)) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
249 : _vector(EigenVector::Constant(val)) {}
250
251 template <typename Vector>
252 explicit CoordinateBase(Eigen::MatrixBase<Vector> const& vector) : _vector(vector) {}
253 void _swap(CoordinateBase& other) noexcept { _vector.swap(other._vector); }
255};
256
257template <typename Derived, typename T, int N>
259 os << "(" << coordinate[0];
260 for (int n = 1; n < N; ++n) os << ", " << coordinate[n];
261 return os << ")";
262}
263
264} // namespace geom
265} // namespace lsst
266
267#endif
void _swap(CoordinateBase &other) noexcept
CoordinateBase & operator=(CoordinateBase const &other) noexcept(IS_ELEMENT_NOTHROW_ASSIGNABLE)
Eigen::Matrix< T, 2, 1, Eigen::DontAlign > EigenVector
CoordinateBase(T val=static_cast< T >(0)) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
EigenVector const & asEigen() const noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
Return a fixed-size Eigen representation of the coordinate object.
std::pair< T, T > asPair() const noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
Return a std::pair representation of the coordinate object.
CoordinateBase(CoordinateBase &&other) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
void setX(T x) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
CoordinateBase(Eigen::MatrixBase< Vector > const &vector)
void setY(T y) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
CoordinateBase & operator=(CoordinateBase &&other) noexcept(IS_ELEMENT_NOTHROW_ASSIGNABLE)
std::tuple< T, T > asTuple() const noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
Return a std::tuple representation of the coordinate object.
CoordinateBase(CoordinateBase const &other) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
void setX(T x) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
void setY(T y) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
Eigen::Matrix< T, 3, 1, Eigen::DontAlign > EigenVector
void setZ(T z) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
CoordinateBase(CoordinateBase &&other) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
void _swap(CoordinateBase &other) noexcept
std::tuple< T, T, T > asTuple() const noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
Return a std::tuple representation of the coordinate object.
CoordinateBase(T val=static_cast< T >(0)) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
CoordinateBase & operator=(CoordinateBase &&other) noexcept(IS_ELEMENT_NOTHROW_ASSIGNABLE)
EigenVector const & asEigen() const noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
Return a fixed-size Eigen representation of the coordinate object.
CoordinateBase & operator=(CoordinateBase const &other) noexcept(IS_ELEMENT_NOTHROW_ASSIGNABLE)
CoordinateBase(CoordinateBase const &other) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
CoordinateBase(Eigen::MatrixBase< Vector > const &vector)
A CRTP base class for coordinate objects.
CoordinateBase & operator=(CoordinateBase const &other) noexcept(IS_ELEMENT_NOTHROW_ASSIGNABLE)
void _swap(CoordinateBase &other) noexcept
CoordinateBase(CoordinateBase &&other) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
Eigen::Matrix< T, N, 1, Eigen::DontAlign > EigenVector
EigenVector const & asEigen() const noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
Return a fixed-size Eigen representation of the coordinate object.
T const & coeffRef(int n) const
~CoordinateBase() noexcept=default
CoordinateBase(T val=static_cast< T >(0)) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
Initialize all elements to a scalar.
CoordinateBase(CoordinateBase const &other) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
T const & operator[](int n) const
CoordinateBase & operator=(CoordinateBase &&other) noexcept(IS_ELEMENT_NOTHROW_ASSIGNABLE)
CoordinateBase(Eigen::MatrixBase< Vector > const &vector)
Initialize all elements from an N-d Eigen vector.
A coordinate class intended to represent offsets and dimensions.
Definition Extent.h:210
A coordinate class intended to represent absolute positions.
Definition Point.h:169
T declval(T... args)
T make_pair(T... args)
T make_tuple(T... args)
T move(T... args)
bool constexpr IS_NOTHROW_CONVERTIBLE
Test that a type is nothrow-copy-convertible from U to T.
bool allclose(CoordinateBase< Derived, T, N > const &a, CoordinateBase< Derived, 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.
std::ostream & operator<<(std::ostream &os, lsst::geom::AffineTransform const &transform)
STL namespace.