Skip to content

Commit

Permalink
Fix typographical errors in documentation files.
Browse files Browse the repository at this point in the history
  • Loading branch information
fbriol committed Oct 29, 2024
1 parent ddcebaa commit 24759cc
Show file tree
Hide file tree
Showing 5 changed files with 49 additions and 48 deletions.
6 changes: 3 additions & 3 deletions include/fes/detail/angle/astronomic/frequency.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -36,23 +36,23 @@ constexpr auto p() noexcept -> double {
return 1.0 / ((15.0 / speed::p()) * 24.0);
}

/// @brief N′
/// @brief \f$N'\f$
///
/// Compute the frequency in degree by hour for the longitude of the moon's
/// ascending node.
constexpr auto n() noexcept -> double {
return 1.0 / ((15.0 / speed::n()) * 24.0);
}

/// @brief p₁
/// @brief \f$p_1\f$
///
/// Compute the frequency in degree by hour for the longitude of sun's
/// perigee.
constexpr auto p1() noexcept -> double {
return 1.0 / ((15.0 / speed::p1()) * 24.0);
}

/// @brief τ
/// @brief \f$\tau\f$
///
/// Compute the frequency in degree by hour for the local mean lunar time.
constexpr auto tau() noexcept -> double {
Expand Down
6 changes: 3 additions & 3 deletions include/fes/detail/angle/astronomic/speed.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -36,23 +36,23 @@ constexpr auto p() noexcept -> double {
return (((11.0 * 360.0 + 109.032) / kJulianCentury)) * 3600.0;
}

/// @brief N′
/// @brief \f$N'\f$
///
/// Compute the speed in degree by hour for the longitude of moon's ascending
/// node.
constexpr auto n() noexcept -> double {
return (((-5.0 * 360.0 - 134.142) / kJulianCentury)) * 3600.0;
}

/// @brief p₁
/// @brief \f$p_1\f$
///
/// Compute the speed in degree by hour for the longitude of sun's
/// perigee.
constexpr auto p1() noexcept -> double {
return ((1.719 / kJulianCentury)) * 3600;
}

/// @brief τ
/// @brief \f$\tau\f$
///
/// Compute the speed in degree by hour for the local mean lunar time.
constexpr auto tau() noexcept -> double { return 15.0 - s() + h(); }
Expand Down
16 changes: 8 additions & 8 deletions include/fes/detail/math.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -26,39 +26,39 @@ namespace fes {
namespace detail {
namespace math {

/// π
/// \f$\pi\f$
///
/// @tparam T The type of the result.
/// @return π
/// @return \f$\pi\f$
template <typename T>
constexpr auto pi() noexcept -> T {
return std::atan2(T(0), T(-1));
}

/// π/2
/// \f$\pi/2\f$
///
/// @tparam T The type of the result.
/// @return π/2
/// @return \f$\pi/2\f$
template <typename T>
constexpr auto pi_2() noexcept -> T {
return 0.5 * pi<T>();
}

///
/// \f$2\pi\f$
///
/// @tparam T The type of the result.
/// @return
/// @return \f$2\pi\f$
template <typename T>
constexpr auto two_pi() noexcept -> T {
return T(2) * pi<T>();
}

/// @brief Evaluate x^n
/// @brief Evaluate \f$x^n\f$
/// @tparam T The type of the number.
/// @tparam N The power to raise the number to.
template <typename T, unsigned N>
struct Power {
/// @brief Evaluate x^n
/// @brief Evaluate \f$x^n\f$
///
/// @param[in] x The number to raise to the power.
/// @return The result of raising the number to the power.
Expand Down
6 changes: 3 additions & 3 deletions include/fes/geometry/triangle.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -125,11 +125,11 @@ class Triangle : public triangle_t {
return boost::geometry::equals(*this, other);
}

/// Compute the angles ξ and η of the reference right-angled triangle in the
/// Cartesian space.
/// Compute the angles \f$\xi\$f and \f$\eta\$f of the reference right-angled
/// triangle in the Cartesian space.
///
/// @param[in] point The point.
/// @return A tuple containing the angles ξ and η.
/// @return A tuple containing the angles \f$\xi\$f and \f$\eta\$f.
/// @warning The given point must be inside the triangle otherwise the result
/// is undefined.
auto reference_right_angled(const Point &point) const
Expand Down
63 changes: 32 additions & 31 deletions include/fes/wave.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,8 @@ class Wave : public std::enable_shared_from_this<Wave> {
/// Tide value.
std::complex<double> c_;

/// Harmonic constituents (T, s, h, p, N′, p_1, shift, \xi, \nu, \nu′, \nu″)
/// Harmonic constituents
/// \f$(T, s, h, p, N', p_1, shift, \xi, \nu, \nu', \nu'')\f$
std::array<int8_t, 11> argument_;

/// Computes the wave frequency from the doodson arguments
Expand Down Expand Up @@ -307,7 +308,7 @@ class Sa : public Wave {
///
/// <table>
/// <tr><th>V</th><th>u</th><th>Factor-f</th></tr>
/// <tr><td>@f$T - 4s + h + 2p + 90°@f$</td>
/// <tr><td>@f$T - 4s + h + 2p + 90^{\circ}@f$</td>
/// <td>@f$+2\xi - \nu@f$</td>
/// <td>@f$f(O_1)@f$</td></tr>
/// </table>
Expand All @@ -323,7 +324,7 @@ class _2Q1 : public Wave {
///
/// <table>
/// <tr><th>V</th><th>u</th><th>Factor-f</th></tr>
/// <tr><td>@f$T - 4s + 3h + 90°@f$</td>
/// <tr><td>@f$T - 4s + 3h + 90^{\circ}@f$</td>
/// <td>@f$+2\xi - \nu@f$</td>
/// <td>@f$f(O_1)@f$</td></tr>
/// </table>
Expand All @@ -339,7 +340,7 @@ class Sigma1 : public Wave {
///
/// <table>
/// <tr><th>V</th><th>u</th><th>Factor-f</th></tr>
/// <tr><td>@f$T - 3s + h + p + 90°@f$</td>
/// <tr><td>@f$T - 3s + h + p + 90^{\circ}@f$</td>
/// <td>@f$+2\xi - \nu@f$</td>
/// <td>@f$f(O_1)@f$</td></tr>
/// </table>
Expand All @@ -355,7 +356,7 @@ class Q1 : public Wave {
///
/// <table>
/// <tr><th>V</th><th>u</th><th>Factor-f</th></tr>
/// <tr><td>@f$T - 3s + 3h - p + 90°@f$</td>
/// <tr><td>@f$T - 3s + 3h - p + 90^{\circ}@f$</td>
/// <td>@f$+2\xi - \nu@f$</td>
/// <td>@f$f(O_1)@f$</td></tr>
/// </table>
Expand All @@ -371,7 +372,7 @@ class Rho1 : public Wave {
///
/// <table>
/// <tr><th>V</th><th>u</th><th>Factor-f</th></tr>
/// <tr><td>@f$T - 2s + h + 90°@f$</td>
/// <tr><td>@f$T - 2s + h + 90^{\circ}@f$</td>
/// <td>@f$+2\xi - \nu@f$</td>
/// <td>@f$f(O_1)@f$</td></tr>
/// </table>
Expand All @@ -387,7 +388,7 @@ class O1 : public Wave {
///
/// <table>
/// <tr><th>V</th><th>u</th><th>Factor-f</th></tr>
/// <tr><td>@f$T - 2s + 3h - 90°@f$</td>
/// <tr><td>@f$T - 2s + 3h - 90^{\circ}@f$</td>
/// <td>@f$-\nu@f$</td>
/// <td>@f$f(J_1)@f$</td></tr>
/// </table>
Expand All @@ -403,7 +404,7 @@ class MP1 : public Wave {
///
/// <table>
/// <tr><th>V</th><th>u</th><th>Factor-f</th></tr>
/// <tr><td>@f$T - s + h - p - 90°@f$</td>
/// <tr><td>@f$T - s + h - p - 90^{\circ}@f$</td>
/// <td>@f$+2\xi - \nu@f$</td>
/// <td>@f$f(O_1)@f$</td></tr>
/// </table>
Expand Down Expand Up @@ -443,7 +444,7 @@ class M13 : public Wave {
///
/// <table>
/// <tr><th>V</th><th>u</th><th>Factor-f</th></tr>
/// <tr><td>@f$T - s + h + p - 90°@f$</td>
/// <tr><td>@f$T - s + h + p - 90^{\circ}@f$</td>
/// <td>@f$-\nu@f$</td>
/// <td>@f$f(J_1)@f$</td></tr>
/// </table>
Expand All @@ -459,7 +460,7 @@ class M11 : public Wave {
///
/// <table>
/// <tr><th>V</th><th>u</th><th>Factor-f</th></tr>
/// <tr><td>@f$T - s + 3h - p - 90°@f$</td>
/// <tr><td>@f$T - s + 3h - p - 90^{\circ}@f$</td>
/// <td>@f$-\nu@f$</td>
/// <td>@f$f(J_1)@f$</td></tr>
/// </table>
Expand All @@ -475,7 +476,7 @@ class Chi1 : public Wave {
///
/// <table>
/// <tr><th>V</th><th>u</th><th>Factor-f</th></tr>
/// <tr><td>@f$T - 2h + p1 + 90°@f$</td>
/// <tr><td>@f$T - 2h + p1 + 90^{\circ}@f$</td>
/// <td>@f$0@f$</td>
/// <td>@f$1@f$</td></tr>
/// </table>
Expand All @@ -491,7 +492,7 @@ class Pi1 : public Wave {
///
/// <table>
/// <tr><th>V</th><th>u</th><th>Factor-f</th></tr>
/// <tr><td>@f$T - h + 90°@f$</td>
/// <tr><td>@f$T - h + 90^{\circ}@f$</td>
/// <td>@f$0@f$</td>
/// <td>@f$1@f$</td></tr>
/// </table>
Expand Down Expand Up @@ -523,7 +524,7 @@ class S1 : public Wave {
///
/// <table>
/// <tr><th>V</th><th>u</th><th>Factor-f</th></tr>
/// <tr><td>@f$T + h - 90°@f$</td>
/// <tr><td>@f$T + h - 90^{\circ}@f$</td>
/// <td>@f$- \nu@f$</td>
/// <td>@f$f(K_1)@f$</td></tr>
/// </table>
Expand All @@ -539,7 +540,7 @@ class K1 : public Wave {
///
/// <table>
/// <tr><th>V</th><th>u</th><th>Factor-f</th></tr>
/// <tr><td>@f$T + 2h - p1 - 90°@f$</td>
/// <tr><td>@f$T + 2h - p1 - 90^{\circ}@f$</td>
/// <td>@f$0@f$</td>
/// <td>@f$1@f$</td></tr>
/// </table>
Expand All @@ -555,7 +556,7 @@ class Psi1 : public Wave {
///
/// <table>
/// <tr><th>V</th><th>u</th><th>Factor-f</th></tr>
/// <tr><td>@f$T + 3h - 90°@f$</td>
/// <tr><td>@f$T + 3h - 90^{\circ}@f$</td>
/// <td>@f$0@f$</td>
/// <td>@f$1@f$</td></tr>
/// </table>
Expand All @@ -571,7 +572,7 @@ class Phi1 : public Wave {
///
/// <table>
/// <tr><th>V</th><th>u</th><th>Factor-f</th></tr>
/// <tr><td>@f$T + s - h + p - 90°@f$</td>
/// <tr><td>@f$T + s - h + p - 90^{\circ}@f$</td>
/// <td>@f$-\nu@f$</td>
/// <td>@f$f(J_1)@f$</td></tr>
/// </table>
Expand All @@ -587,7 +588,7 @@ class Theta1 : public Wave {
///
/// <table>
/// <tr><th>V</th><th>u</th><th>Factor-f</th></tr>
/// <tr><td>@f$T + s + h - p - 90°@f$</td>
/// <tr><td>@f$T + s + h - p - 90^{\circ}@f$</td>
/// <td>@f$-\nu@f$</td>
/// <td>@f$f(J_1)@f$</td></tr>
/// </table>
Expand All @@ -603,7 +604,7 @@ class J1 : public Wave {
///
/// <table>
/// <tr><th>V</th><th>u</th><th>Factor-f</th></tr>
/// <tr><td>@f$T + 2s + h - 90°@f$</td>
/// <tr><td>@f$T + 2s + h - 90^{\circ}@f$</td>
/// <td>@f$-2\xi - \nu@f$</td>
/// <td>@f$f(OO_1)@f$</td></tr>
/// </table>
Expand Down Expand Up @@ -747,7 +748,7 @@ class M2 : public Wave {
/// <tr><th>V</th><th>u</th><th>Factor-f</th></tr>
/// <tr><td>@f$2T - 2s + 4h@f$</td>
/// <td>@f$+2\xi - 2\nu -2\nu^{\prime \prime}@f$</td>
/// <td>@f$f(M_2) × f(K_2)@f$</td></tr>
/// <td>@f$f(M_2) ^times f(K_2)@f$</td></tr>
/// </table>
class MKS2 : public Wave {
public:
Expand All @@ -760,7 +761,7 @@ class MKS2 : public Wave {
///
/// <table>
/// <tr><th>V</th><th>u</th><th>Factor-f</th></tr>
/// <tr><td>@f$2T - s + p + 180°@f$</td>
/// <tr><td>@f$2T - s + p + 180^{\circ}@f$</td>
/// <td>@f$+2\xi - 2\nu@f$</td>
/// <td>@f$f(M_2)@f$</td></tr>
/// </table>
Expand All @@ -776,7 +777,7 @@ class Lambda2 : public Wave {
///
/// <table>
/// <tr><th>V</th><th>u</th><th>Factor-f</th></tr>
/// <tr><td>@f$2T - s + 2h - p + 180°@f$</td>
/// <tr><td>@f$2T - s + 2h - p + 180^{\circ}@f$</td>
/// <td>@f$+2\xi - 2\nu - R@f$</td>
/// <td>@f$f(L_2)@f$</td></tr>
/// </table>
Expand All @@ -800,7 +801,7 @@ class L2 : public Wave {
///
/// <table>
/// <tr><th>V</th><th>u</th><th>Factor-f</th></tr>
/// <tr><td>@f$2T - s + 2h - p + 180°@f$</td>
/// <tr><td>@f$2T - s + 2h - p + 180^{\circ}@f$</td>
/// <td>@f$+2\xi - 2\nu@f$</td>
/// <td>@f$f(M_2)^3@f$</td></tr>
/// </table>
Expand Down Expand Up @@ -847,7 +848,7 @@ class S2 : public Wave {
///
/// <table>
/// <tr><th>V</th><th>u</th><th>Factor-f</th></tr>
/// <tr><td>@f$2T + h - p1 + 180°@f$</td>
/// <tr><td>@f$2T + h - p1 + 180^{\circ}@f$</td>
/// <td>@f$0@f$</td>
/// <td>@f$1@f$</td></tr>
/// </table>
Expand Down Expand Up @@ -925,9 +926,9 @@ class _2SM2 : public Wave {
///
/// <table>
/// <tr><th>V</th><th>u</th><th>Factor-f</th></tr>
/// <tr><td>@f$3T - 4s + 3h + 90°@f$</td>
/// <tr><td>@f$3T - 4s + 3h + 90^{\circ}@f$</td>
/// <td>@f$4\xi - 3\nu@f$</td>
/// <td>@f$f(M_2) × f(O_1)@f$</td></tr>
/// <td>@f$f(M_2) ^times f(O_1)@f$</td></tr>
/// </table>
class MO3 : public Wave {
public:
Expand All @@ -940,9 +941,9 @@ class MO3 : public Wave {
///
/// <table>
/// <tr><th>V</th><th>u</th><th>Factor-f</th></tr>
/// <tr><td>@f$3T - 4s + 3h + 90°@f$</td>
/// <tr><td>@f$3T - 4s + 3h + 90^{\circ}@f$</td>
/// <td>@f$4\xi - 4\nu + \nu^{\prime}@f$</td>
/// <td>@f$f(M_2)² × f(K_1)@f$</td></tr>
/// <td>@f$f(M_2)^2 ^times f(K_1)@f$</td></tr>
/// </table>
class _2MK3 : public Wave {
public:
Expand Down Expand Up @@ -971,9 +972,9 @@ class M3 : public Wave {
///
/// <table>
/// <tr><th>V</th><th>u</th><th>Factor-f</th></tr>
/// <tr><td>@f$3T - 2s + 3h - 90°@f$</td>
/// <tr><td>@f$3T - 2s + 3h - 90^{\circ}@f$</td>
/// <td>@f$2\xi - 2\nu - \nu^{\prime}@f$</td>
/// <td>@f$f(M_2) × f(K_1)@f$</td></tr>
/// <td>@f$f(M_2) ^times f(K_1)@f$</td></tr>
/// </table>
class MK3 : public Wave {
public:
Expand Down Expand Up @@ -1183,7 +1184,7 @@ class _2MS6 : public Wave {
/// <tr><th>V</th><th>u</th><th>Factor-f</th></tr>
/// <tr><td>@f$6T - 4s + 6h@f$</td>
/// <td>@f$4\xi - 4\nu - 2\nu^{\prime \prime}@f$</td>
/// <td>@f$f(M_2)² × f(K_2)@f$</td></tr>
/// <td>@f$f(M_2)^2 ^times f(K_2)@f$</td></tr>
/// </table>
class _2MK6 : public Wave {
public:
Expand Down Expand Up @@ -1213,7 +1214,7 @@ class _2SM6 : public Wave {
/// <tr><th>V</th><th>u</th><th>Factor-f</th></tr>
/// <tr><td>@f$6T - 2s + 4h@f$</td>
/// <td>@f$2\xi - 2\nu - 2\nu^{\prime}@f$</td>
/// <td>@f$f(M_2) × f(K_2)@f$</td></tr>
/// <td>@f$f(M_2) ^times f(K_2)@f$</td></tr>
/// </table>
class MSK6 : public Wave {
public:
Expand Down

0 comments on commit 24759cc

Please sign in to comment.