[PartitionedGraphs] Rename various types and functions to improve clarity.

Project.toml

@@ -1,7 +1,7 @@
 name = "NamedGraphs"
 uuid = "678767b0-92e7-4007-89e4-4527a8725b19"
 authors = ["Matthew Fishman <[email protected]>, Joseph Tindall <[email protected]> and contributors"]
-version = "0.7.4"
+version = "0.8.0"
 
 [deps]
 AbstractTrees = "1520ce14-60c1-5f80-bbc7-55ef81b5835c"

docs/Project.toml

@@ -6,4 +6,4 @@ NamedGraphs = "678767b0-92e7-4007-89e4-4527a8725b19"
 [compat]
 Documenter = "1.10"
 Literate = "2.20.1"
-NamedGraphs = "0.7"
+NamedGraphs = "0.8"

examples/Project.toml

@@ -4,4 +4,4 @@ NamedGraphs = "678767b0-92e7-4007-89e4-4527a8725b19"
 
 [compat]
 Graphs = "1.12.0"
-NamedGraphs = "0.7.0"
+NamedGraphs = "0.8.0"

src/lib/PartitionedGraphs/src/PartitionedGraphs.jl

@@ -1,9 +1,9 @@
 module PartitionedGraphs
-include("abstractpartitionvertex.jl")
-include("abstractpartitionedge.jl")
+include("abstractsupervertex.jl")
+include("abstractsuperedge.jl")
 include("abstractpartitionedgraph.jl")
-include("partitionvertex.jl")
-include("partitionedge.jl")
+include("supervertex.jl")
+include("superedge.jl")
 include("partitionedgraph.jl")
-include("partitionsgraphview.jl")
+include("quotientgraph.jl")
 end

src/lib/PartitionedGraphs/src/abstractpartitionedgraph.jl

@@ -16,33 +16,31 @@ using ..NamedGraphs.GraphsExtensions:
 abstract type AbstractPartitionedGraph{V, PV} <: AbstractNamedGraph{V} end
 
 #Needed for interface
-partitions_graph(pg::AbstractPartitionedGraph) = not_implemented()
+quotient_graph(pg::AbstractPartitionedGraph) = not_implemented()
 unpartitioned_graph(pg::AbstractPartitionedGraph) = not_implemented()
 function unpartitioned_graph_type(pg::Type{<:AbstractPartitionedGraph})
     return not_implemented()
 end
-partitionvertex(pg::AbstractPartitionedGraph, vertex) = not_implemented()
-partitionvertices(pg::AbstractPartitionedGraph, verts) = not_implemented()
-partitionvertices(pg::AbstractPartitionedGraph) = not_implemented()
+supervertex(pg::AbstractPartitionedGraph, vertex) = not_implemented()
+supervertex(pg::AbstractPartitionedGraph) = not_implemented()
 Base.copy(pg::AbstractPartitionedGraph) = not_implemented()
 delete_from_vertex_map!(pg::AbstractPartitionedGraph, vertex) = not_implemented()
 insert_to_vertex_map!(pg::AbstractPartitionedGraph, vertex) = not_implemented()
-partitionedge(pg::AbstractPartitionedGraph, edge) = not_implemented()
-partitionedges(pg::AbstractPartitionedGraph, edges) = not_implemented()
-partitionedges(pg::AbstractPartitionedGraph) = not_implemented()
+superedge(pg::AbstractPartitionedGraph, edge) = not_implemented()
+superedges(pg::AbstractPartitionedGraph) = not_implemented()
 function unpartitioned_graph_type(pg::AbstractPartitionedGraph)
     return typeof(unpartitioned_graph(pg))
 end
 
-function Graphs.edges(pg::AbstractPartitionedGraph, partitionedge::AbstractPartitionEdge)
+function Graphs.edges(pg::AbstractPartitionedGraph, superedge::AbstractSuperEdge)
     return not_implemented()
 end
-function Graphs.vertices(pg::AbstractPartitionedGraph, pv::AbstractPartitionVertex)
+function Graphs.vertices(pg::AbstractPartitionedGraph, supervertex::AbstractSuperVertex)
     return not_implemented()
 end
 function Graphs.vertices(
-        pg::AbstractPartitionedGraph, partitionverts::Vector{V}
-    ) where {V <: AbstractPartitionVertex}
+        pg::AbstractPartitionedGraph, supervertices::Vector{V}
+    ) where {V <: AbstractSuperVertex}
     return not_implemented()
 end
 function GraphsExtensions.directed_graph_type(PG::Type{<:AbstractPartitionedGraph})
