mergeGraph!

Author: Affie

src/Deprecated.jl

@@ -119,6 +119,9 @@ end
 ##==============================================================================
 ## WIP on consolidated subgraph functions, aim to remove in 0.8
 ##==============================================================================
+# Deprecate in favor of buildSubgraph, mergeGraph
+export getSubgraph, getSubgraphAroundNode
+export buildSubgraphFromLabels!
 
 """
     $(SIGNATURES)

src/DistributedFactorGraphs.jl

@@ -162,9 +162,7 @@ export packVariableNodeData, unpackVariableNodeData
 export getSolvedCount, isSolved, setSolvedCount!, isInitialized
 
 export getNeighborhood, getNeighbors, _getDuplicatedEmptyDFG
-export copyGraph!, deepcopyGraph, deepcopyGraph!, buildSubgraph
-# TODO Deprecate in favor of buildSubgraph
-export getSubgraph, getSubgraphAroundNode
+export copyGraph!, deepcopyGraph, deepcopyGraph!, buildSubgraph, mergeGraph!
 # Big Data
 ##------------------------------------------------------------------------------
 export addBigDataEntry!, getBigDataEntry, updateBigDataEntry!, deleteBigDataEntry!, getBigDataEntries, getBigDataKeys
@@ -226,13 +224,10 @@ export
     compareFactorGraphs
 
 
-## Deprecated.jl should be listed there
+## Deprecated exports should be listed in Deprecated.jl if possible, otherwise here 
 
 
 ## needsahome.jl
-
-export buildSubgraphFromLabels!
-
 import Base: print
 export printFactor, printVariable, print
 

src/services/AbstractDFG.jl

@@ -784,10 +784,16 @@ end
 """
     $(SIGNATURES)
 Common function for copying nodes from one graph into another graph.
-This is overwritten in specialized implementations for performance.
+This is overridden in specialized implementations for performance.
 Orphaned factors are not added, with a warning if verbose.
 Set `overwriteDest` to overwrite existing variables and factors in the destination DFG.
 NOTE: copyGraphMetadata not supported yet.
+Related:
+- [`deepcopyGraph`](@ref)
+- [`deepcopyGraph!`](@ref)
+- [`buildSubgraph`](@ref)
+- [`getNeighborhood`](@ref)
+- [`mergeGraph!`](@ref)
 Dev Note:
 - Adapted from and replaces internal _copyIntoGraph!
 """
@@ -877,6 +883,11 @@ end
 """
     $(SIGNATURES)
 Build a list of all unique neighbors inside 'distance'
+Related:
+- [`copyGraph!`](@ref)
+- [`buildSubgraph`](@ref)
+- [`deepcopyGraph`](@ref)
+- [`mergeGraph!`](@ref)
 """
 function getNeighborhood(dfg::AbstractDFG, label::Symbol, distance::Int)::Vector{Symbol}
     neighborList = Set{Symbol}([label])
@@ -896,15 +907,7 @@ function getNeighborhood(dfg::AbstractDFG, label::Symbol, distance::Int)::Vector
     return collect(neighborList)
 end
 
-"""
-    $(SIGNATURES)
-Build a deep subgraph copy from the DFG given a list of variables and factors and an optional distance.
-Note: Orphaned factors (where the subgraph does not contain all the related variables) are not returned.
-Dev Notes
-- Bulk vs node for node: a list of labels are compiled and the sugraph is copied in bulk.
-"""
-function buildSubgraph(::Type{G}, dfg::AbstractDFG, variableFactorLabels::Vector{Symbol}, distance::Int=0; solvable::Int=0, kwargs...) where G <: AbstractDFG
-
+function getNeighborhood(dfg::AbstractDFG, variableFactorLabels::Vector{Symbol}, distance::Int; solvable::Int=0)::Vector{Symbol}
     # find neighbors at distance to add
     neighbors = Symbol[]
     if distance > 0
@@ -917,11 +920,63 @@ function buildSubgraph(::Type{G}, dfg::AbstractDFG, variableFactorLabels::Vector
 
     solvable != 0 && filter!(nlbl -> (getSolvable(dfg, nlbl) >= solvable), allvarfacs)
 
+    return allvarfacs
+
+end
+
+"""
+    $(SIGNATURES)
+Build a deep subgraph copy from the DFG given a list of variables and factors and an optional distance.
+Note: Orphaned factors (where the subgraph does not contain all the related variables) are not returned.
+Related:
+- [`copyGraph!`](@ref)
+- [`getNeighborhood`](@ref)
+- [`deepcopyGraph`](@ref)
+- [`mergeGraph!`](@ref)
+Dev Notes
+- Bulk vs node for node: a list of labels are compiled and the sugraph is copied in bulk.
+"""
+function buildSubgraph(::Type{G},
+                       dfg::AbstractDFG,
+                       variableFactorLabels::Vector{Symbol},
+                       distance::Int=0;
+                       solvable::Int=0,
+                       kwargs...) where G <: AbstractDFG
+
+    #build up the neighborhood from variableFactorLabels
+    allvarfacs = getNeighborhood(dfg, variableFactorLabels, distance; solvable=solvable)
+
     # Copy the section of graph we want
     destDFG = deepcopyGraph(G, dfg, allvarfacs; kwargs...)
     return destDFG
 end
 
+"""
+    $(SIGNATURES)
+Merger sourceDFG to destDFG given an optional list of variables and factors and distance.
+Notes:
+- Nodes already in the destination graph are updated from sourceDFG.
+- Orphaned factors (where the subgraph does not contain all the related variables) are not included.
+Related:
+- [`copyGraph!`](@ref)
+- [`buildSubgraph`](@ref)
+- [`getNeighborhood`](@ref)
+- [`deepcopyGraph`](@ref)
+"""
+function mergeGraph!(destDFG::AbstractDFG,
+                     sourceDFG::AbstractDFG,
+                     variableFactorLabels::Vector{Symbol} = union(ls(sourceDFG), lsf(sourceDFG)),
+                     distance::Int = 0;
+                     solvable::Int = 0,
+                     kwargs...)
+
+    # find neighbors at distance to add
+    allvarfacs = getNeighborhood(sourceDFG, variableFactorLabels, distance; solvable=solvable)
+
+    copyGraph!(destDFG, sourceDFG, allvarfacs; deepcopyNodes=true, overwriteDest=true, kwargs...)
+
+    return destDFG
+end
 
 ##==============================================================================
 ## Variable Data: VND and PPE