Always return Set\Edges instead of array of Edge instances

Author: clue

src/MinimumSpanningTree/Kruskal.php

@@ -8,6 +8,7 @@
 
 use Fhaculty\Graph\Graph;
 use Fhaculty\Graph\Edge\Directed as EdgeDirected;
+use Fhaculty\Graph\Set\Edges;
 use \SplPriorityQueue;
 
 class Kruskal extends Base
@@ -153,6 +154,6 @@ public function getEdges()
             throw new UnexpectedValueException('Graph is not connected');
         }
 
-        return $returnEdges;
+        return new Edges($returnEdges);
     }
 }

src/MinimumSpanningTree/Prim.php

@@ -4,6 +4,7 @@
 
 use Fhaculty\Graph\Exception\UnexpectedValueException;
 use Fhaculty\Graph\Edge\Directed as EdgeDirected;
+use Fhaculty\Graph\Set\Edges;
 use Fhaculty\Graph\Vertex;
 use \SplPriorityQueue;
 use \Exception;
@@ -22,7 +23,7 @@ public function __construct(Vertex $startVertex)
 
     /**
      *
-     * @return Edge[]
+     * @return Edges
      */
     public function getEdges()
     {
@@ -78,7 +79,7 @@ public function getEdges()
             }
         }
 
-        return $returnEdges;
+        return new Edges($returnEdges);
     }
 
     protected function getGraph()

src/ShortestPath/Base.php

@@ -32,7 +32,7 @@ public function getWalkTo(Vertex $endVertex)
      *
      * @param  Vertex    $endVertex
      * @throws Exception
-     * @return Edge[]
+     * @return Edges
      * @uses AlgorithmSp::getEdges()
      * @uses AlgorithmSp::getEdgesToInternal()
      */
@@ -47,7 +47,7 @@ public function getEdgesTo(Vertex $endVertex)
      * @param  Vertex    $endVertex
      * @param  array     $edges     array of all input edges to operate on
      * @throws Exception
-     * @return Edge[]
+     * @return Edges
      * @uses AlgorithmSp::getEdges() if no edges were given
      */
     protected function getEdgesToInternal(Vertex $endVertex, array $edges)
@@ -72,17 +72,17 @@ protected function getEdgesToInternal(Vertex $endVertex, array $edges)
             }
         }
 
-        return array_reverse($path);
+        return new Edges(array_reverse($path));
     }
 
     /**
      * get sum of weight of given edges
      *
-     * @param  Edge[] $edges
+     * @param  Edges $edges
      * @return float
      * @uses Edge::getWeight()
      */
-    private function sumEdges(array $edges)
+    private function sumEdges(Edges $edges)
     {
         $sum = 0;
         foreach ($edges as $edge) {

src/ShortestPath/Dijkstra.php

@@ -2,6 +2,7 @@
 
 namespace Fhaculty\Graph\Algorithm\ShortestPath;
 
+use Fhaculty\Graph\Set\Edges;
 use Fhaculty\Graph\Exception\UnexpectedValueException;
 use \SplPriorityQueue;
 
@@ -10,7 +11,7 @@ class Dijkstra extends Base
     /**
      * get all edges on shortest path for this vertex
      *
-     * @return Edge[]
+     * @return Edges
      */
     public function getEdges()
     {

src/ShortestPath/MooreBellmanFord.php

@@ -11,13 +11,13 @@ class MooreBellmanFord extends Base
     /**
      *
      *
-     * @param Edge[]   $edges
+     * @param Edges    $edges
      * @param int[]    $totalCostOfCheapestPathTo
      * @param Vertex[] $predecessorVertexOfCheapestPathTo
      *
      * @return Vertex|NULL
      */
-    private function bigStep(array &$edges, array &$totalCostOfCheapestPathTo, array &$predecessorVertexOfCheapestPathTo)
+    private function bigStep(Edges $edges, array &$totalCostOfCheapestPathTo, array &$predecessorVertexOfCheapestPathTo)
     {
         $changed = NULL;
         // check for all edges
@@ -50,7 +50,7 @@ private function bigStep(array &$edges, array &$totalCostOfCheapestPathTo, array
     /**
      * Calculate the Moore-Bellman-Ford-Algorithm and get all edges on shortest path for this vertex
      *
-     * @return Edge[]
+     * @return Edges
      * @throws NegativeCycleException if there is a negative cycle
      */
     public function getEdges()

src/TravelingSalesmanProblem/Base.php

@@ -5,6 +5,7 @@
 use Fhaculty\Graph\Cycle;
 use Fhaculty\Graph\Vertex;
 use Fhaculty\Graph\Edge\Base as Edge;
+use Fhaculty\Graph\Set\Edges;
 use Fhaculty\Graph\Algorithm\Base as AlgorithmBase;
 
 abstract class Base extends AlgorithmBase
@@ -63,7 +64,7 @@ public function getWeight()
     /**
      * get array of edges connecting all vertices in a circle
      *
-     * @return Edge[]
+     * @return Edges
      */
     abstract public function getEdges();
 }

src/TravelingSalesmanProblem/Bruteforce.php

@@ -8,6 +8,7 @@
 
 use Fhaculty\Graph\Graph;
 use Fhaculty\Graph\Vertex;
+use Fhaculty\Graph\Set\Edges;
 use Fhaculty\Graph\Algorithm\TravelingSalesmanProblem\MinimumSpanningTree as AlgorithmTspMst;
 
 class Bruteforce extends Base
@@ -103,7 +104,7 @@ protected function getGraph()
      * get resulting (first) best circle of edges connecting all vertices
      *
      * @throws Exception on error
-     * @return Edge[]
+     * @return Edges
      */
     public function getEdges()
     {
@@ -128,7 +129,7 @@ public function getEdges()
             throw new UnexpectedValueException('No resulting solution for TSP found');
         }
 
-        return $result;
+        return new Edges($result);
     }
 
     /**