From cff6505423929bcc771e0cf990916d8bf981a64f Mon Sep 17 00:00:00 2001
From: Varun Agrawal <varagrawal@gmail.com>
Date: Thu, 3 Nov 2022 06:33:51 -0400
Subject: [PATCH] add docstring for HybridBayesNet::error(VectorValues)

---
 gtsam/hybrid/HybridBayesNet.h | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/gtsam/hybrid/HybridBayesNet.h b/gtsam/hybrid/HybridBayesNet.h
index 82e890cc4..d64e561f8 100644
--- a/gtsam/hybrid/HybridBayesNet.h
+++ b/gtsam/hybrid/HybridBayesNet.h
@@ -134,6 +134,13 @@ class GTSAM_EXPORT HybridBayesNet : public BayesNet<HybridConditional> {
   double error(const VectorValues &continuousValues,
                const DiscreteValues &discreteValues) const;
 
+  /**
+   * @brief Compute conditional error for each discrete assignment,
+   * and return as a tree.
+   *
+   * @param continuousValues Continuous values at which to compute the error.
+   * @return AlgebraicDecisionTree<Key>
+   */
   AlgebraicDecisionTree<Key> error(const VectorValues &continuousValues) const;
 
   /// @}