Use Set\Edges in algorithms

Author: clue

src/MaxFlow/EdmondsKarp.php

@@ -17,6 +17,7 @@
 use Fhaculty\Graph\Graph;
 use Fhaculty\Graph\Vertex;
 use Fhaculty\Graph\Edge\Base as Edge;
+use Fhaculty\Graph\Set\Edges;
 use Fhaculty\Graph\Algorithm\Base;
 use Fhaculty\Graph\Algorithm\ResidualGraph;
 use Fhaculty\Graph\Exception;
@@ -86,7 +87,7 @@ public function createGraph()
             // If path exists add the new flow to graph
             if ($pathFlow) {
                 // 2. get max flow from path
-                $maxFlowValue = Edge::getFirst($pathFlow->getEdges(), Edge::ORDER_CAPACITY)->getCapacity();
+                $maxFlowValue = $pathFlow->getEdges()->getEdgeOrder(Edges::ORDER_CAPACITY)->getCapacity();
 
                 // 3. add flow to path
                 foreach ($pathFlow->getEdges() as $edge) {

src/MaximumMatching/Base.php

@@ -5,6 +5,7 @@
 use Fhaculty\Graph\Algorithm\BaseGraph;
 use Fhaculty\Graph\Graph;
 use Fhaculty\Graph\Edge\Base as Edge;
+use Fhaculty\Graph\Set\Edges;
 
 abstract class Base extends BaseGraph
 {
@@ -35,7 +36,7 @@ public function createGraph()
     /**
      * create new resulting graph with minimum-cost flow on edges
      *
-     * @return Edge[]
+     * @return Edges
      */
     abstract public function getEdges();
 }

src/MinimumCostFlow/Base.php

@@ -6,6 +6,7 @@
 use Fhaculty\Graph\Algorithm\Weight as AlgorithmWeight;
 use Fhaculty\Graph\Exception\UnderflowException;
 use Fhaculty\Graph\Edge\Base as Edge;
+use Fhaculty\Graph\Set\Edges;
 use Fhaculty\Graph\Exception\UnexpectedValueException;
 use Fhaculty\Graph\Graph;
 
@@ -32,14 +33,14 @@ protected function checkBalance()
      * helper used to add $newFlow to original edges of $clonedEdges in graph $resultGraph
      *
      * @param Graph  $resultGraph graph to look for original edges
-     * @param Edge[] $clonedEdges array of cloned edges to be modified
+     * @param Edges  $clonedEdges set of cloned edges to be modified
      * @param number $newFlow     flow to add
      * @uses Graph::getEdgeClone()
      * @uses Graph::getEdgeCloneInverted()
      * @uses Edge::getFlow()
      * @uses Edge::setFlow()
      */
-    protected function addFlow(Graph $resultGraph, $clonedEdges, $newFlow)
+    protected function addFlow(Graph $resultGraph, Edges $clonedEdges, $newFlow)
     {
         foreach ($clonedEdges as $clonedEdge) {
             try {

src/MinimumCostFlow/CycleCanceling.php

@@ -2,11 +2,13 @@
 
 namespace Fhaculty\Graph\Algorithm\MinimumCostFlow;
 
+
 use Fhaculty\Graph\Exception\UnexpectedValueException;
 
 use Fhaculty\Graph\Exception\UnderflowException;
 
 use Fhaculty\Graph\Edge\Base as Edge;
+use Fhaculty\Graph\Set\Edges;
 use Fhaculty\Graph\Algorithm\MaxFlow\EdmondsKarp as MaxFlowEdmondsKarp;
 use Fhaculty\Graph\Algorithm\DetectNegativeCycle;
 use Fhaculty\Graph\Algorithm\ResidualGraph;
@@ -66,7 +68,7 @@ public function createGraph()
             }
 
             // calculate maximal possible flow = minimum capacity remaining for all edges
-            $newFlow = Edge::getFirst($clonedEdges, Edge::ORDER_CAPACITY_REMAINING)->getCapacityRemaining();
+            $newFlow = $clonedEdges->getEdgeOrder(Edges::ORDER_CAPACITY_REMAINING)->getCapacityRemaining();
 
             // set flow on original graph
             $this->addFlow($resultGraph, $clonedEdges, $newFlow);

src/MinimumCostFlow/SuccessiveShortestPath.php

@@ -12,6 +12,7 @@
 use Fhaculty\Graph\Vertex;
 use Fhaculty\Graph\Edge\Base as Edge;
 use Fhaculty\Graph\Edge\Directed as EdgeDirected;
+use Fhaculty\Graph\Set\Edges;
 use Fhaculty\Graph\Algorithm\ShortestPath\MooreBellmanFord as SpMooreBellmanFord;
 use Fhaculty\Graph\Algorithm\ResidualGraph;
 use Fhaculty\Graph\Algorithm\Search\BreadthFirst as SearchBreadthFirst;
@@ -98,7 +99,7 @@ public function createGraph()
             }
 
             // get minimum of capacity remaining on path
-            $minCapacity = Edge::getFirst($edgesOnFlow, Edge::ORDER_CAPACITY_REMAINING)->getCapacityRemaining();
+            $minCapacity = $edgesOnFlow->getEdgeOrder(Edges::ORDER_CAPACITY_REMAINING)->getCapacityRemaining();
             if ($minCapacity < $newflow) {
                 $newflow = $minCapacity;
             }

src/MinimumSpanningTree/Base.php

@@ -3,6 +3,7 @@
 namespace Fhaculty\Graph\Algorithm\MinimumSpanningTree;
 
 use Fhaculty\Graph\Algorithm\Base as AlgorithmBase;
+use Fhaculty\Graph\Set\Edges;
 
 abstract class Base extends AlgorithmBase
 {
@@ -24,7 +25,7 @@ abstract protected function getGraph();
     /**
      * get all edges on minimum spanning tree
      *
-     * @return Edge[]
+     * @return Edges
      */
     abstract public function getEdges();
 }

src/MinimumSpanningTree/Kruskal.php

@@ -36,7 +36,7 @@ protected function getGraph()
 
     /**
      *
-     * @return Edge[]
+     * @return Edges
      */
     public function getEdges()
     {

src/ShortestPath/Base.php

@@ -8,6 +8,7 @@
 use Fhaculty\Graph\Exception\InvalidArgumentException;
 use Fhaculty\Graph\Vertex;
 use Fhaculty\Graph\Edge\Base as Edge;
+use Fhaculty\Graph\Set\Edges;
 use Fhaculty\Graph\Set\Vertices;
 
 abstract class Base extends BaseVertex
@@ -162,10 +163,10 @@ public function createGraph()
      * get cheapest edges (lowest weight) for given map of vertex predecessors
      *
      * @param  Vertex[] $predecessor
-     * @return Edge[]
+     * @return Edges
      * @uses Graph::getVertices()
      * @uses Vertex::getEdgesTo()
-     * @uses Edge::getFirst()
+     * @uses Edges::getEdgeOrder()
      */
     protected function getEdgesCheapestPredecesor(array $predecessor)
     {
@@ -180,17 +181,17 @@ protected function getEdgesCheapestPredecesor(array $predecessor)
                 $predecesVertex = $predecessor[$vid];
 
                 // get cheapest edge
-                $edges []= Edge::getFirst($predecesVertex->getEdgesTo($vertex), Edge::ORDER_WEIGHT);
+                $edges []= $predecesVertex->getEdgesTo($vertex)->getEdgeOrder(Edges::ORDER_WEIGHT);
             }
         }
 
-        return $edges;
+        return new Edges($edges);
     }
 
     /**
      * get all edges on shortest path for this vertex
      *
-     * @return Edge[]
+     * @return Edges
      */
     abstract public function getEdges();
 }

src/TravelingSalesmanProblem/MinimumSpanningTree.php

@@ -4,6 +4,7 @@
 
 use Fhaculty\Graph\Graph;
 use Fhaculty\Graph\Edge\Base as Edge;
+use Fhaculty\Graph\Set\Edges;
 use Fhaculty\Graph\Algorithm\MinimumSpanningTree\Kruskal as MstKruskal;
 use Fhaculty\Graph\Algorithm\Search\BreadthFirst as SearchDepthFirst;
 
@@ -32,7 +33,7 @@ protected function getGraph()
 
     /**
      *
-     * @return Edge[]
+     * @return Edges
      */
     public function getEdges()
     {
@@ -58,16 +59,16 @@ public function getEdges()
                 $startVertex = $vertex;
             } else {
                 // get edge(s) to clone, multiple edges are possible (returns an array if undirected edge)
-                $returnEdges []= Edge::getFirst($oldVertex->getEdgesTo($vertex));
+                $returnEdges []= $oldVertex->getEdgesTo($vertex)->getEdgeFirst();
             }
 
             $oldVertex = $vertex;
         }
 
         // connect last vertex with start vertex
         // multiple edges are possible (returns an array if undirected edge)
-        $returnEdges []= Edge::getFirst($oldVertex->getEdgesTo($startVertex));
+        $returnEdges []= $oldVertex->getEdgesTo($startVertex)->getEdgeFirst();
 
-        return $returnEdges;
+        return new Edges($returnEdges);
     }
 }

src/TravelingSalesmanProblem/NearestNeighbor.php

@@ -6,6 +6,7 @@
 
 use Fhaculty\Graph\Vertex;
 use Fhaculty\Graph\Edge\Base as Edge;
+use Fhaculty\Graph\Set\Edges;
 use \SplPriorityQueue;
 
 class NearestNeighbor extends Base
@@ -33,7 +34,7 @@ protected function getGraph()
 
     /**
      *
-     * @return Edge[]
+     * @return Edges
      */
     public function getEdges()
     {
@@ -85,8 +86,8 @@ public function getEdges()
         // check if there is a way from end edge to start edge
         // get first connecting edge
         // connect the last vertex with the start vertex
-        $returnEdges []= Edge::getFirst($vertex->getEdgesTo($this->vertex));
+        $returnEdges []= $vertex->getEdgesTo($this->vertex)->getEdgeFirst();
 
-        return $returnEdges;
+        return new Edges($returnEdges);
     }
 }