Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-06-23 01:21:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

[wpimath] Replace pi with symbol in docs (#7322)

Browse Source
This commit is contained in:
Tyler Veness
2024-11-01 17:16:18 -07:00
committed by GitHub
parent 2cfe114c78
commit dfd1084526
6 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
wpimath/src/main/native/include/frc/MathUtil.h
View File

@@ -159,7 +159,7 @@ constexpr bool IsNear(T expected, T actual, T tolerance, T min, T max) {
}
/**
* Wraps an angle to the range -pi to pi radians (-180 to 180 degrees).
* Wraps an angle to the range -π to π radians (-180 to 180 degrees).
*
* @param angle Angle to wrap.
*/

4
wpimath/src/main/native/include/frc/filter/LinearFilter.h
View File

@@ -118,7 +118,7 @@ class LinearFilter {
* y[n] = (1 - gain) x[n] + gain y[n-1]<br>
* where gain = e<sup>-dt / T</sup>, T is the time constant in seconds
*
* Note: T = 1 / (2 pi f) where f is the cutoff frequency in Hz, the frequency
* Note: T = 1 / (2πf) where f is the cutoff frequency in Hz, the frequency
* above which the input starts to attenuate.
*
* This filter is stable for time constants greater than zero.
@@ -138,7 +138,7 @@ class LinearFilter {
* y[n] = gain x[n] + (-gain) x[n-1] + gain y[n-1]<br>
* where gain = e<sup>-dt / T</sup>, T is the time constant in seconds
*
* Note: T = 1 / (2 pi f) where f is the cutoff frequency in Hz, the frequency
* Note: T = 1 / (2πf) where f is the cutoff frequency in Hz, the frequency
* below which the input starts to attenuate.
*
* This filter is stable for time constants greater than zero.

6
wpimath/src/main/native/include/frc/geometry/Rotation2d.h
View File

@@ -67,8 +67,8 @@ class WPILIB_DLLEXPORT Rotation2d {
}
/**
* Adds two rotations together, with the result being bounded between -pi and
* pi.
* Adds two rotations together, with the result being bounded between -π and
* π.
*
* For example, <code>Rotation2d{30_deg} + Rotation2d{60_deg}</code> equals
* <code>Rotation2d{units::radian_t{std::numbers::pi/2.0}}</code>
@@ -158,7 +158,7 @@ class WPILIB_DLLEXPORT Rotation2d {
* Returns the radian value of the rotation.
*
* @return The radian value of the rotation.
* @see AngleModulus to constrain the angle within (-pi, pi]
* @see AngleModulus to constrain the angle within (-π, π]
*/
constexpr units::radian_t Radians() const { return m_value; }