Skip to content

Commit 3c57289

Browse files
authored
Merge pull request #1068 from JuliaRobotics/24Q1/docs/moredocs
minor fixes updates to docs
2 parents b421564 + 7fc312c commit 3c57289

File tree

2 files changed

+10
-4
lines changed

2 files changed

+10
-4
lines changed

docs/src/GraphData.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -84,9 +84,9 @@ Solved graphs contain packed parametric estimates for the variables, which are k
8484

8585
For each PPE structure, there are accessors for getting individual values:
8686

87-
- [`getMaxPPE`](@ref)
88-
- [`getMeanPPE`](@ref)
89-
- [`getSuggestedPPE`](@ref)
87+
- [`getPPEMax`](@ref)
88+
- [`getPPEMean`](@ref)
89+
- [`getPPESuggested`](@ref)
9090

9191

9292
Related functions for getting, adding/updating, and deleting PPE structures:

src/services/DFGVariable.jl

+7-1
Original file line numberDiff line numberDiff line change
@@ -475,6 +475,12 @@ Return full dictionary of PPEs in a variable, recommended to rather use CRUD: [`
475475
"""
476476
getVariablePPEDict(vari::VariableDataLevel1) = getPPEDict(vari)
477477

478+
"""
479+
getVariablePPE(::DFGVariable)
480+
getVariablePPE(::VariableNodeData)
481+
482+
Get the Parametric Point Estimate of the given variable.
483+
"""
478484
getVariablePPE(args...) = getPPE(args...)
479485

480486
##------------------------------------------------------------------------------
@@ -956,7 +962,7 @@ Notes
956962
- Defaults on keywords `solveKey` and `method`
957963
958964
Related
959-
[`getMeanPPE`](@ref), [`getMaxPPE`](@ref), [`updatePPE!`](@ref), getKDEMean, getKDEFit, getPPEs, getVariablePPEs
965+
[`getPPEMean`](@ref), [`getPPEMax`](@ref), [`updatePPE!`](@ref), `mean(BeliefType)`
960966
"""
961967
function getPPE(v::DFGVariable, ppekey::Symbol = :default)
962968
!haskey(v.ppeDict, ppekey) &&

0 commit comments

Comments
 (0)