buildSubgraphFromLabels!

Author: GearsAD

src/DistributedFactorGraphs.jl

@@ -100,6 +100,9 @@ include("CloudGraphsDFG/CloudGraphsDFG.jl")
 const InMemoryDFGTypes = Union{GraphsDFG, LightDFG}
 export InMemoryDFGTypes
 
+# Needs a home.
+include("needsahome.jl")
+
 function __init__()
     @require GraphPlot = "a2cc645c-3eea-5389-862e-a155d0052231" begin
         @info "Including Plots"

src/needsahome.jl

@@ -0,0 +1,50 @@
+export buildSubgraphFromLabels!
+
+
+"""
+    $SIGNATURES
+Construct a new factor graph object as a subgraph of `dfg <: AbstractDFG` based on the
+variable labels `syms::Vector{Symbols}`.
+
+SamC: Can we not just use _copyIntoGraph! for this? Looks like a small refactor to make it work.
+Will paste in as-is for now and we can figure it out as we go.
+
+Notes
+- Slighly messy internals, but gets the job done -- some room for performance improvement.
+Related
+getVariableIds
+"""
+function buildSubgraphFromLabels!(dfg::G,
+                                  syms::Vector{Symbol},
+                                  destType::Type{<:AbstractDFG}=GraphsDFG; #Which one? I don't have a strong opinion on this.
+                                  solvable::Int=0)::G where G <: AbstractDFG
+
+  # data structure for cliq sub graph
+  if G <: InMemoryDFGTypes
+    #Same type
+    cliqSubFg = G(params=getSolverParams(dfg))
+  else
+    #Default
+    cliqSubFg = destType{typeof(getSolverParms(dfg))}(params=getSolverParams(dfg))
+  end
+
+  # add a little too many variables (since we need the factors)
+  for sym in syms
+    getSubgraphAroundNode(dfg, getVariable(dfg, sym), 2, false, cliqSubFg, solvable=solvable)
+  end
+
+  # remove excessive variables that were copied by neighbors distance 2
+  currVars = getVariableIds(cliqSubFg)
+  toDelVars = setdiff(currVars, syms)
+  for dv in toDelVars
+    # delete any neighboring factors first
+    for fc in lsf(cliqSubFg, dv)
+      deleteFactor!(cliqSubFg, fc)
+    end
+
+    # and the variable itself
+    deleteVariable!(cliqSubFg, dv)
+  end
+
+  return cliqSubFg
+end

test/needsahomeTests.jl

@@ -0,0 +1,23 @@
+using DistributedFactorGraphs
+using Test
+
+@testset "Needs-a-home tests" begin
+    dfg = GraphsDFG{NoSolverParams}(params=NoSolverParams())
+    struct TestInferenceVariable1 <: InferenceVariable end
+    struct TestInferenceVariable2 <: InferenceVariable end
+
+    v1 = DFGVariable(:a, TestInferenceVariable1())
+    v2 = DFGVariable(:b, TestInferenceVariable1())
+    f1 = DFGFactor{Int, :Symbol}(:f1)
+    addVariable!(dfg, v1)
+    addVariable!(dfg, v2)
+    addFactor!(dfg, [v1, v2], f1)
+
+    newdfg = buildSubgraphFromLabels!(dfg, [:b])
+    @test ls(newdfg) == [:b]
+    # Okay it looks like this function only accepts variables, is that right?
+    @test_throws Exception newdfg = buildSubgraphFromLabels!(dfg, [:b, :f1])
+    newdfg = buildSubgraphFromLabels!(dfg, [:b, :a])
+    @test symdiff(ls(newdfg), [:b, :a]) == []
+
+end

test/runtests.jl

@@ -44,6 +44,9 @@ end
     include("DataStoreTests.jl")
 end
 
+@testset "Needs-a-Home Tests" begin
+    include("needsahomeTests.jl")
+end
 
 @testset "LightDFG subtype tests" begin
     for type in [(var=DFGVariableSummary, fac=DFGFactorSummary), (var=SkeletonDFGVariable,fac=SkeletonDFGFactor)]