Skip to content

Commit

Permalink
update doxygen (review comment)
Browse files Browse the repository at this point in the history
  • Loading branch information
gchenfc committed Dec 9, 2021
1 parent 40e585b commit 11fd861
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion gtsam/mainpage.dox
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ To use GTSAM to solve your own problems, you will often have to create new facto

-# The number of variables your factor involves is <b>unknown</b> at compile time - derive from NoiseModelFactor and implement NoiseModelFactor::unwhitenedError()
- This is a factor expressing the sum-of-squares error between a measurement \f$ z \f$ and a measurement prediction function \f$ h(x) \f$, on which the errors are expected to follow some distribution specified by a noise model (see noiseModel).
-# The number of variables your factor involves is <b>known</b> at compile time and is between 1 and 6 - derive from NoiseModelFactor1, NoiseModelFactor2, NoiseModelFactor3, NoiseModelFactor4, NoiseModelFactor5, or NoiseModelFactor6, and implement <b>\c evaluateError()</b>. If the number of variables is greater than 6, derive from NoiseModelFactorN.
-# The number of variables your factor involves is <b>known</b> at compile time, derive from NoiseModelFactorN<T1, T2, ...> (where T1, T2, ... are the types of the variables, e.g. double, Vector, Pose3) and implement <b>\c evaluateError()</b>.
- This factor expresses the same sum-of-squares error with a noise model, but makes the implementation task slightly easier than with %NoiseModelFactor.
-# Derive from NonlinearFactor
- This is more advanced and allows creating factors without an explicit noise model, or that linearize to HessianFactor instead of JacobianFactor.
Expand Down

0 comments on commit 11fd861

Please sign in to comment.