Added support to delete graphs

Author: filchristou

docs/src/usage.md

@@ -147,9 +147,34 @@ julia> ng.grv[3].grv # see that index is deleted
  {2, 0} undirected simple Int64 graph
 
 ```
+Similarly we can delete nodes directly by specifying the unrolled path to that node.
+For example the above block does equivalent job to this:
 
-For now removing works only for nodes and not for graphs.
-Support of removing graphs is on the way (not particularly hard to implement).
+```jldoctest walkthrough
+julia> add_vertex!(ng; subgraphs = [3,2]) # restore previously removed node
+true
+
+julia> rem_vertex!(ng, [3,2,3]) # directly remove node
+```
+If the specified path doesn't point to a node, but to a graph, this whole graph is deleted instead.
+
+```jldoctest walkthrough
+julia> add_vertex!(ng, SimpleGraph(10); subgraphs=[3]); # add a graph that we will delete later
+
+julia> ng.grv[3].grv
+3-element Vector{AbstractGraph}:
+ {1, 0} undirected simple Int64 graph
+ {2, 0} undirected simple Int64 graph
+ {10, 0} undirected simple Int64 graph
+
+julia> rem_vertex!(ng, [3,3]) # delete previously added graph
+
+julia> ng.grv[3].grv
+2-element Vector{AbstractGraph}:
+ {1, 0} undirected simple Int64 graph
+ {2, 0} undirected simple Int64 graph
+
+```
 
 # Handling Edges
 Similarly we can use the `add_edge!` and `rem_edge!`.

src/functionality.jl

@@ -70,14 +70,58 @@ function innergraph(ng::NestedGraph, v::AbstractVector)
     end
 end
 
+"$(TYPEDSIGNATURES) Check if path id `v` can represent a graph."
+function isagraph(ng::NestedGraph, v::AbstractVector)
+    if length(v) > 1
+        if 0 <= v[1] <= length(ng.grv)
+            isagraph(ng.grv[v[1]], v[2:end])
+        else
+            return false
+        end
+    elseif length(v) == 1
+        return 0 <= v[1] <= length(ng.grv)
+    end
+end
+isagraph(ng::AbstractGraph, v::AbstractVector) = false
+
 "$(TYPEDSIGNATURES) For usage after single vertex removal only"
-function update_vmap_after_delete!(ng::NestedGraph, nver::Tuple{T,T}) where T<:Integer
+function update_vmapneds_after_delete!(ng::NestedGraph, nver::Tuple{T,T}) where T<:Integer
     for (i,vm) in enumerate(ng.vmap)
         if vm[1] == nver[1] && vm[2] > nver[2] 
             ng.vmap[i] = (vm[1], vm[2]-1)
-            break
         end
     end
+    filter!(ned -> src(ned) != nver && dst(ned) != nver, ng.neds)
+    for (i,ned) in enumerate(ng.neds)
+        vms = src(ned)
+        vmd = dst(ned)
+        if vms[1] == nver[1] && vms[2] > nver[2] 
+            vms = (vms[1], vms[2]-1)
+        end
+        if vmd[1] == nver[1] && vmd[2] > nver[2] 
+            vmd = (vmd[1], vmd[2]-1)
+        end
+        ng.neds[i] = NestedEdge(vms, vmd)
+    end
+end
+
+function update_vmapneds_after_delete_graph!(ng::NestedGraph, grid::T) where T<:Integer
+    for (i,vm) in enumerate(ng.vmap)
+        if vm[1] > grid 
+            ng.vmap[i] = (vm[1]-1, vm[2])
+        end
+    end
+    for (i,ned) in enumerate(ng.neds)
+        vms = src(ned)
+        vmd = dst(ned)
+        if vms[1] > grid
+            vms = (vms[1]-1, vms[2])
+        end
+        if vmd[1] > grid
+            vmd = (vmd[1]-1, vmd[2])
+        end
+        ng.neds[i] = NestedEdge(vms, vmd)
+    end
 end
 
 removeemptygraphs_recursive!(gr::AbstractGraph) = true

src/graphsimpl.jl

@@ -43,9 +43,25 @@ function Graphs.rem_vertex!(ng::NestedGraph, v::T) where T<:Integer
     nver = ng.vmap[v]
     rem_vertex!(ng.grv[nver[1]], nver[2])
     deleteat!(ng.vmap, v)
-    update_vmap_after_delete!(ng, nver)
+    update_vmapneds_after_delete!(ng, nver)
 end
 
+"$(TYPEDSIGNATURES)  Remove node or graph identified by `path2rem`."
+function Graphs.rem_vertex!(ng::NestedGraph, path2rem::Vector{T}) where T<:Integer
+    if !isagraph(ng, path2rem)
+        rem_vertex!(ng, roll_vertex(ng, path2rem))
+    else
+        gr2del = innergraph(ng, path2rem)
+        for v in vertices(gr2del)
+            path2remvert = vcat(path2rem, [1]) #always delete the first one. others will be pushed.
+            rem_vertex!(ng, roll_vertex(ng, path2remvert))
+        end
+        parentgr = length(path2rem) > 1 ? innergraph(ng, path2rem[1:end-1]) : ng
+        deleteat!(parentgr.grv, path2rem[end])
+        update_vmapneds_after_delete_graph!(parentgr, path2rem[end])
+        # updatge vmap and neds (the subgraph id part)
+    end
+end
 
 Graphs.add_edge!(ng::NestedGraph, ce::NestedEdge) = add_edge!(ng, edge(ng, ce))
 Graphs.add_edge!(ng::NestedGraph, e::Edge) = Graphs.add_edge!(ng, e.src, e.dst)

src/nestedgraph.jl

@@ -55,7 +55,7 @@ $(TYPEDSIGNATURES)
 
 `extrasubgraph` controls the `NestedGraph` should be initialized with an empty subgraph
 """
-function NestedGraph{T,R,N}(;extrasubgraph::Bool=true) where {T,R,N} 
+function NestedGraph{T,R,N}(;extrasubgraph::Bool=false) where {T,R,N} 
     ng = NestedGraph(R(), Vector{N}(), Vector{NestedEdge{T}}(), Vector{Tuple{T,T}}())
     extrasubgraph && add_vertex!(ng, R())
     return ng

test/addremgraphsimple.jl

@@ -0,0 +1,36 @@
+@testset "addremgraphsimple.jl" begin
+    # test deleting nodes 
+    ngt = test_simple_top()
+    @test length(ngt.neds) == 2
+    rem_vertex!(ngt, 1)
+    @test length(ngt.neds) == 1
+
+    # test deleting graphs
+    ngt = test_simple_top()
+    rem_vertex!(ngt, [1])
+    @test length(Set(getindex.(ngt.vmap,1))) == 2
+    @test length((ngt.grv)) == 2
+
+    ngt = test_simple_top()
+    rem_vertex!(ngt, [3,2])
+    @test length(Set(getindex.(ngt.grv[3].vmap,1))) == 2
+    @test length((ngt.grv[3].grv)) == 2
+
+    ngt = test_simple_top()
+    rem_vertex!(ngt, [3,3])
+    @test length(Set(getindex.(ngt.grv[3].vmap,1))) == 2
+    @test length((ngt.grv[3].grv)) == 2
+
+    ngt = test_simple_top()
+    rem_vertex!(ngt, [3,3,1])
+    @test length(Set(getindex.(ngt.grv[3].vmap,1))) == 2
+    @test length((ngt.grv[3].grv)) == 3
+    @test length(ngt.grv[3].grv[3].grv) == nv(ngt.grv[3].grv[3]) == ne(ngt.grv[3].grv[3]) == 0
+
+    # test deleting nodes 
+    ngt = test_simple_top()
+    while nv(ngt) > 0
+        rem_vertex!(ngt, unroll_vertex(ngt, nv(ngt)))
+    end
+    @test nv(ngt) == 0
+end

test/livetest.jl

@@ -1,32 +1,18 @@
+##
+# This file is meant to start up a live-test the package
+##
+
 DynNG = NestedGraph{Int, SimpleGraph{Int}, AbstractGraph}
 ngdyn = DynNG()
 add_vertex!(ngdyn, SimpleGraph(3))
-@assert nv(ngdyn.grv[1]) == 3
-
 add_vertex!(ngdyn, SimpleGraph(6))
-@assert nv(ngdyn.grv[1]) == 3 && nv(ngdyn.grv[2]) == 6
-
 add_vertex!(ngdyn)
-@assert nv(ngdyn.grv[1]) == 4 && nv(ngdyn.grv[2]) == 6
-
 add_vertex!(ngdyn, subgraphs = 2)
-@assert nv(ngdyn.grv[1]) == 4 && nv(ngdyn.grv[2]) == 7
-
-ngin = add_vertex!(ngdyn, DynNG())
+add_vertex!(ngdyn, DynNG())
+ngin = length(ngdyn.grv)
 add_vertex!(ngdyn, subgraphs = ngin)
-@assert nv(ngdyn.grv[1]) == 4 && nv(ngdyn.grv[2]) == 7 && nv(ngdyn.grv[3]) == 1
-
 add_vertex!(ngdyn, SimpleGraph(2), subgraphs = ngin)
-@assert nv(ngdyn.grv[1]) == 4 && nv(ngdyn.grv[2]) == 7 && nv(ngdyn.grv[3]) == 3
-
 add_vertex!(ngdyn, DynNG(), subgraphs = ngin)
-@assert nv(ngdyn.grv[1]) == 4 && nv(ngdyn.grv[2]) == 7 && nv(ngdyn.grv[3]) == 3
-
 add_vertex!(ngdyn, subgraphs=[3,2])
-@assert nv(ngdyn.grv[1]) == 4 && nv(ngdyn.grv[2]) == 7 && nv(ngdyn.grv[3]) == 4
-
 add_vertex!(ngdyn, SimpleGraph(2), subgraphs=[3,3])
-@assert nv(ngdyn.grv[1]) == 4 && nv(ngdyn.grv[2]) == 7 && nv(ngdyn.grv[3]) == 6
-
-@assert nv(ngdyn.grv[3].grv[1]) == 1 && nv(ngdyn.grv[3].grv[2]) == 3 && nv(ngdyn.grv[3].grv[3]) == 2
-@assert nv(ngdyn) == nv(ngdyn.grv[1]) + nv(ngdyn.grv[2]) + nv(ngdyn.grv[3])
+add_edge!(ngdyn, 1,8)

test/metaadd.jl

@@ -87,6 +87,6 @@
     @test nv(ngdyn) == nv(ngdyn.grv[1]) + nv(ngdyn.grv[2]) + nv(ngdyn.grv[3])
 
     # extra subgraph
-    ngdyn2 = DynMNG()    
+    ngdyn2 = DynMNG(;extrasubgraph=true)    
     @test length(ngdyn2.grv) == 1
 end

test/runtests.jl

@@ -5,5 +5,5 @@ using TestSetExtensions
 include("testutils.jl")
 
 @testset "NestedGraphs.jl" begin
-    @includetests ["simple", "simpleadd", "metagraphs", "metaadd"]
+    @includetests ["simple", "simpleadd", "metagraphs", "metaadd", "addremgraphsimple"]
 end

test/simpleadd.jl

@@ -69,6 +69,6 @@
     @test nv(ngdyn) == nv(ngdyn.grv[1]) + nv(ngdyn.grv[2]) + nv(ngdyn.grv[3])
 
     # extra subgraph
-    ngdyn2 = DynNG()    
+    ngdyn2 = DynNG(;extrasubgraph=true)    
     @test length(ngdyn2.grv) == 1
 end

test/testutils.jl

@@ -54,3 +54,48 @@ function testprops_recu(nmg)
           gr isa NestedGraph && testprops_recu(gr)
      end
 end
+
+function test_simple_top()
+    DynNG = NestedGraph{Int, SimpleGraph{Int}, AbstractGraph}
+    ngdyn = DynNG()
+    add_vertex!(ngdyn, SimpleGraph(3))
+    add_vertex!(ngdyn, SimpleGraph(6))
+    add_vertex!(ngdyn)
+    add_vertex!(ngdyn, subgraphs = 2)
+    add_vertex!(ngdyn, DynNG())
+    ngin = length(ngdyn.grv)
+    add_vertex!(ngdyn, subgraphs = ngin)
+    add_vertex!(ngdyn, SimpleGraph(2), subgraphs = ngin)
+    add_vertex!(ngdyn, DynNG(), subgraphs = ngin)
+    add_vertex!(ngdyn, subgraphs=[3,2])
+    add_vertex!(ngdyn, SimpleGraph(2), subgraphs=[3,3])
+    add_edge!(ngdyn, 1,8)
+    add_edge!(ngdyn, 2,9)
+    return ngdyn
+end
+
+function test_meta_top()
+    DynMNG = NestedGraph{Int, MetaGraph{Int,Float64}, AbstractGraph}
+    ngdyn = DynMNG(extrasubgraph=false)    
+    sg1 = MetaGraph(3)
+    [set_prop!(sg1, v, :vel, "1.$(v)") for v in vertices(sg1)]
+    add_vertex!(ngdyn, sg1)
+    add_vertex!(ngdyn, MetaGraph(6))
+    # ngdyn.grv[2] and ngdyn.flatgr `Dict` are shallow copies
+    [set_prop!(ngdyn.grv[2], v, :vel, "2.$(v)") for v in 1:6]
+    # flatnode 10 enters in vmap (1,4)
+    add_vertex!(ngdyn, :vel, "1.4")
+    add_vertex!(ngdyn, :vel, "2.7"; subgraphs = 2)
+    add_vertex!(ngdyn, DynMNG(extrasubgraph=false))
+    add_vertex!(ngdyn, :vel, "3.1.1"; subgraphs = 3)
+    sg2 = MetaGraph(2)
+    [set_prop!(sg2, v, :vel, "3.1.$(v)") for v in vertices(sg2)]
+    add_vertex!(ngdyn, sg2, subgraphs = 3)
+    add_vertex!(ngdyn, DynMNG(extrasubgraph=false), subgraphs = 3)
+    # flatnode 15 enters in subgraph (3,4) 
+    add_vertex!(ngdyn, :vel, "3.3.1",subgraphs=[3,2])
+    sg3 = MetaGraph(2)
+    [set_prop!(sg3, v, :vel, "3.3.2.$(v)") for v in vertices(sg3)]
+    add_vertex!(ngdyn, sg3, subgraphs=[3,3])
+    return ngdyn
+end