Add more information on conditionals requirement for GaussianMixture

release/4.3a0
Varun Agrawal 2022-06-02 00:09:38 -04:00
parent 31ab1a32f3
commit d2029f3d03
1 changed files with 6 additions and 2 deletions

View File

@ -68,13 +68,17 @@ class GTSAM_EXPORT GaussianMixtureConditional
/// Defaut constructor, mainly for serialization.
GaussianMixtureConditional() = default;
/**
* @brief Construct a new GaussianMixtureConditional object
* @brief Construct a new GaussianMixtureConditional 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.
* @param conditionals a decision tree of GaussianConditionals. The number of
* conditionals should be C^(number of discrete parents), where C is the
* cardinality of the DiscreteKeys in discreteParents, since the
* discreteParents will be used as the labels in the decision tree.
*/
GaussianMixtureConditional(const KeyVector &continuousFrontals,
const KeyVector &continuousParents,