WIP on cleanup (note - tests need a lot of TLC)

Author: GearsAD

docs/src/BuildingGraphs.md

@@ -64,7 +64,7 @@ Variables are added using IncrementalInference's `addVariable!` function. To cre
 - The variable's label (e.g. :x1 or :a)
 - The variable inference type (aka soft type), which is a subtype of InferenceVariable
 
-**Note**: Once variables are initialized to a specific soft type, all variable node data (solver data) must use that type. 
+**NOTE**: Once variables are initialized to a specific soft type, variable node data (solver data) is templated to that type. 
 
 In addition, the following optional parameters are provided:
 - Additional labels for the variable (in DFG these are referred to as tags)

docs/src/GraphData.md

@@ -11,13 +11,13 @@ There are three fundamental types of data in DFG:
 
 The following is a guideline to using these parameters.
 
-> Note: Some functions are direct accessors to the internal parameters, others are derived functions (e.g. getLabel(v) = v.label). In other cases the accessors are simplified ways to interact with the structures. We recommend using the accessors as the internal structure may change over time.
+**NOTE**: Some functions are direct accessors to the internal parameters, others are derived functions (e.g. getLabel(v) = v.label). In other cases the accessors are simplified ways to interact with the structures. We recommend using the accessors as the internal structure may change over time.
 
-> Note: Adds in general throw an error if the element already exists. Update will update the element if it exists, otherwise it will add it.
+**NOTE**: Adds in general throw an error if the element already exists. Update will update the element if it exists, otherwise it will add it.
 
-> Note: In general these functions will return an error if the respective element is not found. This is to avoid returning, say, nothing, which will be horribly confusing if you tried `getVariableSolverData(dfg, :a, :b)` and it returned nothing - which was missing, :a or :b, or was there a communication issue? We recommend coding defensively and trapping errors in critical portions of your user code.
+**NOTE**: In general these functions will return an error if the respective element is not found. This is to avoid returning, say, nothing, which will be horribly confusing if you tried `getVariableSolverData(dfg, :a, :b)` and it returned nothing - which was missing, :a or :b, or was there a communication issue? We recommend coding defensively and trapping errors in critical portions of your user code.
 
-> Note: All data is passed by reference, so if you update the returned structure it will update in the graph. The database driver is an exception, and once the variable or factor is updated you need to call update* to persist the changes to the graph.
+**NOTE**: All data is passed by reference, so if you update the returned structure it will update in the graph. The database driver is an exception, and once the variable or factor is updated you need to call update* to persist the changes to the graph.
 
 The following examples make use this data:
 
@@ -87,9 +87,16 @@ getSofttype
 
 #### Packed Parametric Estimates
 
-Solved graphs contain estimates for the variables, which are keyed by the solution (the default is saved as :default).
+Solved graphs contain packed parametric estimates for the variables, which are keyed by the solution (the default is saved as :default).
 
 ```@docs
+getMaxPPE
+getMeanPPE
+getSuggestedPPE
+getVariablePPE
+getPPE
+getVariablePPEs
+getPPEs
 ```
 
 #### Solver Data

docs/src/SavingData.jl renamed to docs/src/SavingData.md

@@ -13,7 +13,7 @@
     #TODO fix this to use accessors
     verts[7].solvable = 1
     verts[8].solvable = 0
-    solverData(verts[8]).solveInProgress = 1
+    getSolverData(verts[8]).solveInProgress = 1
     #call update to set it on cloud
     updateVariable!(dfg, verts[7])
     updateVariable!(dfg, verts[8])

test/fileDFGTests.jl

@@ -158,12 +158,31 @@ end
 
     @test getVariablePPEs(v1) == v1.ppeDict
     @test getVariablePPE(v1, :notfound) == nothing
-    @test solverData(v1) === v1.solverDataDict[:default]
+    @test getSolverData(v1) === v1.solverDataDict[:default]
     @test getData(v1) === v1.solverDataDict[:default]
     @test solverData(v1, :default) === v1.solverDataDict[:default]
     @test getSolverDataDict(v1) == v1.solverDataDict
     @test getInternalId(v1) == v1._internalId
 
+    # Add new VND of type ContinuousScalar to :x0
+    # Could also do VariableNodeData(ContinuousScalar())
+    vnd = VariableNodeData{ContinuousScalar}()
+    addVariableSolverData!(dfg, :a, vnd, :parametric)
+    @show listVariableSolverData(dfg, :a)
+    # Get the data back - note that this is a reference to above.
+    vndBack = getVariableSolverData(dfg, :a, :parametric)
+    # Delete it
+    deleteVariableSolverData!(dfg, :a, :parametric)
+    # Update add it
+    updateVariableSolverData!(dfg, :a, vnd, :parametric)
+    # Update update it
+    updateVariableSolverData!(dfg, :a, vnd, :parametric)
+    # Bulk copy update x0 and x1
+    updateVariableSolverData!(dfg, [v1, v2], :default)
+    # Delete parametric from v1
+    deleteVariableSolverData!(dfg, :a, :parametric)
+
+
     #TODO I don't know what is supposed to happen to softtype
     @test getSofttype(v1) == st1
     @test getSofttype(v2) == st2