Release 4.0.0

Author: davecom

CHANGELOG.md

@@ -1,3 +1,11 @@
+###4.0.0
+- **This is an API breaking change due to addEdge() changes**
+- addEdge(_ e: E, directed: Bool) deprecated in favor of just addEdge(_ e: E) since Edge already has a *directed* property (@Vithanco)
+- Fix generic paramter name shadowing for Swift 6 compatibility
+- Count paths between vertices (@sbeitzel)
+- Improve performance of detectCycles() (@automaciej)
+- Indegree and Outdegree methods (@TizianoCoroneo)
+
 ### 3.1.0
 - Reverse a graph with `reversed()` (@mattpaletta)
 - Performance improvement to `topologicalSort()` (@dabbott)

CONTRIBUTORS.md

@@ -13,16 +13,16 @@ SwiftGraph is being used in several real-world and hobby projects. The most nota
 ## Contributors
 
 SwiftGraph has been worked on by the following people:
-- David Kopec (@davecom) - I started the project in 2014 and I have been maintaining it ever since; I wrote most of the code between 2014-2017
-- Ferran Pujol Camins (@ferranpujolcamins) - Ferran got us setup with continuous integration, added the `UniqueVerticesGraph` class and its supporting machinery, refactored some of the search algorithms, cleaned up several miscellaneous sections, and is working on Graphviz support. He was the primary force behind SwiftGraph in 2018-2019.
+- David Kopec (@davecom) - I started the project in 2014 and I have been maintaining it ever since; I wrote most of the initial code between 2014-2017
+- Ferran Pujol Camins (@ferranpujolcamins) - Ferran got us setup with continuous integration, added the `UniqueVerticesGraph` class and its supporting machinery, refactored some of the search algorithms, and cleaned up several miscellaneous sections. He was the primary force behind SwiftGraph in 2018-2019.
 - Zev Eisenberg (@ZevEisenberg) - Added the original cycle detection algorithms and provided miscellaneous bug fixes.
 - Kevin Lundberg (@klundberg) - Added Carthage support.
 - Ian Grossberg (@yoiang) - Helped with Codable support
 - Devin Abbott (@dabbott) - Improved the performance of `topologicalSort()`
 - Matt Paletta (@mattpaletta) - Added `reversed()`
+- Tiziano Coroneo (@TizianoCoroneo) - Added indegree and outdegree methods
+- Maciej Bliziński (@automaciej) - Improved detectCycles() performance
+- Vithanco (@vithanco) - Improved addEdge()
+- Stephen Beitzel (@sbeitzel) - Added counting paths between vertices
 
-Thank you to everyone who has contributed, including those not listed, who made smaller contributions. If I forgot you and you made a significant contribution to SwiftGraph, please make a pull request to this document.
-
-### Designated Successor
-
-Should I become incapacitated, or for some reason I stop responding for more than six months, it's my wish that Ferran takeover the project. If SwiftGraph becomes more popular and we need a more sophisticated governance structure, I'm happy to put that in place.
+Thank you to everyone who has contributed, including those not listed, who made smaller contributions. If I forgot you and you made a significant contribution to SwiftGraph, please make a pull request to this document.

README.md

@@ -16,6 +16,10 @@ It includes copious in-source documentation, unit tests, as well as search funct
 
 SwiftGraph 3.0 and above requires Swift 5 (Xcode 10.2). Use SwiftGraph 2.0 for Swift 4.2 (Xcode 10.1) support, SwiftGraph 1.5.1 for Swift 4.1 (Xcode 9), SwiftGraph 1.4.1 for Swift 3 (Xcode 8), SwiftGraph 1.0.6 for Swift 2 (Xcode 7), and SwiftGraph 1.0.0 for Swift 1.2 (Xcode 6.3) support. SwiftGraph supports GNU/Linux and is tested on it.
 
