Document default direction (:both) in laplacian_matrix and others (…

…#41) Partially solves #24 without breaking backwards compatibility
JuliaGraphs · Apr 6, 2023 · d995ffd · d995ffd
1 parent 4b2d7ff
commit d995ffd
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 7 deletions.
diff --git a/src/overrides.jl b/src/overrides.jl
@@ -1,7 +1,7 @@
 """
     degree_matrix(g, T; dir)
 
-Construct the weighted diagonal degree matrix, filled with element type `T` and considering edge direction `dir ∈ [:in, :out, :both]`.
+Construct the weighted diagonal degree matrix, filled with element type `T` and considering edge direction `dir ∈ [:in, :out, :both]` (default is `:out`).
 """
 function degree_matrix(
     g::AbstractSimpleWeightedGraph, T::DataType=weighttype(g); dir::Symbol=:out
@@ -25,7 +25,7 @@ end
 """
     Graphs.adjacency_matrix(g, T; dir)
 
-Construct the weighted adjacency matrix, filled with element type `T` and considering edge direction `dir ∈ [:in, :out, :both]`.
+Construct the weighted adjacency matrix, filled with element type `T` and considering edge direction `dir ∈ [:in, :out, :both]` (default is `:out`).
 """
 function Graphs.adjacency_matrix(
     g::AbstractSimpleWeightedGraph, T::DataType=weighttype(g); dir::Symbol=:out
@@ -40,7 +40,7 @@ end
 """
     Graphs.laplacian_matrix(g, T; dir)
 
-Subtract the adjacency matrix to the degree matrix, both filled with element type `T` and considering edge direction `dir ∈ [:in, :out, :both]`.
+Subtract the adjacency matrix to the degree matrix, both filled with element type `T` and considering edge direction `dir ∈ [:in, :out, :both]` (unlike in Graphs.jl, default is `:out`).
 """
 function Graphs.laplacian_matrix(
     g::AbstractSimpleWeightedGraph, T::DataType=weighttype(g); dir::Symbol=:out

diff --git a/test/overrides.jl b/test/overrides.jl
@@ -47,8 +47,8 @@
         @test degree_matrix(g, Float64; dir=:out) == degree_matrix(g, Float64; dir=:in)
         @test adjacency_matrix(g)[2, 4] == 0
         @test adjacency_matrix(g; dir=:out) == adjacency_matrix(g; dir=:in)'
-        @test issymmetric(laplacian_matrix(g))
-        @test laplacian_matrix(g, Float64) ≈ g3_l
+        @test issymmetric(laplacian_matrix(g; dir=:out))
+        @test laplacian_matrix(g, Float64; dir=:out) ≈ g3_l
         @test g[1:3] == SimpleWeightedGraph{eltype(g),weighttype(g)}(path_graph(3))
         gx = copy(g)
         add_edge!(gx, 2, 3, 99)
@@ -74,8 +74,8 @@
         @test_throws DomainError degree_matrix(g, dir=:other)
         @test @inferred(adjacency_matrix(g, Int64)) == adjacency_matrix(g, Int64; dir=:out)
         @test adjacency_matrix(g; dir=:out) == adjacency_matrix(g; dir=:in)'
-        @test !issymmetric(laplacian_matrix(g))
-        @test laplacian_matrix(g, Float64) ≈ g5_l
+        @test !issymmetric(laplacian_matrix(g; dir=:out))
+        @test laplacian_matrix(g, Float64; dir=:out) ≈ g5_l
         @test @inferred(pagerank(g))[3] ≈ 0.2266 atol = 0.001
         @test length(@inferred(pagerank(g))) == nv(g)
         @test_throws ErrorException pagerank(g, 2)