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

[wpimath] Add more docs to SimulatedAnnealing (NFC) (#6054)

Browse Source
This commit is contained in:
Tyler Veness
2023-12-16 11:03:54 -08:00
committed by GitHub
parent ab15dae887
commit 0b4c6a1546
2 changed files with 13 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
wpimath/src/main/java/edu/wpi/first/math/optimization/SimulatedAnnealing.java
View File

@@ -10,6 +10,12 @@ import java.util.function.ToDoubleFunction;
/**
* An implementation of the Simulated Annealing stochastic nonlinear optimization method.
*
* <p>Solving optimization problems involves tweaking decision variables to try to minimize some
* cost function. Simulated annealing is good for solving optimization problems with many local
* minima and a very large search space (it’s a heuristic solver rather than an exact solver like,
* say, SQP or interior-point method). Simulated annealing is a popular choice for solving the
* traveling salesman problem (see {@link edu.wpi.first.math.path.TravelingSalesman}).
*
* @see <a
* href="https://en.wikipedia.org/wiki/Simulated_annealing">https://en.wikipedia.org/wiki/Simulated_annealing</a>
* @param <State> The type of the state to optimize.