add docstrings for elimination results

release/4.3a0
Varun Agrawal 2024-11-01 20:24:36 -04:00
parent 44e8485360
commit 8aacfa95f3
1 changed files with 4 additions and 3 deletions

View File

@ -59,10 +59,11 @@ using OrphanWrapper = BayesTreeOrphanWrapper<HybridBayesTree::Clique>;
/// Result from elimination. /// Result from elimination.
struct Result { struct Result {
// Gaussian conditional resulting from elimination.
GaussianConditional::shared_ptr conditional; GaussianConditional::shared_ptr conditional;
double negLogK; double negLogK; // Negative log of the normalization constant K.
GaussianFactor::shared_ptr factor; GaussianFactor::shared_ptr factor; // Leftover factor 𝜏.
double scalar; double scalar; // Scalar value associated with factor 𝜏.
bool operator==(const Result &other) const { bool operator==(const Result &other) const {
return conditional == other.conditional && negLogK == other.negLogK && return conditional == other.conditional && negLogK == other.negLogK &&