[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 <mfishman@flatironinstitute.org>, Joseph Tindall <jtindall@flatironinstitute.org> 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"

ext/NamedGraphsKaHyParExt/NamedGraphsKaHyParExt.jl

@@ -27,14 +27,14 @@ const KAHYPAR_ALGS = Dict(
 )
 
 """
-partitioned_vertices(::Backend"kahypar", g::Graph, npartiations::Integer; objective="edge_cut", alg="kway", kwargs...)
+    partition_vertices(::Backend"kahypar", g::Graph, npartiations::Integer; objective="edge_cut", alg="kway", kwargs...)
 
 - default_configuration => "cut_kKaHyPar_sea20.ini"
 - :edge_cut => "cut_kKaHyPar_sea20.ini"
 - :connectivity => "km1_kKaHyPar_sea20.ini"
 - imbalance::Number=0.03
 """
-function GraphsExtensions.partitioned_vertices(
+function GraphsExtensions.partition_vertices(
         ::Backend"kahypar",
         g::AbstractSimpleGraph,
         npartitions::Integer;

ext/NamedGraphsMetisExt/NamedGraphsMetisExt.jl

@@ -10,14 +10,14 @@ GraphsExtensions.set_partitioning_backend!(Backend"metis"())
 const METIS_ALGS = Dict(["kway" => :KWAY, "recursive" => :RECURSIVE])
 
 """
-    partitioned_vertices(::Backend"metis", g::AbstractGraph, npartitions::Integer; alg="recursive")
+    partition_vertices(::Backend"metis", g::AbstractGraph, npartitions::Integer; alg="recursive")
 
 Partition the graph `G` in `n` parts.
 The partition algorithm is defined by the `alg` keyword:
  - :KWAY: multilevel k-way partitioning
  - :RECURSIVE: multilevel recursive bisection
 """
-function GraphsExtensions.partitioned_vertices(
+function GraphsExtensions.partition_vertices(
         ::Backend"metis", g::AbstractSimpleGraph, npartitions::Integer; alg = "recursive", kwargs...
     )
     metis_alg = METIS_ALGS[alg]

src/abstractnamedgraph.jl

@@ -32,7 +32,7 @@ using .GraphsExtensions:
     GraphsExtensions,
     directed_graph,
     incident_edges,
-    partitioned_vertices,
+    partition_vertices,
     rename_vertices,
     subgraph
 using SimpleTraits: SimpleTraits, Not, @traitfn
@@ -66,7 +66,8 @@ vertex_positions(graph::AbstractNamedGraph) = not_implemented()
 # returns the corresponding vertex.
 ordered_vertices(graph::AbstractNamedGraph) = not_implemented()
 
-Graphs.edgetype(graph::AbstractNamedGraph) = not_implemented()
+Graphs.edgetype(graph::AbstractNamedGraph) = edgetype(typeof(graph))
+Graphs.edgetype(::Type{<:AbstractNamedGraph}) = not_implemented()
 
 # TODO: Define generic version in `GraphsExtensions`.
 GraphsExtensions.directed_graph_type(G::Type{<:AbstractNamedGraph}) = not_implemented()
@@ -285,10 +286,10 @@ function Graphs.mincut(graph::AbstractNamedGraph, distmx::AbstractMatrix{<:Real}
 end
 
 # TODO: Make this more generic?
-function GraphsExtensions.partitioned_vertices(
+function GraphsExtensions.partition_vertices(
         graph::AbstractNamedGraph; npartitions = nothing, nvertices_per_partition = nothing, kwargs...
     )
-    vertex_partitions = partitioned_vertices(
+    vertex_partitions = partition_vertices(
         position_graph(graph); npartitions, nvertices_per_partition, kwargs...
     )
     # TODO: output the reverse of this dictionary (a Vector of Vector
@@ -446,13 +447,10 @@ function Graphs.blockdiag(graph1::AbstractNamedGraph, graph2::AbstractNamedGraph
     return GenericNamedGraph(new_position_graph, new_vertices)
 end
 
-# TODO: What `args` are needed?
-Graphs.nv(graph::AbstractNamedGraph, args...) = nv(position_graph(graph), args...)
-# TODO: What `args` are needed?
-Graphs.ne(graph::AbstractNamedGraph, args...) = ne(position_graph(graph), args...)
-# TODO: What `args` are needed?
-function Graphs.adjacency_matrix(graph::AbstractNamedGraph, args...)
-    return adjacency_matrix(position_graph(graph), args...)
+Graphs.nv(graph::AbstractNamedGraph) = nv(position_graph(graph))
+Graphs.ne(graph::AbstractNamedGraph) = ne(position_graph(graph))
+function Graphs.adjacency_matrix(graph::AbstractNamedGraph)
+    return adjacency_matrix(position_graph(graph))
 end
 
 function Graphs.connected_components(graph::AbstractNamedGraph)

src/lib/GraphsExtensions/src/partitioning.jl

@@ -54,7 +54,7 @@ function _npartitions(
     return error("Must specify either `npartitions` or `nvertices_per_partition`")
 end
 
-function partitioned_vertices(
+function partition_vertices(
         g::AbstractSimpleGraph;
         npartitions = nothing,
         nvertices_per_partition = nothing,
@@ -66,11 +66,7 @@ function partitioned_vertices(
     if (_npartitions(g, npartitions, nvertices_per_partition) == 1)
         return group(v -> 1, collect(vertices(g)))
     end
-    return partitioned_vertices(
+    return partition_vertices(
         Backend(backend), g, _npartitions(g, npartitions, nvertices_per_partition); kwargs...
     )
 end
-
-function partitioned_vertices(g::AbstractGraph; kwargs...)
-    return not_implemented()
-end

src/lib/PartitionedGraphs/src/PartitionedGraphs.jl

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