From 7fc312c87b5e27749460eb72080240e1f7741936 Mon Sep 17 00:00:00 2001 From: dehann Date: Tue, 23 Jan 2024 00:37:32 -0800 Subject: [PATCH] minor fixes updates to docs --- docs/src/GraphData.md | 6 +++--- src/services/DFGVariable.jl | 8 +++++++- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/docs/src/GraphData.md b/docs/src/GraphData.md index b6f333db..26cee874 100644 --- a/docs/src/GraphData.md +++ b/docs/src/GraphData.md @@ -84,9 +84,9 @@ Solved graphs contain packed parametric estimates for the variables, which are k For each PPE structure, there are accessors for getting individual values: -- [`getMaxPPE`](@ref) -- [`getMeanPPE`](@ref) -- [`getSuggestedPPE`](@ref) +- [`getPPEMax`](@ref) +- [`getPPEMean`](@ref) +- [`getPPESuggested`](@ref) Related functions for getting, adding/updating, and deleting PPE structures: diff --git a/src/services/DFGVariable.jl b/src/services/DFGVariable.jl index 0143ea8f..d5337877 100644 --- a/src/services/DFGVariable.jl +++ b/src/services/DFGVariable.jl @@ -475,6 +475,12 @@ Return full dictionary of PPEs in a variable, recommended to rather use CRUD: [` """ getVariablePPEDict(vari::VariableDataLevel1) = getPPEDict(vari) +""" + getVariablePPE(::DFGVariable) + getVariablePPE(::VariableNodeData) + +Get the Parametric Point Estimate of the given variable. +""" getVariablePPE(args...) = getPPE(args...) ##------------------------------------------------------------------------------ @@ -956,7 +962,7 @@ Notes - Defaults on keywords `solveKey` and `method` Related -[`getMeanPPE`](@ref), [`getMaxPPE`](@ref), [`updatePPE!`](@ref), getKDEMean, getKDEFit, getPPEs, getVariablePPEs +[`getPPEMean`](@ref), [`getPPEMax`](@ref), [`updatePPE!`](@ref), `mean(BeliefType)` """ function getPPE(v::DFGVariable, ppekey::Symbol = :default) !haskey(v.ppeDict, ppekey) &&