Each getVertices*() method should return a Set\Vertices instance

clue · clue · commit 72b640414089 · 2013-06-14T16:27:05.000+02:00
diff --git a/src/Bipartit.php b/src/Bipartit.php
@@ -51,7 +51,7 @@ public function getColors()
         $colors = array();
 
         // get color for each vertex
-        foreach ($this->graph->getVertices() as $vid => $startVertex) {
+        foreach ($this->graph->getVertices()->getMap() as $vid => $startVertex) {
             if (!isset($colors[$vid])) {
                 $queue = array($startVertex);
                 // initialize each components color
@@ -92,7 +92,7 @@ public function getColorVertices()
         $colors = $this->getColors();
         $ret = array(0 => array(), 1 => array());
 
-        foreach ($this->graph->getVertices() as $vid => $vertex) {
+        foreach ($this->graph->getVertices()->getMap() as $vid => $vertex) {
             $ret[$colors[$vid]][$vid] = $vertex;
         }
 
@@ -113,7 +113,7 @@ public function createGraphGroups()
         $colors = $this->getColors();
 
         $graph = $this->graph->createGraphClone();
-        foreach ($graph->getVertices() as $vid => $vertex) {
+        foreach ($graph->getVertices()->getMap() as $vid => $vertex) {
             $vertex->setGroup($colors[$vid]);
         }
 
diff --git a/src/Complete.php b/src/Complete.php
@@ -26,7 +26,7 @@ class Complete extends BaseGraph
     public function isComplete()
     {
         // copy of array (separate iterator but same vertices)
-        $c = $vertices = $this->graph->getVertices();
+        $c = $vertices = $this->graph->getVertices()->getVector();
         // from each vertex
         foreach ($vertices as $vertex) {
             // to each vertex
diff --git a/src/ConnectedComponents.php b/src/ConnectedComponents.php
@@ -66,7 +66,7 @@ public function getNumberOfComponents()
         $components = 0;
 
         // for each vertices
-        foreach ($this->graph->getVertices() as $vid => $vertex) {
+        foreach ($this->graph->getVertices()->getMap() as $vid => $vertex) {
             // did I visit this vertex before?
             if (!isset($visitedVertices[$vid])) {
 
@@ -99,7 +99,7 @@ public function createGraphsComponents()
         $graphs = array();
 
         // for each vertices
-        foreach ($this->graph->getVertices() as $vid => $vertex) {
+        foreach ($this->graph->getVertices()->getMap() as $vid => $vertex) {
             // did I visit this vertex before?
             if (!isset($visitedVertices[$vid])) {
 
@@ -108,7 +108,7 @@ public function createGraphsComponents()
                 $newVertices = $alg->getVertices();
 
                 // mark the vertices of this component as visited
-                foreach ($newVertices as $vid => $unusedVertex) {
+                foreach ($newVertices->getIds() as $vid) {
                     $visitedVertices[$vid] = true;
                 }
 
diff --git a/src/DetectNegativeCycle.php b/src/DetectNegativeCycle.php
@@ -43,7 +43,7 @@ public function getCycleNegative()
         // remember vertices already visited, as they can not lead to a new cycle
         $verticesVisited = array();
         // check for all vertices
-        foreach ($this->graph->getVertices() as $vid => $vertex) {
+        foreach ($this->graph->getVertices()->getMap() as $vid => $vertex) {
             // skip vertices already visited
             if (!isset($verticesVisited[$vid])) {
                 // start MBF algorithm on current vertex
diff --git a/src/Groups.php b/src/Groups.php
@@ -4,6 +4,7 @@
 
 use Fhaculty\Graph\Algorithm\BaseGraph;
 use Fhaculty\Graph\Graph;
+use Fhaculty\Graph\Set\Vertices;
 
 class Groups extends BaseGraph
 {
@@ -66,21 +67,21 @@ public function getGroups()
     }
 
     /**
-     * get array of all vertices in the given group
+     * get set of all Vertices in the given group
      *
      * @param  int      $group
-     * @return Vertex[]
+     * @return Vertices
      * @uses Vertex::getGroup()
      */
     public function getVerticesGroup($group)
     {
         $vertices = array();
-        foreach ($this->graph->getVertices() as $vid => $vertex) {
+        foreach ($this->graph->getVertices()->getMap() as $vid => $vertex) {
             if ($vertex->getGroup() === $group) {
                 $vertices[$vid] = $vertex;
             }
         }
 
-        return $vertices;
+        return new Vertices($vertices);
     }
 }
diff --git a/src/MinimumCostFlow/SuccessiveShortestPath.php b/src/MinimumCostFlow/SuccessiveShortestPath.php
@@ -133,7 +133,7 @@ private function isBalanceReached(Graph $graph)
         if ($graph->getNumberOfVertices() !== $this->graph->getNumberOfVertices()) {
             throw new DomainException('Given graph does not appear to be a clone of input graph');
         }
-        foreach ($this->graph->getVertices() as $vid => $vertex) {
+        foreach ($this->graph->getVertices()->getMap() as $vid => $vertex) {
             if ($vertex->getBalance() !== $graph->getVertex($vid)->getBalance()) {
                 return false;
             }
@@ -152,7 +152,7 @@ private function isBalanceReached(Graph $graph)
      */
     private function getVertexSource(Graph $graph)
     {
-        foreach ($graph->getVertices() as $vid => $vertex) {
+        foreach ($graph->getVertices()->getMap() as $vid => $vertex) {
             if ($this->graph->getVertex($vid)->getBalance() - $vertex->getBalance() > 0) {
                 return $vertex;
             }
@@ -174,7 +174,7 @@ private function getVertexSink(Vertex $source)
         // search for reachable Vertices
         $algBFS = new SearchBreadthFirst($source);
 
-        foreach ($algBFS->getVertices() as $vid => $vertex) {
+        foreach ($algBFS->getVertices()->getMap() as $vid => $vertex) {
             if ($this->graph->getVertex($vid)->getBalance() - $vertex->getBalance() < 0) {
                 return $vertex;
             }
diff --git a/src/Search/Base.php b/src/Search/Base.php
@@ -3,11 +3,10 @@
 namespace Fhaculty\Graph\Algorithm\Search;
 
 use Fhaculty\Graph\Algorithm\BaseVertex;
-
 use Fhaculty\Graph\Exception\DomainException;
-
 use Fhaculty\Graph\Exception\InvalidArgumentException;
 use Fhaculty\Graph\Vertex;
+use Fhaculty\Graph\Set\Vertices;
 
 abstract class Base extends BaseVertex
 {
@@ -60,9 +59,9 @@ public function getNumberOfVertices()
     }
 
     /**
-     * get array of all vertices that can be reached from start vertex
+     * get set of all Vertices that can be reached from start vertex
      *
-     * @return Vertex[]
+     * @return Vertices
      */
     abstract public function getVertices();
 
@@ -74,6 +73,6 @@ abstract public function getVertices();
      */
     public function getVerticesIds()
     {
-        return array_keys($this->getVertices());
+        return $this->getVertices()->getIds();
     }
 }
diff --git a/src/Search/BreadthFirst.php b/src/Search/BreadthFirst.php
@@ -4,12 +4,13 @@
 
 use Fhaculty\Graph\Vertex;
 use Fhaculty\Graph\Graph;
+use Fhaculty\Graph\Set\Vertices;
 
 class BreadthFirst extends Base
 {
     /**
      *
-     * @return Vertex[]
+     * @return Vertices
      */
     public function getVertices()
     {
@@ -40,6 +41,6 @@ public function getVertices()
         // untill queue is empty
         } while ($queue);
 
-        return $visited;
+        return new Vertices($visited);
     }
 }
diff --git a/src/Search/DepthFirst.php b/src/Search/DepthFirst.php
@@ -3,6 +3,7 @@
 namespace Fhaculty\Graph\Algorithm\Search;
 
 use Fhaculty\Graph\Vertex;
+use Fhaculty\Graph\Set\Vertices;
 
 class DepthFirst extends Base
 {
@@ -45,14 +46,13 @@ private function iterativeDepthFirstSearch(Vertex $vertex)
             }
         }
 
-        return $visited;
+        return new Vertices($visited);
     }
 
     /**
-     *
      * calculates a recursive depth-first search
      *
-     * @return Vertex[]
+     * @return Vertices
      */
     public function getVertices()
     {
diff --git a/src/ShortestPath/Base.php b/src/ShortestPath/Base.php
@@ -4,13 +4,11 @@
 
 use Fhaculty\Graph\Algorithm\BaseVertex;
 use Fhaculty\Graph\Walk;
-
 use Fhaculty\Graph\Exception\UnderflowException;
-
 use Fhaculty\Graph\Exception\InvalidArgumentException;
-
 use Fhaculty\Graph\Vertex;
 use Fhaculty\Graph\Edge\Base as Edge;
+use Fhaculty\Graph\Set\Vertices;
 
 abstract class Base extends BaseVertex
 {
@@ -94,22 +92,22 @@ private function sumEdges(array $edges)
     }
 
     /**
-     * get array of all vertices the given start vertex has a path to
+     * get set of all Vertices the given start vertex has a path to
      *
-     * @return Vertex[]
+     * @return Vertices
      * @uses AlgorithmSp::getDistanceMap()
      */
     public function getVertices()
     {
         $vertices = array();
         $map = $this->getDistanceMap();
-        foreach ($this->vertex->getGraph()->getVertices() as $vid => $vertex) {
+        foreach ($this->vertex->getGraph()->getVertices()->getMap() as $vid => $vertex) {
             if (isset($map[$vid])) {
                 $vertices[$vid] = $vertex;
             }
         }
 
-        return $vertices;
+        return new Vertices($vertices);
     }
 
     /**
@@ -135,7 +133,7 @@ public function getDistanceMap()
     {
         $edges = $this->getEdges();
         $ret = array();
-        foreach ($this->vertex->getGraph()->getVertices() as $vid => $vertex) {
+        foreach ($this->vertex->getGraph()->getVertices()->getMap() as $vid => $vertex) {
             try {
                 $ret[$vid] = $this->sumEdges($this->getEdgesToInternal($vertex, $edges));
             } catch (UnderflowException $ignore) {
@@ -182,7 +180,7 @@ public function createGraph()
      */
     protected function getEdgesCheapestPredecesor(array $predecessor)
     {
-        $vertices = $this->vertex->getGraph()->getVertices();
+        $vertices = $this->vertex->getGraph()->getVertices()->getMap();
         // start vertex doesn't have a predecessor
         unset($vertices[$this->vertex->getId()]);
 
diff --git a/src/ShortestPath/BreadthFirst.php b/src/ShortestPath/BreadthFirst.php
@@ -2,13 +2,12 @@
 
 namespace Fhaculty\Graph\Algorithm\ShortestPath;
 
-use Fhaculty\Graph\Exception\InvalidArgumentException;
 
+use Fhaculty\Graph\Exception\InvalidArgumentException;
 use Fhaculty\Graph\Exception\OutOfBoundsException;
-
 use Fhaculty\Graph\Walk;
-
 use Fhaculty\Graph\Vertex;
+use Fhaculty\Graph\Set\Vertices;
 use \Exception;
 
 class BreadthFirst extends Base
@@ -109,7 +108,7 @@ public function hasVertex(Vertex $endVertex)
     /**
      * get array of all target vertices this vertex has a path to
      *
-     * @return Vertex[]
+     * @return Vertices
      * @uses AlgorithmSpBreadthFirst::getDistanceMap()
      */
     public function getVertices()
@@ -120,7 +119,7 @@ public function getVertices()
             $ret[$vid] = $graph->getVertex($vid);
         }
 
-        return $ret;
+        return new Vertices($ret);
     }
 
     public function getEdges()
diff --git a/src/TopologicalSort.php b/src/TopologicalSort.php
@@ -17,13 +17,13 @@
 class TopologicalSort extends BaseGraph
 {
     /**
-     * run algorithm and return an ordered/sorted list of vertices
+     * run algorithm and return an ordered/sorted set of Vertices
      *
      * the topologic sorting may be non-unique depending on your edges. this
      * algorithm tries to keep the order of vertices as added to the graph in
      * this case.
      *
-     * @return Vertex[]
+     * @return Vertices
      */
     public function getVertices()
     {
@@ -53,7 +53,7 @@ protected function visit(Vertex $vertex, array &$visited, array &$tsl)
             // temporary mark
             $visited[$vid] = false;
 
-            foreach (array_reverse($vertex->getVerticesEdgeTo()) as $v) {
+            foreach (array_reverse($vertex->getVerticesEdgeTo()->getVector()) as $v) {
                 $this->visit($v, $visited, $tsl);
             }
 
diff --git a/src/TravelingSalesmanProblem/MinimumSpanningTree.php b/src/TravelingSalesmanProblem/MinimumSpanningTree.php
@@ -44,13 +44,12 @@ public function getEdges()
 
         $alg = new SearchDepthFirst($minimumSpanningTree->getVertexFirst());
         // Depth first search in minmum spanning tree (for the eulerian path)
-        $depthFirstSearch = $alg->getVertices();
 
         $startVertex = NULL;
         $oldVertex = NULL;
 
         // connect vertices in order of the depth first search
-        foreach ($depthFirstSearch as $vertex) {
+        foreach ($alg->getVertices() as $vertex) {
 
             // get vertex from the original graph (not from the depth first search)
             $vertex = $this->graph->getVertex($vertex->getId());

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ class Complete extends BaseGraph`
`26`	`26`	`public function isComplete()`
`27`	`27`	`{`
`28`	`28`	`// copy of array (separate iterator but same vertices)`
`29`		`- $c = $vertices = $this->graph->getVertices();`
	`29`	`+ $c = $vertices = $this->graph->getVertices()->getVector();`
`30`	`30`	`// from each vertex`
`31`	`31`	`foreach ($vertices as $vertex) {`
`32`	`32`	`// to each vertex`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`
`5`	`5`	`use Fhaculty\Graph\Algorithm\BaseGraph;`
`6`	`6`	`use Fhaculty\Graph\Graph;`
	`7`	`+use Fhaculty\Graph\Set\Vertices;`
`7`	`8`
`8`	`9`	`class Groups extends BaseGraph`
`9`	`10`	`{`
`@@ -66,21 +67,21 @@ public function getGroups()`
`66`	`67`	`}`
`67`	`68`
`68`	`69`	`/**`
`69`		`- * get array of all vertices in the given group`
	`70`	`+ * get set of all Vertices in the given group`
`70`	`71`	`*`
`71`	`72`	`* @param int $group`
`72`		`- * @return Vertex[]`
	`73`	`+ * @return Vertices`
`73`	`74`	`* @uses Vertex::getGroup()`
`74`	`75`	`*/`
`75`	`76`	`public function getVerticesGroup($group)`
`76`	`77`	`{`
`77`	`78`	`$vertices = array();`
`78`		`- foreach ($this->graph->getVertices() as $vid => $vertex) {`
	`79`	`+ foreach ($this->graph->getVertices()->getMap() as $vid => $vertex) {`
`79`	`80`	`if ($vertex->getGroup() === $group) {`
`80`	`81`	`$vertices[$vid] = $vertex;`
`81`	`82`	`}`
`82`	`83`	`}`
`83`	`84`
`84`		`- return $vertices;`
	`85`	`+ return new Vertices($vertices);`
`85`	`86`	`}`
`86`	`87`	`}`
Original file line number	Diff line number	Diff line change
`@@ -133,7 +133,7 @@ private function isBalanceReached(Graph $graph)`
`133`	`133`	`if ($graph->getNumberOfVertices() !== $this->graph->getNumberOfVertices()) {`
`134`	`134`	`throw new DomainException('Given graph does not appear to be a clone of input graph');`
`135`	`135`	`}`
`136`		`- foreach ($this->graph->getVertices() as $vid => $vertex) {`
	`136`	`+ foreach ($this->graph->getVertices()->getMap() as $vid => $vertex) {`
`137`	`137`	`if ($vertex->getBalance() !== $graph->getVertex($vid)->getBalance()) {`
`138`	`138`	`return false;`
`139`	`139`	`}`
`@@ -152,7 +152,7 @@ private function isBalanceReached(Graph $graph)`
`152`	`152`	`*/`
`153`	`153`	`private function getVertexSource(Graph $graph)`
`154`	`154`	`{`
`155`		`- foreach ($graph->getVertices() as $vid => $vertex) {`
	`155`	`+ foreach ($graph->getVertices()->getMap() as $vid => $vertex) {`
`156`	`156`	`if ($this->graph->getVertex($vid)->getBalance() - $vertex->getBalance() > 0) {`
`157`	`157`	`return $vertex;`
`158`	`158`	`}`
`@@ -174,7 +174,7 @@ private function getVertexSink(Vertex $source)`
`174`	`174`	`// search for reachable Vertices`
`175`	`175`	`$algBFS = new SearchBreadthFirst($source);`
`176`	`176`
`177`		`- foreach ($algBFS->getVertices() as $vid => $vertex) {`
	`177`	`+ foreach ($algBFS->getVertices()->getMap() as $vid => $vertex) {`
`178`	`178`	`if ($this->graph->getVertex($vid)->getBalance() - $vertex->getBalance() < 0) {`
`179`	`179`	`return $vertex;`
`180`	`180`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,11 +3,10 @@`
`3`	`3`	`namespace Fhaculty\Graph\Algorithm\Search;`
`4`	`4`
`5`	`5`	`use Fhaculty\Graph\Algorithm\BaseVertex;`
`6`		`-`
`7`	`6`	`use Fhaculty\Graph\Exception\DomainException;`
`8`		`-`
`9`	`7`	`use Fhaculty\Graph\Exception\InvalidArgumentException;`
`10`	`8`	`use Fhaculty\Graph\Vertex;`
	`9`	`+use Fhaculty\Graph\Set\Vertices;`
`11`	`10`
`12`	`11`	`abstract class Base extends BaseVertex`
`13`	`12`	`{`
`@@ -60,9 +59,9 @@ public function getNumberOfVertices()`
`60`	`59`	`}`
`61`	`60`
`62`	`61`	`/**`
`63`		`- * get array of all vertices that can be reached from start vertex`
	`62`	`+ * get set of all Vertices that can be reached from start vertex`
`64`	`63`	`*`
`65`		`- * @return Vertex[]`
	`64`	`+ * @return Vertices`
`66`	`65`	`*/`
`67`	`66`	`abstract public function getVertices();`
`68`	`67`
`@@ -74,6 +73,6 @@ abstract public function getVertices();`
`74`	`73`	`*/`
`75`	`74`	`public function getVerticesIds()`
`76`	`75`	`{`
`77`		`- return array_keys($this->getVertices());`
	`76`	`+ return $this->getVertices()->getIds();`
`78`	`77`	`}`
`79`	`78`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,12 +4,13 @@`
`4`	`4`
`5`	`5`	`use Fhaculty\Graph\Vertex;`
`6`	`6`	`use Fhaculty\Graph\Graph;`
	`7`	`+use Fhaculty\Graph\Set\Vertices;`
`7`	`8`
`8`	`9`	`class BreadthFirst extends Base`
`9`	`10`	`{`
`10`	`11`	`/**`
`11`	`12`	`*`
`12`		`- * @return Vertex[]`
	`13`	`+ * @return Vertices`
`13`	`14`	`*/`
`14`	`15`	`public function getVertices()`
`15`	`16`	`{`
`@@ -40,6 +41,6 @@ public function getVertices()`
`40`	`41`	`// untill queue is empty`
`41`	`42`	`} while ($queue);`
`42`	`43`
`43`		`- return $visited;`
	`44`	`+ return new Vertices($visited);`
`44`	`45`	`}`
`45`	`46`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@`
`3`	`3`	`namespace Fhaculty\Graph\Algorithm\Search;`
`4`	`4`
`5`	`5`	`use Fhaculty\Graph\Vertex;`
	`6`	`+use Fhaculty\Graph\Set\Vertices;`
`6`	`7`
`7`	`8`	`class DepthFirst extends Base`
`8`	`9`	`{`
`@@ -45,14 +46,13 @@ private function iterativeDepthFirstSearch(Vertex $vertex)`
`45`	`46`	`}`
`46`	`47`	`}`
`47`	`48`
`48`		`- return $visited;`
	`49`	`+ return new Vertices($visited);`
`49`	`50`	`}`
`50`	`51`
`51`	`52`	`/**`
`52`		`- *`
`53`	`53`	`* calculates a recursive depth-first search`
`54`	`54`	`*`
`55`		`- * @return Vertex[]`
	`55`	`+ * @return Vertices`
`56`	`56`	`*/`
`57`	`57`	`public function getVertices()`
`58`	`58`	`{`