LSSTApplications  19.0.0-14-gb0260a2+1b4fc4249b,20.0.0+19029f0d82,20.0.0+66077e84be,20.0.0+b8df9e862d,20.0.0+e2e26847c2,20.0.0+e47e9b3a81,20.0.0-1-g253301a+19029f0d82,20.0.0-1-g2b7511a+46a6078777,20.0.0-1-g3dda6ea+905cef1a44,20.0.0-1-g4d801e7+5fcfd52d2e,20.0.0-1-g5b95a8c+19889959e1,20.0.0-1-gc96f8cb+d5e4df5959,20.0.0-1-gedffbd8+6ca2c30637,20.0.0-10-g0891cd99+caa8c2603a,20.0.0-13-gad96b2d30+614f89f815,20.0.0-17-gcdbda88+2b141d441d,20.0.0-2-g4dae9ad+d5e4df5959,20.0.0-2-g52fdb94+046030bafd,20.0.0-2-g61b8584+85c46248f3,20.0.0-2-g8177d33+f2ab36af31,20.0.0-2-gb780d76+f45b7d88f4,20.0.0-2-gf072044+19029f0d82,20.0.0-22-gdf434b7+d5e4df5959,20.0.0-23-g10eeb28+452d7a9290,20.0.0-23-g8900aa8+a8b4322b0e,20.0.0-3-g1653f94+85c46248f3,20.0.0-3-g4cc78c6+63636aeed8,20.0.0-3-g750bffe+7a989609f2,20.0.0-3-gbd60e8c+ff10c6d78d,20.0.0-33-g078e64d5+a2256d2c79,20.0.0-4-g97dc21a+a8b4322b0e,20.0.0-4-gfea843c+f45b7d88f4,20.0.0-5-g357b56b+f45b7d88f4,20.0.0-6-g9a5b7a1+3d4d12ed4e,20.0.0-61-g4de25fb+ddf3488217,20.0.0-7-gcda7bf1+dffc53c16b,w.2020.44
LSSTDataManagementBasePackage
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_
lsst::sphgeom::Angle::operator/
double operator/(Angle const &a) const
Definition: Angle.h:73
std::tan
T tan(T... args)
lsst::sphgeom::Angle::operator*=
Angle & operator*=(double a)
Definition: Angle.h:78
lsst::sphgeom::sin
double sin(Angle const &a)
Definition: Angle.h:102
lsst::sphgeom::PI
constexpr double PI
Definition: constants.h:36
std::fabs
T fabs(T... args)
lsst::sphgeom::Angle::Angle
Angle()
This constructor creates an Angle with a value of zero.
Definition: Angle.h:54
lsst::sphgeom::Angle::operator+
Angle operator+(Angle const &a) const
Definition: Angle.h:69
lsst::sphgeom::Angle::operator<
bool operator<(Angle const &a) const
Definition: Angle.h:62
lsst::sphgeom::Angle::asRadians
double asRadians() const
asRadians returns the value of this angle in units of radians.
Definition: Angle.h:85
std::cos
T cos(T... args)
lsst::sphgeom::Angle::isNan
bool isNan() const
isNan returns true if the angle value is NaN.
Definition: Angle.h:91
lsst::sphgeom::abs
Angle abs(Angle const &a)
Definition: Angle.h:106
lsst::sphgeom::Angle::operator*
Angle operator*(double a) const
Definition: Angle.h:71
lsst::sphgeom::Angle::operator-
Angle operator-(Angle const &a) const
Definition: Angle.h:70
lsst::sphgeom::RAD_PER_DEG
constexpr double RAD_PER_DEG
Definition: constants.h:38
lsst::sphgeom::Angle::nan
static Angle nan()
Definition: Angle.h:45
constants.h
This file contains common constants.
std::isnan
T isnan(T... args)
lsst::sphgeom::Angle::operator>
bool operator>(Angle const &a) const
Definition: Angle.h:63
lsst::afw::table::Angle
lsst::geom::Angle Angle
Definition: misc.h:33
lsst::sphgeom::Angle::operator!=
bool operator!=(Angle const &a) const
Definition: Angle.h:61
std::ostream
STL class.
lsst::sphgeom::Angle::operator+=
Angle & operator+=(Angle const &a)
Definition: Angle.h:76
lsst::sphgeom::tan
double tan(Angle const &a)
Definition: Angle.h:104
lsst::sphgeom::Angle::isNormalized
bool isNormalized() const
isNormalized returns true if this angle lies in the range [0, 2π).
Definition: Angle.h:88
lsst::sphgeom::Angle::fromRadians
static Angle fromRadians(double a)
Definition: Angle.h:51
lsst::sphgeom::Angle::operator-=
Angle & operator-=(Angle const &a)
Definition: Angle.h:77
lsst::sphgeom::Angle::operator-
Angle operator-() const
Definition: Angle.h:68
lsst::sphgeom::Angle::operator>=
bool operator>=(Angle const &a) const
Definition: Angle.h:65
b
table::Key< int > b
Definition: TransmissionCurve.cc:467
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
std::sin
T sin(T... args)
lsst::sphgeom::DEG_PER_RAD
constexpr double DEG_PER_RAD
Definition: constants.h:39
lsst::sphgeom::Angle::Angle
Angle(double a)
This constructor creates an Angle with the given value in radians.
Definition: Angle.h:57
lsst::sphgeom::operator*
Angle operator*(double a, Angle const &b)
Definition: Angle.h:98
a
table::Key< int > a
Definition: TransmissionCurve.cc:466
lsst::sphgeom::Angle::asDegrees
double asDegrees() const
asDegrees returns the value of this angle in units of degrees.
Definition: Angle.h:82
lsst::sphgeom::Angle::operator==
bool operator==(Angle const &a) const
Definition: Angle.h:60
lsst::sphgeom::Angle::operator<=
bool operator<=(Angle const &a) const
Definition: Angle.h:64
lsst::sphgeom::Angle
Angle represents an angle in radians.
Definition: Angle.h:43
lsst::sphgeom::operator<<
std::ostream & operator<<(std::ostream &, Angle const &)
Definition: Angle.cc:34
lsst::sphgeom::Angle::fromDegrees
static Angle fromDegrees(double a)
Definition: Angle.h:49
std::numeric_limits
lsst::sphgeom::Angle::operator/=
Angle & operator/=(double a)
Definition: Angle.h:79
lsst::sphgeom::Angle::operator/
Angle operator/(double a) const
Definition: Angle.h:72
lsst::sphgeom::cos
double cos(Angle const &a)
Definition: Angle.h:103