Update docstrings
parent
0e1c3b8cb6
commit
098d2ce4a4
|
|
@ -145,8 +145,10 @@ class GTSAM_EXPORT HybridBayesNet : public BayesNet<HybridConditional> {
|
||||||
AlgebraicDecisionTree<Key> error(const VectorValues &continuousValues) const;
|
AlgebraicDecisionTree<Key> error(const VectorValues &continuousValues) const;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Compute unnormalized probability for each discrete assignment,
|
* @brief Compute unnormalized probability q(μ|M),
|
||||||
* and return as a tree.
|
* for each discrete assignment, and return as a tree.
|
||||||
|
* q(μ|M) is the unnormalized probability at the MLE point μ,
|
||||||
|
* conditioned on the discrete variables.
|
||||||
*
|
*
|
||||||
* @param continuousValues Continuous values at which to compute the
|
* @param continuousValues Continuous values at which to compute the
|
||||||
* probability.
|
* probability.
|
||||||
|
|
|
||||||
|
|
@ -99,11 +99,12 @@ class GTSAM_EXPORT HybridGaussianFactorGraph
|
||||||
using shared_ptr = boost::shared_ptr<This>; ///< shared_ptr to This
|
using shared_ptr = boost::shared_ptr<This>; ///< shared_ptr to This
|
||||||
|
|
||||||
using Values = gtsam::Values; ///< backwards compatibility
|
using Values = gtsam::Values; ///< backwards compatibility
|
||||||
using Indices = KeyVector; ///> map from keys to values
|
using Indices = KeyVector; ///< map from keys to values
|
||||||
|
|
||||||
/// @name Constructors
|
/// @name Constructors
|
||||||
/// @{
|
/// @{
|
||||||
|
|
||||||
|
/// @brief Default constructor.
|
||||||
HybridGaussianFactorGraph() = default;
|
HybridGaussianFactorGraph() = default;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
@ -174,14 +175,16 @@ class GTSAM_EXPORT HybridGaussianFactorGraph
|
||||||
* @brief Compute error for each discrete assignment,
|
* @brief Compute error for each discrete assignment,
|
||||||
* and return as a tree.
|
* and return as a tree.
|
||||||
*
|
*
|
||||||
|
* Error \f$ e = \Vert x - \mu \Vert_{\Sigma} \f$.
|
||||||
|
*
|
||||||
* @param continuousValues Continuous values at which to compute the error.
|
* @param continuousValues Continuous values at which to compute the error.
|
||||||
* @return AlgebraicDecisionTree<Key>
|
* @return AlgebraicDecisionTree<Key>
|
||||||
*/
|
*/
|
||||||
AlgebraicDecisionTree<Key> error(const VectorValues& continuousValues) const;
|
AlgebraicDecisionTree<Key> error(const VectorValues& continuousValues) const;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Compute unnormalized probability for each discrete assignment,
|
* @brief Compute unnormalized probability \f$ P(X | M, Z) \f$
|
||||||
* and return as a tree.
|
* for each discrete assignment, and return as a tree.
|
||||||
*
|
*
|
||||||
* @param continuousValues Continuous values at which to compute the
|
* @param continuousValues Continuous values at which to compute the
|
||||||
* probability.
|
* probability.
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue