add docstring and GTSAM_EXPORT for ComputeLogNormalizer

release/4.3a0
Varun Agrawal 2024-08-22 11:57:57 -04:00
parent 9a6d2cf323
commit 98a2668fb1
1 changed files with 10 additions and 1 deletions

View File

@ -179,7 +179,16 @@ template <>
struct traits<GaussianMixtureFactor> : public Testable<GaussianMixtureFactor> {
};
double ComputeLogNormalizer(
/**
* @brief Helper function to compute the sqrt(|2πΣ|) normalizer values
* for a Gaussian noise model.
* We compute this in the log-space for numerical accuracy.
*
* @param noise_model The Gaussian noise model
* whose normalizer we wish to compute.
* @return double
*/
GTSAM_EXPORT double ComputeLogNormalizer(
const noiseModel::Gaussian::shared_ptr &noise_model);
} // namespace gtsam