update ISAM2 group

release/4.3a0
Varun Agrawal 2022-07-26 18:06:39 -04:00
parent cce2722c4d
commit 150ddae41f
5 changed files with 9 additions and 6 deletions

View File

@ -50,4 +50,7 @@
\defgroup symbolic Symbolic \defgroup symbolic Symbolic
@{ @} @{ @}
\defgroup isam2 ISAM2
@{ @}
*/ */

View File

@ -32,7 +32,7 @@
namespace gtsam { namespace gtsam {
/** /**
* @addtogroup ISAM2 * @ingroup isam2
* Implementation of the full ISAM2 algorithm for incremental nonlinear * Implementation of the full ISAM2 algorithm for incremental nonlinear
* optimization. * optimization.
* *

View File

@ -27,7 +27,7 @@
namespace gtsam { namespace gtsam {
/** /**
* @addtogroup ISAM2 * @ingroup isam2
* Parameters for ISAM2 using Gauss-Newton optimization. Either this class or * Parameters for ISAM2 using Gauss-Newton optimization. Either this class or
* ISAM2DoglegParams should be specified as the optimizationParams in * ISAM2DoglegParams should be specified as the optimizationParams in
* ISAM2Params, which should in turn be passed to ISAM2(const ISAM2Params&). * ISAM2Params, which should in turn be passed to ISAM2(const ISAM2Params&).
@ -59,7 +59,7 @@ struct GTSAM_EXPORT ISAM2GaussNewtonParams {
}; };
/** /**
* @addtogroup ISAM2 * @ingroup isam2
* Parameters for ISAM2 using Dogleg optimization. Either this class or * Parameters for ISAM2 using Dogleg optimization. Either this class or
* ISAM2GaussNewtonParams should be specified as the optimizationParams in * ISAM2GaussNewtonParams should be specified as the optimizationParams in
* ISAM2Params, which should in turn be passed to ISAM2(const ISAM2Params&). * ISAM2Params, which should in turn be passed to ISAM2(const ISAM2Params&).
@ -126,7 +126,7 @@ struct GTSAM_EXPORT ISAM2DoglegParams {
}; };
/** /**
* @addtogroup ISAM2 * @ingroup isam2
* Parameters for the ISAM2 algorithm. Default parameter values are listed * Parameters for the ISAM2 algorithm. Default parameter values are listed
* below. * below.
*/ */

View File

@ -32,7 +32,7 @@
namespace gtsam { namespace gtsam {
/** /**
* @addtogroup ISAM2 * @ingroup isam2
* This struct is returned from ISAM2::update() and contains information about * This struct is returned from ISAM2::update() and contains information about
* the update that is useful for determining whether the solution is * the update that is useful for determining whether the solution is
* converging, and about how much work was required for the update. See member * converging, and about how much work was required for the update. See member

View File

@ -25,7 +25,7 @@
namespace gtsam { namespace gtsam {
/** /**
* @addtogroup ISAM2 * @ingroup isam2
* This struct is used by ISAM2::update() to pass additional parameters to * This struct is used by ISAM2::update() to pass additional parameters to
* give the user a fine-grained control on how factors and relinearized, etc. * give the user a fine-grained control on how factors and relinearized, etc.
*/ */