+### Swift Package Manager (SPM)
+
+Use this repository as your dependency.
+
 ### CocoaPods
 
 Use the CocoaPod `SwiftGraph`.
@@ -25,13 +29,9 @@ Use the CocoaPod `SwiftGraph`.
 Add the following to your `Cartfile`:
 
 ```
-github "davecom/SwiftGraph" ~> 3.1
+github "davecom/SwiftGraph" ~> 4.0
 ```
 
-### Swift Package Manager (SPM)
-
-Use this repository as your dependency.
-
 ### Manual
 
 Copy all of the sources in the `Sources` folder into your project.

Sources/SwiftGraph/Search.swift

@@ -544,11 +544,11 @@ struct DijkstraNode<D: Comparable>: Comparable, Equatable {
     let vertex: Int
     let distance: D
 
-    static func < <D>(lhs: DijkstraNode<D>, rhs: DijkstraNode<D>) -> Bool {
+    static func < <DT>(lhs: DijkstraNode<DT>, rhs: DijkstraNode<DT>) -> Bool {
         return lhs.distance < rhs.distance
     }
 
-    static func == <D>(lhs: DijkstraNode<D>, rhs: DijkstraNode<D>) -> Bool {
+    static func == <DT>(lhs: DijkstraNode<DT>, rhs: DijkstraNode<DT>) -> Bool {
         return lhs.distance == rhs.distance
     }
 }

Sources/SwiftGraph/UniqueElementsGraph.swift

@@ -129,8 +129,8 @@ extension UniqueElementsGraph where E == UnweightedEdge {
         return g
     }
 
-    private struct QueueElement<V> {
-        let v: V
+    private struct QueueElement<VT> {
+        let v: VT
         let previousIndex: Int
     }
 

Sources/SwiftGraph/WeightedEdge.swift

@@ -52,7 +52,7 @@ public struct WeightedEdge<W: Equatable & Codable>: Edge, CustomStringConvertibl
     }
 
     //MARK: Operator Overloads
-    static public func == <W>(lhs: WeightedEdge<W>, rhs: WeightedEdge<W>) -> Bool {
+    static public func == <WT>(lhs: WeightedEdge<WT>, rhs: WeightedEdge<WT>) -> Bool {
         return lhs.u == rhs.u && lhs.v == rhs.v && lhs.weight == rhs.weight
     }
 

SwiftGraph.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name             = 'SwiftGraph'
-  s.version          = '3.1'
+  s.version          = '4.0'
   s.license          = { :type => "Apache License, Version 2.0", :file => "LICENSE" }
   s.summary          = 'A Graph Data Structure in Pure Swift'
   s.homepage         = 'https://github.com/davecom/SwiftGraph'
@@ -13,5 +13,5 @@ Pod::Spec.new do |s|
   s.watchos.deployment_target = '2.0'
   s.source_files = 'Sources/SwiftGraph/*.swift'
   s.requires_arc = true
-  s.swift_versions = ['5.0', '5.1', '5.2', '5.3']
+  s.swift_versions = ['5.0', '5.1', '5.2', '5.3', '5.4', '5.5', '5.6', '5.7', '6.0', '6.1']
 end

generate_docs.sh

@@ -1,13 +1,15 @@
 #!/usr/bin/env bash
+set -euo pipefail
 
 VERSION=$(git describe --tags --abbrev=0)
 
 jazzy \
   --clean \
-  --author David Kopec \
-  --author_url https://twitter.com/davekopec \
-  --github_url https://github.com/davecom/SwiftGraph \
+  --author "David Kopec" \
+  --author_url "https://twitter.com/davekopec" \
+  --github_url "https://github.com/davecom/SwiftGraph" \
   --github-file-prefix "https://github.com/davecom/SwiftGraph/tree/$VERSION" \
   --module-version "$VERSION" \
-  --module SwiftGraph
-
+  --module "SwiftGraph" \
+  --swift-build-tool spm \
+  --build-tool-arguments -c,release