remove Circular layout, Shell() does the same

Author: hexaeder

docs/src/index.md

@@ -118,18 +118,7 @@ nothing #hide
 ```
 ![stress animation](stress_animation.mp4)
 
-##  Circular Layout
-```@docs
-Circular
-```
-```@example layouts
-g = smallgraph(:karate)
-layout = Circular()
-f, ax, p = graphplot(g, layout=layout)
-hidedecorations!(ax); hidespines!(ax); ax.aspect = DataAspect(); f #hide
-```
-
-##  Shell Layout
+##  Shell/Circular Layout
 ```@docs
 Shell
 ```

src/NetworkLayout.jl

@@ -101,7 +101,6 @@ include("buchheim.jl")
 include("spring.jl")
 include("stress.jl")
 include("spectral.jl")
-include("circular.jl")
 include("shell.jl")
 include("squaregrid.jl")
 

src/circular.jl

@@ -4,7 +4,9 @@ export Shell
     Shell(; kwargs...)(adj_matrix)
     layout(algo::Shell, adj_matrix)
 
-Position nodes in conenctric circles.
+Position nodes in concentric circles. Without further arguments all nodes will
+be placed on a circle with radius 1.0. Specify placement of nodes using the
+`nlist` argument.
 
 Takes adjacency matrix representation of a network and returns coordinates of
 the nodes.
@@ -13,9 +15,9 @@ the nodes.
 - `Ptype=Float64`: Determines the output type `Point{2,Ptype}`.
 - `nlist=Vector{Int}[]`
 
-  List of node-lists for each shell from inner to outer. Tells the algorithm
-  which node idx to place on which circle. Nodes which are not present in this
-  list will be place on additional outermost shell.
+  Vector of Vector of node indices. Tells the algorithm, which nodes to place on
+  which shell from inner to outer. Nodes which are not present in this list will
+  be place on additional outermost shell.
 
 This function started as a copy from [IainNZ](https://github.com/IainNZ)'s [GraphLayout.jl](https://github.com/IainNZ/GraphLayout.jl)
 """
@@ -27,9 +29,6 @@ Shell(; Ptype=Float64, nlist=Vector{Int}[]) = Shell{Ptype}(nlist)
 
 function layout(algo::Shell{Ptype}, adj_matrix::AbstractMatrix) where {Ptype}
     N = assertsquare(adj_matrix)
-    if N == 1
-        return Point{2,Float64}[Point(0.0, 0.0)]
-    end
 
     nlist = copy(algo.nlist)
 
@@ -41,6 +40,7 @@ function layout(algo::Shell{Ptype}, adj_matrix::AbstractMatrix) where {Ptype}
         push!(nlist, diff)
     end
 
+    # if there is more than one node in the innermost shell start with radius 1.0
     radius = 0.0
     if length(nlist[1]) > 1
         radius = 1.0

src/shell.jl

@@ -160,24 +160,6 @@ jagmesh_adj = jagmesh()
         end
     end
 
-    @testset "Testing Circular Layout Algorithm" begin
-        println("Circular wheel_graph")
-        @testset "Testing wheel_graph" begin
-            g = wheel_graph(10)
-            adj_matrix = adjacency_matrix(g)
-            positions = @time Circular()(adj_matrix)
-            @test typeof(positions) == Vector{Point{2,Float64}}
-            positions = @time Circular(; Ptype=Float32)(adj_matrix)
-            @test typeof(positions) == Vector{Point{2,Float32}}
-        end
-        @testset "Testing Base Case" begin
-            g = Graph(1)
-            adj_matrix = adjacency_matrix(g)
-            positions = @time Circular()(adj_matrix)
-            @test typeof(positions) == Vector{Point{2,Float64}}
-        end
-    end
-
     @testset "Testing Shell Layout Algorithm" begin
         println("Shell wheel_graph")
 
@@ -289,7 +271,6 @@ jagmesh_adj = jagmesh()
         M2 = rand(4,4)
         @test assertsquare(M2) == 4
         @test_throws ArgumentError layout(Buchheim(), M1)
-        @test_throws ArgumentError layout(Circular(), M1)
         @test_throws ArgumentError layout(SFDP(), M1)
         @test_throws ArgumentError layout(Shell(), M1)
         @test_throws ArgumentError layout(Spectral(), M1)