@@ -69,102 +67,102 @@ function NamedGraphs.ordered_vertices(pg::AbstractPartitionedGraph)
     return NamedGraphs.ordered_vertices(unpartitioned_graph(pg))
 end
 Graphs.edgetype(pg::AbstractPartitionedGraph) = edgetype(unpartitioned_graph(pg))
-function Graphs.nv(pg::AbstractPartitionedGraph, pv::AbstractPartitionVertex)
-    return length(vertices(pg, pv))
+function Graphs.nv(pg::AbstractPartitionedGraph, sv::AbstractSuperVertex)
+    return length(vertices(pg, sv))
 end
 function Graphs.has_vertex(
-        pg::AbstractPartitionedGraph, partitionvertex::AbstractPartitionVertex
+        pg::AbstractPartitionedGraph, supervertex::AbstractSuperVertex
     )
-    return has_vertex(partitions_graph(pg), parent(partitionvertex))
+    return has_vertex(quotient_graph(pg), parent(supervertex))
 end
 
-function Graphs.has_edge(pg::AbstractPartitionedGraph, partitionedge::AbstractPartitionEdge)
-    return has_edge(partitions_graph(pg), parent(partitionedge))
+function Graphs.has_edge(pg::AbstractPartitionedGraph, superedge::AbstractSuperEdge)
+    return has_edge(quotient_graph(pg), parent(superedge))
 end
 
 function is_boundary_edge(pg::AbstractPartitionedGraph, edge::AbstractEdge)
-    p_edge = partitionedge(pg, edge)
+    p_edge = superedge(pg, edge)
     return src(p_edge) == dst(p_edge)
 end
 
 function Graphs.add_edge!(pg::AbstractPartitionedGraph, edge::AbstractEdge)
     add_edge!(unpartitioned_graph(pg), edge)
-    pg_edge = parent(partitionedge(pg, edge))
+    pg_edge = parent(superedge(pg, edge))
     if src(pg_edge) != dst(pg_edge)
-        add_edge!(partitions_graph(pg), pg_edge)
+        add_edge!(quotient_graph(pg), pg_edge)
     end
     return pg
 end
 
 function Graphs.rem_edge!(pg::AbstractPartitionedGraph, edge::AbstractEdge)
-    pg_edge = partitionedge(pg, edge)
-    if has_edge(partitions_graph(pg), pg_edge)
+    pg_edge = superedge(pg, edge)
+    if has_edge(quotient_graph(pg), pg_edge)
         g_edges = edges(pg, pg_edge)
         if length(g_edges) == 1
-            rem_edge!(partitions_graph(pg), pg_edge)
+            rem_edge!(quotient_graph(pg), pg_edge)
         end
     end
     return rem_edge!(unpartitioned_graph(pg), edge)
 end
 
 function Graphs.rem_edge!(
-        pg::AbstractPartitionedGraph, partitionedge::AbstractPartitionEdge
+        pg::AbstractPartitionedGraph, superedge::AbstractSuperEdge
     )
-    return rem_edges!(pg, edges(pg, parent(partitionedge)))
+    return rem_edges!(pg, edges(pg, parent(superedge)))
 end
 
 #Vertex addition and removal. I think it's important not to allow addition of a vertex without specification of PV
 function Graphs.add_vertex!(
-        pg::AbstractPartitionedGraph, vertex, partitionvertex::AbstractPartitionVertex
+        pg::AbstractPartitionedGraph, vertex, supervertex::AbstractSuperVertex
     )
     add_vertex!(unpartitioned_graph(pg), vertex)
-    add_vertex!(partitions_graph(pg), parent(partitionvertex))
-    insert_to_vertex_map!(pg, vertex, partitionvertex)
+    add_vertex!(quotient_graph(pg), parent(supervertex))
+    insert_to_vertex_map!(pg, vertex, supervertex)
     return pg
 end
 
 function GraphsExtensions.add_vertices!(
         pg::AbstractPartitionedGraph,
         vertices::Vector,
-        partitionvertices::Vector{<:AbstractPartitionVertex},
+        supervertices::Vector{<:AbstractSuperVertex},
     )
