Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

minor fixes updates to docs #1068

Merged
merged 1 commit into from
Jan 23, 2024
Merged

minor fixes updates to docs #1068

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/src/GraphData.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
8 changes: 7 additions & 1 deletion src/services/DFGVariable.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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...)

##------------------------------------------------------------------------------
Expand Down Expand Up @@ -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) &&
Expand Down
Loading