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

add docs for HybridFactor

release/4.3a0
Varun Agrawal 2022-05-27 18:32:19 -04:00
parent 3bde044248
commit f443cf30e0
1 changed files with 19 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
gtsam/hybrid/HybridFactor.h
View File

@ -34,6 +34,7 @@ DiscreteKeys CollectDiscreteKeys(const DiscreteKeys &key1,
/** /**
* Base class for hybrid probabilistic factors * Base class for hybrid probabilistic factors
*
* Examples: * Examples:
* - HybridGaussianFactor * - HybridGaussianFactor
* - HybridDiscreteFactor * - HybridDiscreteFactor
@ -64,13 +65,29 @@ class GTSAM_EXPORT HybridFactor : public Factor {
/** Default constructor creates empty factor */ /** Default constructor creates empty factor */
HybridFactor() = default; HybridFactor() = default;
/**
* @brief Construct hybrid factor from continuous keys.
*
* @param keys Vector of continuous keys.
*/
explicit HybridFactor(const KeyVector &keys); explicit HybridFactor(const KeyVector &keys);
/**
* @brief Construct hybrid factor from discrete keys.
*
* @param keys Vector of discrete keys.
*/
explicit HybridFactor(const DiscreteKeys &discreteKeys);
/**
* @brief Construct a new Hybrid Factor object.
*
* @param continuousKeys Vector of keys for continuous variables.
* @param discreteKeys Vector of keys for discrete variables.
*/
HybridFactor(const KeyVector &continuousKeys, HybridFactor(const KeyVector &continuousKeys,
const DiscreteKeys &discreteKeys); const DiscreteKeys &discreteKeys);
explicit HybridFactor(const DiscreteKeys &discreteKeys);
/// Virtual destructor /// Virtual destructor
virtual ~HybridFactor() = default; virtual ~HybridFactor() = default;