[wpimath] Fix docs for DARE ABQRN stabilizability check (NFC) (#5579)

This commit is contained in:
Tyler Veness
2023-08-28 15:10:42 -07:00
committed by GitHub
parent 360fb835f4
commit e322ab8e46
3 changed files with 6 additions and 6 deletions

View File

@@ -213,7 +213,7 @@ performance. The solver may hang if any of the following occur:
<ul>
<li>Q NR⁻¹Nᵀ isn't symmetric positive semidefinite</li>
<li>R isn't symmetric positive definite</li>
<li>The (A, B) pair isn't stabilizable</li>
<li>The (A BR⁻¹Nᵀ, B) pair isn't stabilizable</li>
<li>The (A, C) pair where Q = CᵀC isn't detectable</li>
</ul>
Only use this function if you're sure the preconditions are met.
@@ -336,7 +336,7 @@ J = Σ [uₖ] [0 R][uₖ] ΔT
@throws std::invalid_argument if Q NR⁻¹Nᵀ isn't symmetric positive
semidefinite.
@throws std::invalid_argument if R isn't symmetric positive definite.
@throws std::invalid_argument if the (A, B) pair isn't stabilizable.
@throws std::invalid_argument if the (A BR⁻¹Nᵀ, B) pair isn't stabilizable.
@throws std::invalid_argument if the (A, C) pair where Q = CᵀC isn't detectable.
*/
template <int States, int Inputs>