From 703865fb6513345a16f6784021b99198132bdac6 Mon Sep 17 00:00:00 2001 From: dehann Date: Mon, 22 Jan 2024 08:25:14 -0800 Subject: [PATCH] fix broken outdated docstrings --- src/parametric/services/ConsolidateParametricRelatives.jl | 2 +- src/parametric/services/ParametricManopt.jl | 6 +++++- src/services/CalcFactor.jl | 4 ++-- src/services/DeconvUtils.jl | 4 ++-- src/services/GraphProductOperations.jl | 2 +- src/services/TetherUtils.jl | 2 +- 6 files changed, 12 insertions(+), 8 deletions(-) diff --git a/src/parametric/services/ConsolidateParametricRelatives.jl b/src/parametric/services/ConsolidateParametricRelatives.jl index c5c8ef9b..28274b83 100644 --- a/src/parametric/services/ConsolidateParametricRelatives.jl +++ b/src/parametric/services/ConsolidateParametricRelatives.jl @@ -18,7 +18,7 @@ DevNotes Related: -[`getMeasurementParametric`](@ref), [`approxConv`](@ref), [`MutablePose2Pose2Gaussian`](@ref) +[`getMeasurementParametric`](@ref), [`approxConvBelief`](@ref), [`MutablePose2Pose2Gaussian`](@ref) """ function solveFactorParameteric( dfg::AbstractDFG, diff --git a/src/parametric/services/ParametricManopt.jl b/src/parametric/services/ParametricManopt.jl index f82165e4..e1d14e74 100644 --- a/src/parametric/services/ParametricManopt.jl +++ b/src/parametric/services/ParametricManopt.jl @@ -562,7 +562,11 @@ function autoinitParametric!( end -## +""" + $SIGNATURES + +Batch parametric graph solve using Riemannian Levenberg Marquardt. +""" solveGraphParametric(args...; kwargs...) = solve_RLM(args...; kwargs...) function DFG.solveGraphParametric!( diff --git a/src/services/CalcFactor.jl b/src/services/CalcFactor.jl index 8cccca2c..90c0d0a2 100644 --- a/src/services/CalcFactor.jl +++ b/src/services/CalcFactor.jl @@ -118,7 +118,7 @@ residual = calcFactorResidual(fg, :x1x2f1, [1.0], [0.0], [0.0]) Related -[`calcFactorResidualTemporary`](@ref), [`_evalFactorTemporary!`](@ref), [`evalFactor`](@ref), [`approxConv`](@ref) +[`calcFactorResidualTemporary`](@ref), [`_evalFactorTemporary!`](@ref), [`evalFactor`](@ref), [`approxConvBelief`](@ref) """ function calcFactorResidual( dfgfct::DFGFactor, @@ -147,7 +147,7 @@ residual = calcFactorResidualTemporary(Pose2Pose2(...), (RoME.Pose2,RoME.Pose2), Related -[`calcFactorResidual`](@ref), [`CalcResidual`](@ref), [`_evalFactorTemporary!`](@ref), [`approxConv`](@ref), [`_buildGraphByFactorAndTypes!`](@ref) +[`calcFactorResidual`](@ref), [`CalcResidual`](@ref), [`_evalFactorTemporary!`](@ref), [`approxConvBelief`](@ref), [`_buildGraphByFactorAndTypes!`](@ref) """ function calcFactorResidualTemporary( fct::AbstractRelative, diff --git a/src/services/DeconvUtils.jl b/src/services/DeconvUtils.jl index 52a1d457..073299e8 100644 --- a/src/services/DeconvUtils.jl +++ b/src/services/DeconvUtils.jl @@ -168,12 +168,12 @@ Generalized deconvolution to find the predicted measurement values of the factor Inverse solve of predicted noise value and returns tuple of (newly predicted, and known "measured" noise) values. Notes -- Opposite operation contained in `approxConv`. +- Opposite operation contained in `approxConvBelief`. - For more notes see [`solveFactorMeasurements`](@ref). Related -[`approxConv`](@ref), `deconvSolveKey` +[`approxConvBelief`](@ref), `deconvSolveKey` """ function approxDeconv( dfg::AbstractDFG, diff --git a/src/services/GraphProductOperations.jl b/src/services/GraphProductOperations.jl index 4304af42..06d2d845 100644 --- a/src/services/GraphProductOperations.jl +++ b/src/services/GraphProductOperations.jl @@ -11,7 +11,7 @@ Notes Related -[`approxConv`](@ref), [`proposalbeliefs!`](@ref), [`AMP.manifoldProduct`](@ref) +[`approxConvBelief`](@ref), [`proposalbeliefs!`](@ref), [`AMP.manifoldProduct`](@ref) """ function propagateBelief( dfg::AbstractDFG, diff --git a/src/services/TetherUtils.jl b/src/services/TetherUtils.jl index c0fc3a58..582bec86 100644 --- a/src/services/TetherUtils.jl +++ b/src/services/TetherUtils.jl @@ -114,7 +114,7 @@ DevNotes Related: -[`approxConv`](@ref), [`solveFactorParameteric`](@ref), `RoME.MutablePose2Pose2Gaussian` +[`approxConvBelief`](@ref), [`solveFactorParameteric`](@ref), `RoME.MutablePose2Pose2Gaussian` """ function accumulateFactorMeans( dfg::AbstractDFG,