Migrate from LightGraphs to Graphs.jl

simonschoelly · simonschoelly · commit 769510d63dfe · 2021-10-17T18:23:05.000+02:00
diff --git a/.travis.yml b/.travis.yml
diff --git a/LICENSE.md b/LICENSE.md
@@ -1,4 +1,4 @@
-The LightGraphsMatching.jl package is licensed under the Simplified "2-clause" BSD License:
+The GraphsMatching.jl package is licensed under the Simplified "2-clause" BSD License:
 
 > Copyright (c) 2017: mbesancon.
 > All rights reserved.
diff --git a/Project.toml b/Project.toml
@@ -1,22 +1,22 @@
-name = "LightGraphsMatching"
+name = "GraphsMatching"
 uuid = "160ba089-64bf-5ba7-9e14-98ab1d9bcb0a"
 authors = ["JuliaGraphs"]
-version = "0.2.0"
+version = "0.1.0"
 
 [deps]
 BlossomV = "6c721016-9dae-5d90-abf6-67daaccb2332"
+Graphs = "86223c79-3864-5bf0-83f7-82e725a168b6"
 Hungarian = "e91730f6-4275-51fb-a7a0-7064cfbd3b39"
 JuMP = "4076af6c-e467-56ae-b986-b466b2749572"
-LightGraphs = "093fc24a-ae57-5d10-9952-331d41423f4d"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 MathOptInterface = "b8f27783-ece8-5eb3-8dc8-9495eed66fee"
 SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
 
 [compat]
 BlossomV = "0.4"
+Graphs = "1.4.0"
 Hungarian = "0.4"
 JuMP = "0.20"
-LightGraphs = "1.2"
 MathOptInterface = "0.9"
 julia = "1"
 
diff --git a/README.md b/README.md
@@ -1,12 +1,12 @@
-# LightGraphsMatching
+# GraphsMatching
 
