Add doxygen for GMM

release/4.3a0
Fan Jiang 2022-03-23 20:54:53 -04:00
parent a36c86a4f1
commit 8b4283b281
1 changed files with 14 additions and 7 deletions

View File

@ -24,8 +24,7 @@
#include <gtsam/linear/GaussianConditional.h> #include <gtsam/linear/GaussianConditional.h>
namespace gtsam { namespace gtsam {
class GaussianMixture class GaussianMixture : public HybridFactor,
: public HybridFactor,
public Conditional<HybridFactor, GaussianMixture> { public Conditional<HybridFactor, GaussianMixture> {
public: public:
using This = GaussianMixture; using This = GaussianMixture;
@ -38,6 +37,14 @@ class GaussianMixture
Conditionals conditionals_; Conditionals conditionals_;
public: public:
/**
* @brief Construct a new Gaussian Mixture object
*
* @param continuousFrontals the continuous frontals.
* @param continuousParents the continuous parents.
* @param discreteParents the discrete parents. Will be placed last.
* @param conditionals a decision tree of GaussianConditionals.
*/
GaussianMixture(const KeyVector &continuousFrontals, GaussianMixture(const KeyVector &continuousFrontals,
const KeyVector &continuousParents, const KeyVector &continuousParents,
const DiscreteKeys &discreteParents, const DiscreteKeys &discreteParents,