NormalizedAngle.h

Go to the documentation of this file.

/*
 * This file is part of sphgeom.
 *
 * Developed for the LSST Data Management System.
 * This product includes software developed by the LSST Project
 * (http://www.lsst.org).
 * See the COPYRIGHT file at the top-level directory of this distribution
 * for details of code ownership.
 *
 * This software is dual licensed under the GNU General Public License and also
 * under a 3-clause BSD license. Recipients may choose which of these licenses
 * to use; please see the files gpl-3.0.txt and/or bsd_license.txt,
 * respectively.  If you choose the GPL option then the following text applies
 * (but note that there is still no warranty even if you opt for BSD instead):
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef LSST_SPHGEOM_NORMALIZEDANGLE_H_
#define LSST_SPHGEOM_NORMALIZEDANGLE_H_

 
#include <limits>
 
#include "Angle.h"
 
 
namespace lsst {
namespace sphgeom {
 
// Forward declarations
class LonLat;
class Vector3d;

class NormalizedAngle {
public:
    static NormalizedAngle nan() {
        return NormalizedAngle(std::numeric_limits<double>::quiet_NaN());
    }
 
    static NormalizedAngle fromDegrees(double a) {
        return NormalizedAngle(a * RAD_PER_DEG);
    }
 
    static NormalizedAngle fromRadians(double a) {
        return NormalizedAngle(a);
    }

    static NormalizedAngle between(NormalizedAngle const & a,
                                   NormalizedAngle const & b);

    static NormalizedAngle center(NormalizedAngle const & a,
                                  NormalizedAngle const & b);

    NormalizedAngle() = default;

    NormalizedAngle(NormalizedAngle const & a) = default;

    explicit NormalizedAngle(Angle const & a) {
        *this = NormalizedAngle(a.asRadians());
    }

    explicit NormalizedAngle(double a) {
        // For really large |a|, the error in this reduction can exceed 2*PI
        // (because PI is only an approximation to π).
        if (a < 0.0) {
            _a = Angle(std::fmod(a, 2.0 * PI) + 2.0 * PI);
        } else if (a > 2 * PI) {
            _a = Angle(std::fmod(a, 2.0 * PI));
        } else {
            _a = Angle(a);
        }
    }

    NormalizedAngle(LonLat const &, LonLat const &);

    NormalizedAngle(Vector3d const &, Vector3d const &);

    operator Angle const & () const { return _a; }
 
    // Comparison operators
    bool operator==(Angle const & a) const { return _a == a; }
    bool operator!=(Angle const & a) const { return _a != a; }
    bool operator<(Angle const & a) const { return _a < a; }
    bool operator>(Angle const & a) const { return _a > a; }
    bool operator<=(Angle const & a) const { return _a <= a; }
    bool operator>=(Angle const & a) const { return _a >= a; }
 
    // Arithmetic operators
    Angle operator-() const { return Angle(-_a); }
    Angle operator+(Angle const & a) const { return _a + a; }
    Angle operator-(Angle const & a) const { return _a - a; }
    Angle operator*(double a) const { return _a * a; }
    Angle operator/(double a) const { return _a / a; }
    double operator/(Angle const & a) const { return _a / a; }

    double asDegrees() const { return _a.asDegrees(); }

    double asRadians() const { return _a.asRadians(); }

    bool isNan() const { return _a.isNan(); }

    NormalizedAngle getAngleTo(NormalizedAngle const & a) const {
        NormalizedAngle x;
        double d = a.asRadians() - asRadians();
        x._a = Angle((d < 0.0) ? 2.0 * PI + d : d);
        return x;
    }
 
private:
    Angle _a;
};
 
inline NormalizedAngle const & abs(NormalizedAngle const & a) { return a; }
 
}} // namespace lsst::sphgeom
 
#endif // LSST_SPHGEOM_NORMALIZEDANGLE_H_