assert squareness of adj_matrix

Author: hexaeder

src/NetworkLayout.jl

@@ -69,6 +69,7 @@ struct LayoutIterator{T<:IterativeLayout,M<:AbstractMatrix}
 end
 
 function layout(alg::IterativeLayout, adj_matrix::AbstractMatrix)
+    assertsquare(adj_matrix)
     iter = LayoutIterator(alg, adj_matrix)
     next = Base.iterate(iter)
     pos = next[1]
@@ -84,6 +85,17 @@ function __init__()
     @require LightGraphs="093fc24a-ae57-5d10-9952-331d41423f4d" layout(l::AbstractLayout, g::LightGraphs.AbstractGraph) = layout(l, LightGraphs.adjacency_matrix(g))
 end
 
+"""
+    assertsquare(M)
+
+Throws `ArgumentArror` if matrix is not square. Returns size.
+"""
+function assertsquare(M::AbstractMatrix)
+    (a, b) = size(M)
+    a != b && throw(ArgumentError("Adjecency Matrix needs to be square!"))
+    return a
+end
+
 include("sfdp.jl")
 include("buchheim.jl")
 include("spring.jl")

src/buchheim.jl

@@ -64,7 +64,7 @@ function adj_mat_to_list(M::AbstractMatrix)
 end
 
 function layout(para::Buchheim, adj_matrix::AbstractMatrix)
-    @assert size(adj_matrix, 1) == size(adj_matrix, 2) "adjacency matrix not square!"
+    assertsquare(adj_matrix)
     list = adj_mat_to_list(adj_matrix)
     layout(para, list)
 end

src/circular.jl

@@ -17,11 +17,12 @@ struct Circular{Ptype} <: AbstractLayout{2,Ptype} end
 Circular(; Ptype=Float64) = Circular{Ptype}()
 
 function layout(::Circular{Ptype}, adj_matrix::AbstractMatrix) where {Ptype}
-    if size(adj_matrix, 1) == 1
+    N = assertsquare(adj_matrix)
+    if N == 1
         return Point{2,Ptype}[Point(0.0, 0.0)]
     else
         # Discard the extra angle since it matches 0 radians.
-        θ = range(0; stop=2pi, length=size(adj_matrix, 1) + 1)[1:(end - 1)]
+        θ = range(0; stop=2pi, length=N + 1)[1:(end - 1)]
         return Point{2,Ptype}[(cos(o), sin(o)) for o in θ]
     end
 end

src/shell.jl

@@ -26,11 +26,11 @@ end
 Shell(; Ptype=Float64, nlist=Vector{Int}[]) = Shell{Ptype}(nlist)
 
 function layout(algo::Shell{Ptype}, adj_matrix::AbstractMatrix) where {Ptype}
-    if size(adj_matrix, 1) == 1
+    N = assertsquare(adj_matrix)
+    if N == 1
         return Point{2,Float64}[Point(0.0, 0.0)]
     end
 
-    N = size(adj_matrix, 1)
     nlist = copy(algo.nlist)
 
     # if the list does not contain all the nodes push missing nodes to new shell

src/spectral.jl

@@ -56,11 +56,12 @@ function compute_laplacian(adj_matrix, node_weights)
 end
 
 function layout(algo::Spectral{Ptype,FT}, adj_matrix::AbstractMatrix) where {Ptype,FT}
+    N = assertsquare(adj_matrix)
     # try to use user provided nodeweights
-    nodeweights = if length(algo.nodeweights) == size(adj_matrix, 1)
+    nodeweights = if length(algo.nodeweights) == N
         algo.nodeweights
     else
-        ones(FT, size(adj_matrix, 1))
+        ones(FT, N)
     end
 
     adj_matrix = make_symmetric(adj_matrix)

src/squaregrid.jl

@@ -30,7 +30,7 @@ function SquareGrid(; Ptype=Float64, cols=:auto, dx=Ptype(1), dy=Ptype(-1), skip
 end
 
 function layout(algo::SquareGrid{Ptype}, adj_matrix::AbstractMatrix) where {Ptype}
-    N = size(adj_matrix, 1)
+    N = assertsquare(adj_matrix)
     M = N + length(algo.skip)
 
     if algo.cols === :auto

test/runtests.jl

@@ -281,4 +281,20 @@ jagmesh_adj = jagmesh()
         pos = Spring()(g)
         @test pos isa Vector{Point{2,Float64}}
     end
+
+    @testset "test assert square" begin
+        using NetworkLayout: assertsquare
+        M1 = rand(2,4)
+        @test_throws ArgumentError assertsquare(M1)
+        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)
+        @test_throws ArgumentError layout(Spring(), M1)
+        @test_throws ArgumentError layout(SquareGrid(), M1)
+        @test_throws ArgumentError layout(Stress(), M1)
+    end
 end