LSSTApplications  17.0+11,17.0+113,17.0+64,18.0.0+13,18.0.0+28,18.0.0+5,18.0.0+66,18.0.0-4-g68ffd23,18.1.0-1-g0001055+8,18.1.0-1-g03d53ef+1,18.1.0-1-g1349e88+42,18.1.0-1-g2505f39+33,18.1.0-1-g5315e5e+1,18.1.0-1-g5e4b7ea+10,18.1.0-1-g7e8fceb+1,18.1.0-1-g85f8cd4+35,18.1.0-1-gd55f500+24,18.1.0-12-g42eabe8e+26,18.1.0-14-g259bd21+5,18.1.0-14-gd04256d+31,18.1.0-2-g4903023+9,18.1.0-2-g5f9922c+11,18.1.0-2-gd3b74e5+2,18.1.0-2-gfbf3545+19,18.1.0-2-gfefb8b5+30,18.1.0-20-g4b62d031a,18.1.0-21-gb3d55290+13,18.1.0-22-gcd16eb0+1,18.1.0-3-g52aa583+16,18.1.0-3-g8f4a2b1+29,18.1.0-3-gb69f684+26,18.1.0-4-g1ee41a7+1,18.1.0-5-g6dbcb01+27,18.1.0-5-gc286bb7+3,18.1.0-6-g857e778+2,18.1.0-7-gae09a6d+14,18.1.0-8-g42b2ab3+8,18.1.0-8-gc69d46e+13,18.1.0-9-gee19f03,w.2019.42
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_
Angle abs(Angle const &a)
Definition: Angle.h:106
bool operator>=(Angle const &a) const
Definition: Angle.h:65
Angle operator+(Angle const &a) const
Definition: Angle.h:69
bool isNan() const
isNan returns true if the angle value is NaN.
Definition: Angle.h:91
constexpr double DEG_PER_RAD
Definition: constants.h:39
table::Key< int > b
table::Key< int > a
std::ostream & operator<<(std::ostream &, Angle const &)
Definition: Angle.cc:34
double operator/(Angle const &a) const
Definition: Angle.h:73
double sin(Angle const &a)
Definition: Angle.h:102
Angle operator/(double a) const
Definition: Angle.h:72
bool operator==(Angle const &a) const
Definition: Angle.h:60
double cos(Angle const &a)
Definition: Angle.h:103
bool operator<=(Angle const &a) const
Definition: Angle.h:64
T sin(T... args)
This file contains common constants.
Angle operator-() const
Definition: Angle.h:68
A base class for image defects.
double asRadians() const
asRadians returns the value of this angle in units of radians.
Definition: Angle.h:85
Angle & operator-=(Angle const &a)
Definition: Angle.h:77
double asDegrees() const
asDegrees returns the value of this angle in units of degrees.
Definition: Angle.h:82
constexpr double PI
Definition: constants.h:36
static Angle fromDegrees(double a)
Definition: Angle.h:49
double tan(Angle const &a)
Definition: Angle.h:104
static Angle fromRadians(double a)
Definition: Angle.h:51
bool operator<(Angle const &a) const
Definition: Angle.h:62
T cos(T... args)
T fabs(T... args)
Angle operator-(Angle const &a) const
Definition: Angle.h:70
Angle & operator+=(Angle const &a)
Definition: Angle.h:76
static Angle nan()
Definition: Angle.h:45
Angle represents an angle in radians.
Definition: Angle.h:43
Angle & operator/=(double a)
Definition: Angle.h:79
Angle operator*(double a) const
Definition: Angle.h:71
T tan(T... args)
Angle & operator*=(double a)
Definition: Angle.h:78
T isnan(T... args)
Angle(double a)
This constructor creates an Angle with the given value in radians.
Definition: Angle.h:57
bool operator!=(Angle const &a) const
Definition: Angle.h:61
bool isNormalized() const
isNormalized returns true if this angle lies in the range [0, 2π).
Definition: Angle.h:88
STL class.
Angle()
This constructor creates an Angle with a value of zero.
Definition: Angle.h:54
bool operator>(Angle const &a) const
Definition: Angle.h:63
constexpr double RAD_PER_DEG
Definition: constants.h:38