LSSTApplications  17.0+124,17.0+14,17.0+73,18.0.0+37,18.0.0+80,18.0.0-4-g68ffd23+4,18.1.0-1-g0001055+12,18.1.0-1-g03d53ef+5,18.1.0-1-g1349e88+55,18.1.0-1-g2505f39+44,18.1.0-1-g5315e5e+4,18.1.0-1-g5e4b7ea+14,18.1.0-1-g7e8fceb+4,18.1.0-1-g85f8cd4+48,18.1.0-1-g8ff0b9f+4,18.1.0-1-ga2c679d+1,18.1.0-1-gd55f500+35,18.1.0-10-gb58edde+2,18.1.0-11-g0997b02+4,18.1.0-13-gfe4edf0b+12,18.1.0-14-g259bd21+21,18.1.0-19-gdb69f3f+2,18.1.0-2-g5f9922c+24,18.1.0-2-gd3b74e5+11,18.1.0-2-gfbf3545+32,18.1.0-26-g728bddb4+5,18.1.0-27-g6ff7ca9+2,18.1.0-3-g52aa583+25,18.1.0-3-g8ea57af+9,18.1.0-3-gb69f684+42,18.1.0-3-gfcaddf3+6,18.1.0-32-gd8786685a,18.1.0-4-gf3f9b77+6,18.1.0-5-g1dd662b+2,18.1.0-5-g6dbcb01+41,18.1.0-6-gae77429+3,18.1.0-7-g9d75d83+9,18.1.0-7-gae09a6d+30,18.1.0-9-gc381ef5+4,w.2019.45
LSSTDataManagementBasePackage
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 
35 namespace lsst {
36 namespace geom {
37 
38 template <typename T, int N = 2>
39 class Point;
40 template <typename T, int N = 2>
41 class Extent;
42 
44 template <typename T, typename U>
45 bool constexpr IS_NOTHROW_CONVERTIBLE =
46  std::is_nothrow_copy_constructible<T>::value&& noexcept(static_cast<T>(std::declval<U>()));
47 
53 template <typename Derived, typename T, int N>
55 public:
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
64  CoordinateBase(CoordinateBase const& other) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
65  : _vector(other._vector) {}
66  CoordinateBase(CoordinateBase&& other) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
67  : _vector(std::move(other._vector)) {}
68  CoordinateBase& operator=(CoordinateBase const& other) noexcept(IS_ELEMENT_NOTHROW_ASSIGNABLE) {
69  _vector = other._vector;
70  return *this;
71  }
72  CoordinateBase& operator=(CoordinateBase&& other) noexcept(IS_ELEMENT_NOTHROW_ASSIGNABLE) {
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 
91 protected:
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); }
109  EigenVector _vector;
110 };
111 
119 template <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 
128 template <typename Derived, typename T>
129 class CoordinateBase<Derived, T, 2> {
130 public:
131  typedef T Element;
132  static int const dimensions = 2;
133  typedef Eigen::Matrix<T, 2, 1, Eigen::DontAlign> EigenVector;
134  static bool constexpr IS_ELEMENT_NOTHROW_COPYABLE = std::is_nothrow_copy_constructible<T>::value;
135  static bool constexpr IS_ELEMENT_NOTHROW_ASSIGNABLE = std::is_nothrow_copy_assignable<T>::value;
136 
137  // Can't use both =default and noexcept until Eigen supports noexcept
138  CoordinateBase(CoordinateBase const& other) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
139  : _vector(other._vector) {}
140  CoordinateBase(CoordinateBase&& other) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
141  : _vector(std::move(other._vector)) {}
142  CoordinateBase& operator=(CoordinateBase const& other) noexcept(IS_ELEMENT_NOTHROW_ASSIGNABLE) {
143  _vector = other._vector;
144  return *this;
145  }
146  CoordinateBase& operator=(CoordinateBase&& other) noexcept(IS_ELEMENT_NOTHROW_ASSIGNABLE) {
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 
173  std::pair<T, T> asPair() const noexcept(IS_ELEMENT_NOTHROW_COPYABLE) {
174  return std::make_pair(_vector.x(), _vector.y());
175  }
176 
178  std::tuple<T, T> asTuple() const noexcept(IS_ELEMENT_NOTHROW_COPYABLE) {
179  return std::make_tuple(_vector.x(), _vector.y());
180  }
181 
182 protected:
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); }
189  EigenVector _vector;
190 };
191 
195 template <typename Derived, typename T>
196 class CoordinateBase<Derived, T, 3> {
197 public:
198  typedef T Element;
199  static int const dimensions = 3;
200  typedef Eigen::Matrix<T, 3, 1, Eigen::DontAlign> EigenVector;
201  static bool constexpr IS_ELEMENT_NOTHROW_COPYABLE = std::is_nothrow_copy_constructible<T>::value;
202  static bool constexpr IS_ELEMENT_NOTHROW_ASSIGNABLE = std::is_nothrow_copy_assignable<T>::value;
203 
204  // Can't use both =default and noexcept until Eigen supports noexcept
205  CoordinateBase(CoordinateBase const& other) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
206  : _vector(other._vector) {}
207  CoordinateBase(CoordinateBase&& other) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
208  : _vector(std::move(other._vector)) {}
209  CoordinateBase& operator=(CoordinateBase const& other) noexcept(IS_ELEMENT_NOTHROW_ASSIGNABLE) {
210  _vector = other._vector;
211  return *this;
212  }
213  CoordinateBase& operator=(CoordinateBase&& other) noexcept(IS_ELEMENT_NOTHROW_ASSIGNABLE) {
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 
243  std::tuple<T, T, T> asTuple() const noexcept(IS_ELEMENT_NOTHROW_COPYABLE) {
244  return std::make_tuple(_vector.x(), _vector.y(), _vector.z());
245  }
246 
247 protected:
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); }
254  EigenVector _vector;
255 };
256 
257 template <typename Derived, typename T, int N>
258 std::ostream& operator<<(std::ostream& os, CoordinateBase<Derived, T, N> const& coordinate) {
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
Eigen::Matrix< T, 3, 1, Eigen::DontAlign > EigenVector
A CRTP base class for coordinate objects.
std::tuple< T, T, T > asTuple() const noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
Return a std::tuple representation of the coordinate object.
CoordinateBase(Eigen::MatrixBase< Vector > const &vector)
void setY(T y) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
A coordinate class intended to represent absolute positions.
table::Key< int > b
int y
Definition: SpanSet.cc:49
table::Key< int > a
STL namespace.
T const & operator[](int n) const
ImageT val
Definition: CR.cc:146
T make_tuple(T... args)
CoordinateBase & operator=(CoordinateBase const &other) noexcept(IS_ELEMENT_NOTHROW_ASSIGNABLE)
T const & coeffRef(int n) const
CoordinateBase & operator=(CoordinateBase &&other) noexcept(IS_ELEMENT_NOTHROW_ASSIGNABLE)
ItemVariant const * other
Definition: Schema.cc:56
void _swap(CoordinateBase &other) noexcept
double z
Definition: Match.cc:44
Eigen::Matrix< T, 2, 1, Eigen::DontAlign > EigenVector
CoordinateBase(Eigen::MatrixBase< Vector > const &vector)
CoordinateBase & operator=(CoordinateBase &&other) noexcept(IS_ELEMENT_NOTHROW_ASSIGNABLE)
void _swap(CoordinateBase &other) noexcept
EigenVector const & asEigen() const noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
Return a fixed-size Eigen representation of the coordinate object.
void setX(T x) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
CoordinateBase(T val=static_cast< T >(0)) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
Eigen::Matrix< T, N, 1, Eigen::DontAlign > EigenVector
std::tuple< T, T > asTuple() const noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
Return a std::tuple representation of the coordinate object.
A base class for image defects.
CoordinateBase(Eigen::MatrixBase< Vector > const &vector)
Initialize all elements from an N-d Eigen vector.
CoordinateBase(CoordinateBase const &other) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
T make_pair(T... args)
static bool constexpr IS_ELEMENT_NOTHROW_COPYABLE
A coordinate class intended to represent offsets and dimensions.
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.
T move(T... args)
bool constexpr IS_NOTHROW_CONVERTIBLE
Test that a type is nothrow-copy-convertible from U to T.
static bool constexpr IS_ELEMENT_NOTHROW_ASSIGNABLE
double x
CoordinateBase & operator=(CoordinateBase &&other) noexcept(IS_ELEMENT_NOTHROW_ASSIGNABLE)
CoordinateBase(CoordinateBase const &other) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
CoordinateBase(T val=static_cast< T >(0)) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
Initialize all elements to a scalar.
static int const dimensions
CoordinateBase(CoordinateBase const &other) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
EigenVector const & asEigen() const noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
Return a fixed-size Eigen representation of the coordinate object.
void _swap(CoordinateBase &other) noexcept
void setX(T x) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
~CoordinateBase() noexcept=default
void setY(T y) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
CoordinateBase(T val=static_cast< T >(0)) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
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 setZ(T z) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
std::ostream * os
Definition: Schema.cc:746
EigenVector const & asEigen() const noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
Return a fixed-size Eigen representation of the coordinate object.
CoordinateBase(CoordinateBase &&other) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
STL class.
CoordinateBase & operator=(CoordinateBase const &other) noexcept(IS_ELEMENT_NOTHROW_ASSIGNABLE)
CoordinateBase(CoordinateBase &&other) noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
CoordinateBase & operator=(CoordinateBase const &other) noexcept(IS_ELEMENT_NOTHROW_ASSIGNABLE)