Skip to content

Commit 0a4e44e

Browse files
authored
[wpimath] Synchronize C++ and Java RK4 docs (NFC) (#8238)
1 parent a7e7f69 commit 0a4e44e

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

wpimath/src/main/java/edu/wpi/first/math/system/NumericalIntegration.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ private NumericalIntegration() {
1919
}
2020

2121
/**
22-
* Performs Runge Kutta integration (4th order).
22+
* Performs 4th order Runge-Kutta integration of dx/dt = f(x) for dt.
2323
*
24-
* @param f The function to integrate, which takes one argument x.
24+
* @param f The function to integrate. It must take one argument x.
2525
* @param x The initial value of x.
2626
* @param dtSeconds The time over which to integrate.
2727
* @return the integration of dx/dt = f(x) for dt.
@@ -37,13 +37,13 @@ public static double rk4(DoubleUnaryOperator f, double x, double dtSeconds) {
3737
}
3838

3939
/**
40-
* Performs Runge Kutta integration (4th order).
40+
* Performs 4th order Runge-Kutta integration of dx/dt = f(x, u) for dt.
4141
*
4242
* @param f The function to integrate. It must take two arguments x and u.
4343
* @param x The initial value of x.
4444
* @param u The value u held constant over the integration period.
4545
* @param dtSeconds The time over which to integrate.
46-
* @return The result of Runge Kutta integration (4th order).
46+
* @return the integration of dx/dt = f(x, u) for dt.
4747
*/
4848
public static double rk4(DoubleBinaryOperator f, double x, double u, double dtSeconds) {
4949
final var h = dtSeconds;
@@ -89,7 +89,7 @@ public static <States extends Num, Inputs extends Num> Matrix<States, N1> rk4(
8989
* @param f The function to integrate. It must take one argument x.
9090
* @param x The initial value of x.
9191
* @param dtSeconds The time over which to integrate.
92-
* @return 4th order Runge-Kutta integration of dx/dt = f(x) for dt.
92+
* @return the integration of dx/dt = f(x) for dt.
9393
*/
9494
public static <States extends Num> Matrix<States, N1> rk4(
9595
UnaryOperator<Matrix<States, N1>> f, Matrix<States, N1> x, double dtSeconds) {

0 commit comments

Comments
 (0)