From cc79d0432dbf1278800680687fd12aa368c92784 Mon Sep 17 00:00:00 2001 From: Frank Dellaert Date: Sun, 29 Sep 2024 00:34:31 -0700 Subject: [PATCH] Doxygen --- gtsam/hybrid/HybridGaussianConditional.h | 38 ++++++++++++++++++++---- 1 file changed, 32 insertions(+), 6 deletions(-) diff --git a/gtsam/hybrid/HybridGaussianConditional.h b/gtsam/hybrid/HybridGaussianConditional.h index 16fc0500f6..bd7849d332 100644 --- a/gtsam/hybrid/HybridGaussianConditional.h +++ b/gtsam/hybrid/HybridGaussianConditional.h @@ -87,18 +87,44 @@ class GTSAM_EXPORT HybridGaussianConditional const DiscreteKey &mode, const std::vector &conditionals); - /// Construct from mean `mu_i` and `sigma_i`. + /** + * @brief Constructs a HybridGaussianConditional with means mu_i and + * standard deviations sigma_i. + * + * @param mode The discrete mode key. + * @param key The key for this conditional variable. + * @param parameters A vector of pairs (mu_i, sigma_i). + */ HybridGaussianConditional( - const DiscreteKey &mode, Key key, // + const DiscreteKey &mode, Key key, const std::vector> ¶meters); - /// Construct from conditional mean `A1 p1 + b_i` and `sigma_i`. + /** + * @brief Constructs a HybridGaussianConditional with conditional means + * A × parent + b_i and standard deviations sigma_i. + * + * @param mode The discrete mode key. + * @param key The key for this conditional variable. + * @param A The matrix A. + * @param parent The key of the parent variable. + * @param parameters A vector of pairs (b_i, sigma_i). + */ HybridGaussianConditional( - const DiscreteKey &mode, Key key, // - const Matrix &A, Key parent, + const DiscreteKey &mode, Key key, const Matrix &A, Key parent, const std::vector> ¶meters); - /// Construct from conditional mean `A1 p1 + A2 p2 + b_i` and `sigma_i`. + /** + * @brief Constructs a HybridGaussianConditional with conditional means + * A1 × parent1 + A2 × parent2 + b_i and standard deviations sigma_i. + * + * @param mode The discrete mode key. + * @param key The key for this conditional variable. + * @param A1 The first matrix. + * @param parent1 The key of the first parent variable. + * @param A2 The second matrix. + * @param parent2 The key of the second parent variable. + * @param parameters A vector of pairs (b_i, sigma_i). + */ HybridGaussianConditional( const DiscreteKey &mode, Key key, // const Matrix &A1, Key parent1, const Matrix &A2, Key parent2,