LSST Applications  21.0.0+3c14b91618,21.0.0+9f51b1e3f7,21.0.0-1-ga51b5d4+6691386486,21.0.0-10-g2408eff+1a328412bf,21.0.0-10-g560fb7b+52fd22d7b4,21.0.0-10-g8d1d15d+2f9043cae0,21.0.0-10-gcf60f90+d15de71c48,21.0.0-11-g25eff31+d43066e4ef,21.0.0-15-g490e301a+a676f0d5cf,21.0.0-2-g103fe59+4758c8ef83,21.0.0-2-g1367e85+a9f57e981a,21.0.0-2-g45278ab+9f51b1e3f7,21.0.0-2-g5242d73+a9f57e981a,21.0.0-2-g7f82c8f+1bcc828e4f,21.0.0-2-g8f08a60+e6fd6d9ff9,21.0.0-2-ga326454+1bcc828e4f,21.0.0-2-gde069b7+66c51b65da,21.0.0-2-gecfae73+251b9830c3,21.0.0-2-gfc62afb+a9f57e981a,21.0.0-20-g09baf175d+e1e7d1c708,21.0.0-3-g357aad2+854c3902c3,21.0.0-3-g4be5c26+a9f57e981a,21.0.0-3-g65f322c+feaa1990e9,21.0.0-3-g7d9da8d+3c14b91618,21.0.0-3-ge02ed75+bda8df9b93,21.0.0-4-g591bb35+bda8df9b93,21.0.0-4-g65b4814+52fd22d7b4,21.0.0-4-g88306b8+656365ce3f,21.0.0-4-gccdca77+86bf7a300d,21.0.0-4-ge8a399c+b99e86088e,21.0.0-5-gd00fb1e+6a0dc09319,21.0.0-51-gd3b42663+bf9f0d1c8b,21.0.0-6-g2d4f3f3+9f51b1e3f7,21.0.0-7-g04766d7+ee2ae02087,21.0.0-7-g98eecf7+3609eddee2,21.0.0-7-gde99fe0+bda8df9b93,21.0.0-8-gd70ce6f+79e45e76e4,master-gac4afde19b+bda8df9b93,w.2021.10
LSST Data Management Base Package
Angle.h
Go to the documentation of this file.
1 /*
2  * LSST Data Management System
3  * Copyright 2014-2015 AURA/LSST.
4  *
5  * This product includes software developed by the
6  * LSST Project (http://www.lsst.org/).
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 LSST License Statement and
19  * the GNU General Public License along with this program. If not,
20  * see <https://www.lsstcorp.org/LegalNotices/>.
21  */
22 
23 #ifndef LSST_SPHGEOM_ANGLE_H_
24 #define LSST_SPHGEOM_ANGLE_H_
25 
28 
29 #include <cmath>
30 #include <algorithm>
31 #include <iosfwd>
32 #include <limits>
33 
34 #include "constants.h"
35 
36 
37 namespace lsst {
38 namespace sphgeom {
39 
43 class Angle {
44 public:
45  static Angle nan() {
47  }
48 
49  static Angle fromDegrees(double a) { return Angle(a * RAD_PER_DEG); }
50 
51  static Angle fromRadians(double a) { return Angle(a); }
52 
54  Angle() : _rad(0.0) {}
55 
57  explicit Angle(double a) : _rad(a) {}
58 
59  // Comparison operators
60  bool operator==(Angle const & a) const { return _rad == a._rad; }
61  bool operator!=(Angle const & a) const { return _rad != a._rad; }
62  bool operator<(Angle const & a) const { return _rad < a._rad; }
63  bool operator>(Angle const & a) const { return _rad > a._rad; }
64  bool operator<=(Angle const & a) const { return _rad <= a._rad; }
65  bool operator>=(Angle const & a) const { return _rad >= a._rad; }
66 
67  // Arithmetic operators
68  Angle operator-() const { return Angle(-_rad); }
69  Angle operator+(Angle const & a) const { return Angle(_rad + a._rad); }
70  Angle operator-(Angle const & a) const { return Angle(_rad - a._rad); }
71  Angle operator*(double a) const { return Angle(_rad * a); }
72  Angle operator/(double a) const { return Angle(_rad / a); }
73  double operator/(Angle const & a) const { return _rad / a._rad; }
74 
75  // In-place arithmetic operators
76  Angle & operator+=(Angle const & a) { *this = *this + a; return *this; }
77  Angle & operator-=(Angle const & a) { *this = *this - a; return *this; }
78  Angle & operator*=(double a) { *this = *this * a; return *this; }
79  Angle & operator/=(double a) { *this = *this / a; return *this; }
80 
82  double asDegrees() const { return _rad * DEG_PER_RAD; }
83 
85  double asRadians() const { return _rad; }
86 
88  bool isNormalized() const { return _rad >= 0.0 && _rad <= 2.0 * PI; }
89 
91  bool isNan() const { return std::isnan(_rad); }
92 
93 private:
94  double _rad;
95 };
96 
97 
98 inline Angle operator*(double a, Angle const & b) { return b * a; }
99 
101 
102 inline double sin(Angle const & a) { return std::sin(a.asRadians()); }
103 inline double cos(Angle const & a) { return std::cos(a.asRadians()); }
104 inline double tan(Angle const & a) { return std::tan(a.asRadians()); }
105 
106 inline Angle abs(Angle const & a) { return Angle(std::fabs(a.asRadians())); }
107 
108 }} // namespace lsst::sphgeom
109 
110 #endif // LSST_SPHGEOM_ANGLE_H_
Angle represents an angle in radians.
Definition: Angle.h:43
static Angle nan()
Definition: Angle.h:45
static Angle fromDegrees(double a)
Definition: Angle.h:49
bool isNan() const
isNan returns true if the angle value is NaN.
Definition: Angle.h:91
bool isNormalized() const
isNormalized returns true if this angle lies in the range [0, 2π).
Definition: Angle.h:88
Angle operator*(double a) const
Definition: Angle.h:71
Angle operator+(Angle const &a) const
Definition: Angle.h:69
bool operator==(Angle const &a) const
Definition: Angle.h:60
bool operator<(Angle const &a) const
Definition: Angle.h:62
static Angle fromRadians(double a)
Definition: Angle.h:51
Angle(double a)
This constructor creates an Angle with the given value in radians.
Definition: Angle.h:57
Angle & operator/=(double a)
Definition: Angle.h:79
Angle()
This constructor creates an Angle with a value of zero.
Definition: Angle.h:54
double asDegrees() const
asDegrees returns the value of this angle in units of degrees.
Definition: Angle.h:82
Angle & operator+=(Angle const &a)
Definition: Angle.h:76
double operator/(Angle const &a) const
Definition: Angle.h:73
Angle operator-() const
Definition: Angle.h:68
Angle operator/(double a) const
Definition: Angle.h:72
bool operator>=(Angle const &a) const
Definition: Angle.h:65
Angle operator-(Angle const &a) const
Definition: Angle.h:70
Angle & operator-=(Angle const &a)
Definition: Angle.h:77
bool operator>(Angle const &a) const
Definition: Angle.h:63
Angle & operator*=(double a)
Definition: Angle.h:78
bool operator<=(Angle const &a) const
Definition: Angle.h:64
double asRadians() const
asRadians returns the value of this angle in units of radians.
Definition: Angle.h:85
bool operator!=(Angle const &a) const
Definition: Angle.h:61
T cos(T... args)
T fabs(T... args)
T isnan(T... args)
lsst::geom::Angle Angle
Definition: misc.h:33
Angle abs(Angle const &a)
Definition: Angle.h:106
constexpr double DEG_PER_RAD
Definition: constants.h:39
std::ostream & operator<<(std::ostream &, Angle const &)
Definition: Angle.cc:34
double sin(Angle const &a)
Definition: Angle.h:102
constexpr double RAD_PER_DEG
Definition: constants.h:38
double tan(Angle const &a)
Definition: Angle.h:104
double cos(Angle const &a)
Definition: Angle.h:103
Angle operator*(double a, Angle const &b)
Definition: Angle.h:98
constexpr double PI
Definition: constants.h:36
A base class for image defects.
T sin(T... args)
This file contains common constants.
table::Key< int > b
table::Key< int > a
T tan(T... args)