-[![Build Status](https://travis-ci.org/JuliaGraphs/LightGraphsMatching.jl.svg?branch=master)](https://travis-ci.org/JuliaGraphs/LightGraphsMatching.jl)
+[![Build Status](https://travis-ci.org/JuliaGraphs/GraphsMatching.jl.svg?branch=master)](https://travis-ci.org/JuliaGraphs/GraphsMatching.jl)
 
-[![Coverage Status](https://coveralls.io/repos/github/JuliaGraphs/LightGraphsMatching.jl/badge.svg?branch=master)](https://coveralls.io/github/JuliaGraphs/LightGraphsMatching.jl?branch=master)
+[![Coverage Status](https://coveralls.io/repos/github/JuliaGraphs/GraphsMatching.jl/badge.svg?branch=master)](https://coveralls.io/github/JuliaGraphs/GraphsMatching.jl?branch=master)
 
-[![codecov](https://codecov.io/gh/JuliaGraphs/LightGraphsMatching.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/JuliaGraphs/LightGraphsMatching.jl)
+[![codecov](https://codecov.io/gh/JuliaGraphs/GraphsMatching.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/JuliaGraphs/GraphsMatching.jl)
 
-Matching algorithms on top of [LightGraphs](https://github.com/JuliaGraphs/LightGraphs.jl).
+Matching algorithms on top of [Graphs.jl](https://github.com/JuliaGraphs/Graphs.jl).
 
 ## Usage
 
diff --git a/appveyor.yml b/appveyor.yml
@@ -26,10 +26,10 @@ build_script:
 # Need to convert from shallow to complete for Pkg.clone to work
   - IF EXIST .git\shallow (git fetch --unshallow)
   - C:\julia\bin\julia -e "using InteractiveUtils, Pkg; versioninfo();
-        Pkg.clone(pwd(), \"LightGraphsMatching\"); Pkg.build(\"LightGraphsMatching\")"
+        Pkg.clone(pwd(), \"GraphsMatching\"); Pkg.build(\"GraphsMatching\")"
 
 test_script:
-    - C:\julia\bin\julia -e "using Pkg; Pkg.test(\"LightGraphsMatching\")"
+    - C:\julia\bin\julia -e "using Pkg; Pkg.test(\"GraphsMatching\")"
 
 # # Uncomment to support code coverage upload. Should only be enabled for packages
 # # which would have coverage gaps without running on Windows
diff --git a/docs/make.jl b/docs/make.jl
@@ -1,11 +1,11 @@
 using Documenter
-using LightGraphsMatching
-import LightGraphs; const lg = LightGraphs
+using GraphsMatching
+import Graphs
 
 makedocs(
-    modules = [LightGraphsMatching],
+    modules = [GraphsMatching],
     format = :html,
-    sitename = "LightGraphsMatching",
+    sitename = "GraphsMatching",
 	pages = Any[
 		"Getting started"         => "index.md",
     ]
@@ -14,7 +14,7 @@ makedocs(
 deploydocs(
     deps        = nothing,
     make        = nothing,
-    repo        = "github.com/JuliaGraphs/LightGraphsMatching.jl.git",
+    repo        = "github.com/JuliaGraphs/GraphsMatching.jl.git",
     target      = "build",
     julia       = "0.6",
     osname      = "linux"
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -1,6 +1,6 @@
-site_name:        LightGraphsMatching.jl
-repo_url:         https://github.com/JuliaGraphs/LightGraphsMatching.jl
-site_description: Documentation for LightGraphsMatching, the JuliaGraphs package to solve matching problems
+site_name:        GraphsMatching.jl
+repo_url:         https://github.com/JuliaGraphs/GraphsMatching.jl
+site_description: Documentation for GraphsMatching, the JuliaGraphs package to solve matching problems
 site_author:      JuliaGraphs
 
 theme: material
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -1,26 +1,24 @@
- # LightGraphsMatching.jl: matching algorithms for LightGraphs
+ # GraphsMatching.jl: matching algorithms for Graphs.jl
 
 ```@meta
-CurrentModule = LightGraphsMatching
+CurrentModule = GraphsMatching
 DocTestSetup = quote
-    using LightGraphsMatching
-    import LightGraphs
-    const lg = LightGraphs
+    using GraphsMatching
+    import Graphs
 end
 ```
 
-This is the documentation page for `LightGraphsMatching`. 
-In all documentation examples, we assume LightGraphsMatching has been imported into scope
-and that LightGraphs is available with the alias `lg`:
+This is the documentation page for `GraphsMatching`.
+In all documentation examples, we assume GraphsMatching has been imported into scope
+and that Graphs.jl is imported:
 ```julia
-using LightGraphsMatching
-import LightGraphs
-const lg = LightGraphs
+using GraphsMatching
+import Graphs
 ```
 
 ```@autodocs
-Modules = [LightGraphsMatching]
-Pages = ["LightGraphsMatching.jl", "maximum_weight_matching.jl", "lp.jl", "blossomv.jl"]
+Modules = [GraphsMatching]
+Pages = ["GraphsMatching.jl", "maximum_weight_matching.jl", "lp.jl", "blossomv.jl"]
 Order = [:function, :type]
 ```
 
diff --git a/src/GraphsMatching.jl b/src/GraphsMatching.jl
@@ -1,6 +1,6 @@
-module LightGraphsMatching
+module GraphsMatching
 
-using LightGraphs
+using Graphs
 
 using SparseArrays: spzeros
 
diff --git a/src/hungarian.jl b/src/hungarian.jl
@@ -6,7 +6,7 @@ function maximum_weight_maximal_matching_hungarian(g::Graph,
   # Determine the bipartition of the graph. 
   bipartition = bipartite_map(g)
   if length(bipartition) != n # Equivalent to !is_bipartite(g), but reuses the results of the previous function call.
-    error("The Hungarian algorithm only works for bipartite graphs; otherwise, prefer the Blossom algorithm (not yet available in LightGraphsMatching")
+    error("The Hungarian algorithm only works for bipartite graphs; otherwise, prefer the Blossom algorithm (not yet available in GraphsMatching")
   end
   n_first = count(bipartition .== 1)
   n_second = count(bipartition .== 2)
diff --git a/test/runtests.jl b/test/runtests.jl
@@ -1,11 +1,11 @@
-using LightGraphs
-using LightGraphsMatching
+using Graphs
+using GraphsMatching
 using Test
 using Cbc
 using JuMP
 using LinearAlgebra: I
 
-@testset "LightGraphsMatching" begin
+@testset "GraphsMatching" begin
 
 @testset "maximum_weight_matching" begin
     g = complete_graph(3)

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-The LightGraphsMatching.jl package is licensed under the Simplified "2-clause" BSD License:`
	`1`	`+The GraphsMatching.jl package is licensed under the Simplified "2-clause" BSD License:`
`2`	`2`
`3`	`3`	`> Copyright (c) 2017: mbesancon.`
`4`	`4`	`> All rights reserved.`