Angle.h File Reference

#include <cmath>
#include <iostream>
#include <type_traits>
#include "boost/math/constants/constants.hpp"

Go to the source code of this file.

Classes
class	lsst::geom::AngleUnit
	A class used to convert scalar POD types such as double to Angle. More...
class	lsst::geom::Angle
	A class representing an angle. More...

Namespaces
	lsst
	A base class for image defects.
	lsst::geom

Macros
#define	ANGLE_OPUP_TYPE(OP, TYPE)
#define	ANGLE_COMP(OP)   constexpr bool operator OP(const Angle& rhs) const noexcept { return _val OP rhs._val; }
#define	ANGLE_OP(OP)
#define	ANGLE_OP_TYPE(OP, TYPE)

Functions
constexpr double	lsst::geom::degToRad (double x) noexcept
constexpr double	lsst::geom::radToDeg (double x) noexcept
constexpr double	lsst::geom::radToArcsec (double x) noexcept
constexpr double	lsst::geom::radToMas (double x) noexcept
constexpr double	lsst::geom::arcsecToRad (double x) noexcept
constexpr double	lsst::geom::masToRad (double x) noexcept
constexpr Angle	lsst::geom::operator+ (Angle a, Angle d) noexcept
	Sum of two angles. More...
constexpr Angle	lsst::geom::operator- (Angle a, Angle d) noexcept
	Difference of two angles. More...
constexpr Angle	lsst::geom::operator* (Angle a, Angle d) noexcept
	Product of two angles. More...
constexpr Angle	lsst::geom::operator- (Angle angle)
	An angle in the opposite sense. More...
constexpr Angle	lsst::geom::operator/ (Angle a, int d) noexcept
	Ratio of an angle and a scalar. More...
constexpr Angle	lsst::geom::operator/ (Angle a, double d) noexcept
	Ratio of an angle and a scalar. More...
template<typename T >
constexpr double	lsst::geom::operator/ (T const lhs, Angle rhs) noexcept=delete
std::ostream &	lsst::geom::operator<< (std::ostream &s, Angle a)
	Print an Angle to a stream. More...
template<typename T >
constexpr bool	lsst::geom::isAngle (T) noexcept
	Allow a user to check if they have an angle. More...
template<typename T >
constexpr Angle	lsst::geom::operator* (T lhs, AngleUnit rhs) noexcept
	Use AngleUnit to convert a POD (e.g. int, double) to an Angle; e.g. 180*degrees. More...
constexpr Angle	lsst::geom::operator* (Angle a, double d) noexcept
	Product of an angle and a scalar. More...
constexpr Angle	lsst::geom::operator* (double d, Angle a) noexcept
	Product of an angle and a scalar. More...
constexpr Angle	lsst::geom::operator* (Angle a, int d) noexcept
	Product of an angle and a scalar. More...
constexpr Angle	lsst::geom::operator* (int d, Angle a) noexcept
	Product of an angle and a scalar. More...

Variables
double constexpr	lsst::geom::PI = boost::math::constants::pi<double>()
	The ratio of a circle's circumference to diameter. More...
double constexpr	lsst::geom::TWOPI = boost::math::constants::pi<double>() * 2.0
double constexpr	lsst::geom::HALFPI = boost::math::constants::pi<double>() * 0.5
double constexpr	lsst::geom::ONE_OVER_PI = 1.0 / boost::math::constants::pi<double>()
double const	lsst::geom::SQRTPI = sqrt(boost::math::constants::pi<double>())
double const	lsst::geom::INVSQRTPI = 1.0 / sqrt(boost::math::constants::pi<double>())
double constexpr	lsst::geom::ROOT2 = boost::math::constants::root_two<double>()
AngleUnit constexpr	lsst::geom::radians = AngleUnit(1.0)
	constant with units of radians More...
AngleUnit constexpr	lsst::geom::degrees = AngleUnit(PI / 180.0)
	constant with units of degrees More...
AngleUnit constexpr	lsst::geom::hours = AngleUnit(PI * 15.0 / 180.0)
	constant with units of hours More...
AngleUnit constexpr	lsst::geom::arcminutes = AngleUnit(PI / 60 / 180.0)
	constant with units of arcminutes More...
AngleUnit constexpr	lsst::geom::arcseconds = AngleUnit(PI / 180.0 / 3600.0)
	constant with units of arcseconds More...

Macro Definition Documentation

ANGLE_COMP

#define ANGLE_COMP

(

OP

)

constexpr bool operator OP(const Angle& rhs) const noexcept { return _val OP rhs._val; }

Definition at line 249 of file Angle.h.

ANGLE_OP

#define ANGLE_OP

(

OP

)

Value:

inline constexpr Angle operator OP(Angle a, Angle d) noexcept {     \
        return Angle(static_cast<double>(a) OP static_cast<double>(d)); \
    }

Definition at line 274 of file Angle.h.

ANGLE_OP_TYPE

#define ANGLE_OP_TYPE	(		OP,
			TYPE
	)

Value:

inline constexpr Angle operator OP(Angle a, TYPE d) noexcept { \
        return Angle(static_cast<double>(a) OP d);                 \
    }                                                              \
                                                                   \
    inline constexpr Angle operator OP(TYPE d, Angle a) noexcept { \
        return Angle(d OP static_cast<double>(a));                 \
    }

Definition at line 281 of file Angle.h.

ANGLE_OPUP_TYPE

#define ANGLE_OPUP_TYPE	(		OP,
			TYPE
	)

Value:

Angle& operator OP(TYPE const& d) noexcept { \
        _val OP d;                               \
        return *this;                            \
    }

Definition at line 225 of file Angle.h.