12345qiupeng
/
gtsam
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update scaledProduct docs

release/4.3a0
Varun Agrawal 2025-01-07 10:52:05 -05:00
parent 3fb6f39b30
commit 3d2dd7c619
2 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
gtsam/discrete/DiscreteFactorGraph.cpp
View File

@ -118,12 +118,7 @@ namespace gtsam {
// } // }
// } // }
/** /* ************************************************************************ */
* @brief Multiply all the `factors`.
*
* @param factors The factors to multiply as a DiscreteFactorGraph.
* @return DiscreteFactor::shared_ptr
*/
DiscreteFactor::shared_ptr DiscreteFactorGraph::scaledProduct() const { DiscreteFactor::shared_ptr DiscreteFactorGraph::scaledProduct() const {
// PRODUCT: multiply all factors // PRODUCT: multiply all factors
gttic(product); gttic(product);

8
gtsam/discrete/DiscreteFactorGraph.h
View File

@ -150,8 +150,12 @@ class GTSAM_EXPORT DiscreteFactorGraph
/** return product of all factors as a single factor */ /** return product of all factors as a single factor */
DiscreteFactor::shared_ptr product() const; DiscreteFactor::shared_ptr product() const;
/** Return product of all factors as a single factor, /**
* which is scaled by the max to prevent underflow * @brief Return product of all `factors` as a single factor,
* which is scaled by the max value to prevent underflow
*
* @param factors The factors to multiply as a DiscreteFactorGraph.
* @return DiscreteFactor::shared_ptr
*/ */
DiscreteFactor::shared_ptr scaledProduct() const; DiscreteFactor::shared_ptr scaledProduct() const;