-    @assert length(vertices) == length(partitionvertices)
-    for (v, pv) in zip(vertices, partitionvertices)
-        add_vertex!(pg, v, pv)
+    @assert length(vertices) == length(supervertices)
+    for (v, sv) in zip(vertices, supervertices)
+        add_vertex!(pg, v, sv)
     end
 
     return pg
 end
 
 function GraphsExtensions.add_vertices!(
-        pg::AbstractPartitionedGraph, vertices::Vector, partitionvertex::AbstractPartitionVertex
+        pg::AbstractPartitionedGraph, vertices::Vector, supervertex::AbstractSuperVertex
     )
-    add_vertices!(pg, vertices, fill(partitionvertex, length(vertices)))
+    add_vertices!(pg, vertices, fill(supervertex, length(vertices)))
     return pg
 end
 
 function Graphs.rem_vertex!(pg::AbstractPartitionedGraph, vertex)
-    pv = partitionvertex(pg, vertex)
-    delete_from_vertex_map!(pg, pv, vertex)
+    sv = supervertex(pg, vertex)
+    delete_from_vertex_map!(pg, sv, vertex)
     rem_vertex!(unpartitioned_graph(pg), vertex)
-    if !haskey(partitioned_vertices(pg), parent(pv))
-        rem_vertex!(partitions_graph(pg), parent(pv))
+    if !haskey(partitioned_vertices(pg), parent(sv))
+        rem_vertex!(quotient_graph(pg), parent(sv))
     end
     return pg
 end
 
 function Graphs.rem_vertex!(
-        pg::AbstractPartitionedGraph, partitionvertex::AbstractPartitionVertex
+        pg::AbstractPartitionedGraph, supervertex::AbstractSuperVertex
     )
-    rem_vertices!(pg, vertices(pg, partitionvertex))
+    rem_vertices!(pg, vertices(pg, supervertex))
     return pg
 end
 
 function GraphsExtensions.rem_vertex(
-        pg::AbstractPartitionedGraph, partitionvertex::AbstractPartitionVertex
+        pg::AbstractPartitionedGraph, supervertex::AbstractSuperVertex
     )
     pg_new = copy(pg)
-    rem_vertex!(pg_new, partitionvertex)
+    rem_vertex!(pg_new, supervertex)
     return pg_new
 end
 
@@ -174,25 +172,25 @@ end
 
 function Base.:(==)(pg1::AbstractPartitionedGraph, pg2::AbstractPartitionedGraph)
     if unpartitioned_graph(pg1) != unpartitioned_graph(pg2) ||
-            partitions_graph(pg1) != partitions_graph(pg2)
+            quotient_graph(pg1) != quotient_graph(pg2)
         return false
     end
     for v in vertices(pg1)
-        if partitionvertex(pg1, v) != partitionvertex(pg2, v)
+        if supervertex(pg1, v) != supervertex(pg2, v)
             return false
         end
     end
     return true
 end
 
 function GraphsExtensions.subgraph(
-        pg::AbstractPartitionedGraph, partitionvertex::AbstractPartitionVertex
+        pg::AbstractPartitionedGraph, supervertex::AbstractSuperVertex
     )
-    return first(induced_subgraph(unpartitioned_graph(pg), vertices(pg, [partitionvertex])))
+    return first(induced_subgraph(unpartitioned_graph(pg), vertices(pg, [supervertex])))
 end
 
 function Graphs.induced_subgraph(
-        pg::AbstractPartitionedGraph, partitionvertex::AbstractPartitionVertex
+        pg::AbstractPartitionedGraph, supervertex::AbstractSuperVertex
     )
-    return subgraph(pg, partitionvertex), nothing
+    return subgraph(pg, supervertex), nothing
 end

src/lib/PartitionedGraphs/src/abstractsuperedge.jl

@@ -0,0 +1,11 @@
+using Graphs: Graphs
+using ..NamedGraphs: AbstractNamedEdge
+
+abstract type AbstractSuperEdge{V} <: AbstractNamedEdge{V} end
+
+Base.parent(se::AbstractSuperEdge) = not_implemented()
+Graphs.src(se::AbstractSuperEdge) = not_implemented()
+Graphs.dst(se::AbstractSuperEdge) = not_implemented()
+Base.reverse(se::AbstractSuperEdge) = not_implemented()
+
+#Don't have the vertices wrapped. But wrap them with source and edge.

src/lib/PartitionedGraphs/src/abstractsupervertex.jl

@@ -0,0 +1,4 @@
+abstract type AbstractSuperVertex{V} <: Any where {V} end
+
+#Parent, wrap, unwrap, vertex?
+Base.parent(sv::AbstractSuperVertex) = not_implemented()