deg_rad.h

Go to the documentation of this file.

#ifndef _RAPID_UTILS_DEG_RAD_H_
#define _RAPID_UTILS_DEG_RAD_H_

// Types for degrees and radians.
//
// Most algorithms use radians, but simply taking in arguments as doubles can be
// confusing. Using these types, an algorithm can explicitly document that it
// takes in degrees or radians:
//
// head.PanTilt(rapid::Radians(0.707), rapid::Radians(0.5));
//
// We also allow users to implicitly convert degrees to radians. For example, if
// PanTilt takes in radians, users can nonetheless pass in degrees and have the
// conversion taken care of for them:
//
// head.PanTilt(rapid::Degrees(45), rapid::Degrees(30));

namespace rapid {
class Degrees {
 public:
  explicit Degrees(double degrees);

  double value() const;

 private:
  double degrees_;
};

class Radians {
 public:
  explicit Radians(double radians);

  Radians(const Degrees& degrees);

  double value() const;

 private:
  double radians_;
};

}  // namespace rapid

#endif  // _RAPID_UTILS_DEG_RAD_H_