Antkeeper  0.0.1
angles.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2023 Christopher J. Howard
3  *
4  * This file is part of Antkeeper source code.
5  *
6  * Antkeeper source code is free software: you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation, either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * Antkeeper source code is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with Antkeeper source code. If not, see <http://www.gnu.org/licenses/>.
18  */
19 
20 #ifndef ANTKEEPER_MATH_ANGLES_HPP
21 #define ANTKEEPER_MATH_ANGLES_HPP
22 
23 #include <engine/math/numbers.hpp>
24 #include <cmath>
25 
26 namespace math {
27 
35 template <class T>
36 [[nodiscard]] inline constexpr T degrees(T radians) noexcept
37 {
38  return radians * rad2deg<T>;
39 }
40 
47 template <class T>
48 [[nodiscard]] inline constexpr T radians(T degrees) noexcept
49 {
50  return degrees * deg2rad<T>;
51 }
52 
59 template <class T>
60 [[nodiscard]] inline constexpr T wrap_degrees(T degrees)
61 {
62  return std::remainder(degrees, T(360));
63 }
64 
71 template <class T>
72 [[nodiscard]] inline constexpr T wrap_radians(T radians)
73 {
74  return std::remainder(radians, two_pi<T>);
75 }
76 
77 } // namespace math
78 
79 #endif // ANTKEEPER_MATH_ANGLES_HPP
Mathematical functions and data types.
Definition: angles.hpp:26
constexpr T wrap_degrees(T degrees)
Wraps an angle to [-180, 180].
Definition: angles.hpp:60
constexpr T radians(T degrees) noexcept
Converts an angle given in degrees to radians.
Definition: angles.hpp:48
constexpr T degrees(T radians) noexcept
Converts an angle from radians to degrees.
Definition: angles.hpp:36
constexpr T wrap_radians(T radians)
Wraps an angle to [-pi, pi].
Definition: angles.hpp:72