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

[docs] Add missing JavaDocs (#6125)

Browse Source
This commit is contained in:
Tyler Veness
2024-01-01 22:56:23 -08:00
committed by GitHub
parent 5579219716
commit ad0859a8c9
137 changed files with 1202 additions and 204 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
wpimath/src/main/native/include/frc/StateSpaceUtil.h
View File

@@ -194,8 +194,8 @@ Eigen::Vector4d PoseTo4dVector(const Pose2d& pose);
* any, have absolute values less than one, where an eigenvalue is
* uncontrollable if rank([λI - A, B]) < n where n is the number of states.
*
* @tparam States The number of states.
* @tparam Inputs The number of inputs.
* @tparam States Number of states.
* @tparam Inputs Number of inputs.
* @param A System matrix.
* @param B Input matrix.
*/
@@ -253,8 +253,8 @@ IsStabilizable<Eigen::Dynamic, Eigen::Dynamic>(const Eigen::MatrixXd& A,
* any, have absolute values less than one, where an eigenvalue is unobservable
* if rank([λI - A; C]) < n where n is the number of states.
*
* @tparam States The number of states.
* @tparam Outputs The number of outputs.
* @tparam States Number of states.
* @tparam Outputs Number of outputs.
* @param A System matrix.
* @param C Output matrix.
*/
@@ -277,7 +277,7 @@ Eigen::Vector3d PoseToVector(const Pose2d& pose);
/**
* Clamps input vector between system's minimum and maximum allowable input.
*
* @tparam Inputs The number of inputs.
* @tparam Inputs Number of inputs.
* @param u Input vector to clamp.
* @param umin The minimum input magnitude.
* @param umax The maximum input magnitude.
@@ -298,7 +298,7 @@ Vectord<Inputs> ClampInputMaxMagnitude(const Vectord<Inputs>& u,
* Renormalize all inputs if any exceeds the maximum magnitude. Useful for
* systems such as differential drivetrains.
*
* @tparam Inputs The number of inputs.
* @tparam Inputs Number of inputs.
* @param u The input vector.
* @param maxMagnitude The maximum magnitude any input can have.
* @return The normalizedInput