Consistently throw OutOfBoundsException for unreachable vertices

Author: clue

src/ShortestPath/Base.php

@@ -4,11 +4,8 @@
 
 use Fhaculty\Graph\Algorithm\BaseVertex;
 use Fhaculty\Graph\Walk;
-
-use Fhaculty\Graph\Exception\UnderflowException;
-
+use Fhaculty\Graph\Exception\OutOfBoundsException;
 use Fhaculty\Graph\Exception\InvalidArgumentException;
-
 use Fhaculty\Graph\Vertex;
 use Fhaculty\Graph\Edge\Base as Edge;
 
@@ -19,7 +16,7 @@ abstract class Base extends BaseVertex
      *
      * @param  Vertex    $endVertex
      * @return Walk
-     * @throws Exception when there's no walk from start to end vertex
+     * @throws OutOfBoundsException if there's no path to the given end vertex
      * @uses self::getEdgesTo()
      * @uses Walk::factoryFromEdges()
      */
@@ -32,7 +29,7 @@ public function getWalkTo(Vertex $endVertex)
      * get array of edges (path) from start vertex to given end vertex
      *
      * @param  Vertex    $endVertex
-     * @throws Exception
+     * @throws OutOfBoundsException if there's no path to the given end vertex
      * @return Edge[]
      * @uses AlgorithmSp::getEdges()
      * @uses AlgorithmSp::getEdgesToInternal()
@@ -47,7 +44,7 @@ public function getEdgesTo(Vertex $endVertex)
      *
      * @param  Vertex    $endVertex
      * @param  array     $edges     array of all input edges to operate on
-     * @throws Exception
+     * @throws OutOfBoundsException if there's no path to the given vertex
      * @return Edge[]
      * @uses AlgorithmSp::getEdges() if no edges were given
      */
@@ -69,7 +66,7 @@ protected function getEdgesToInternal(Vertex $endVertex, array $edges)
                 } // ignore: this edge does not point TO current vertex
             }
             if ($pre === NULL) {
-                throw new UnderflowException('No edge leading to vertex');
+                throw new OutOfBoundsException('No edge leading to vertex');
             }
         }
 
@@ -138,7 +135,7 @@ public function getDistanceMap()
         foreach ($this->vertex->getGraph()->getVertices() as $vid => $vertex) {
             try {
                 $ret[$vid] = $this->sumEdges($this->getEdgesToInternal($vertex, $edges));
-            } catch (UnderflowException $ignore) {
+            } catch (OutOfBoundsException $ignore) {
             } // ignore vertices that can not be reached
         }
 
@@ -150,7 +147,7 @@ public function getDistanceMap()
      *
      * @param  Vertex    $endVertex
      * @return float
-     * @throws Exception if given vertex is invalid or there's no path to given end vertex
+     * @throws OutOfBoundsException if there's no path to the given end vertex
      * @uses AlgorithmSp::getEdgesTo()
      * @uses AlgorithmSp::sumEdges()
      */

src/ShortestPath/BreadthFirst.php

@@ -36,6 +36,8 @@ public function getEdgesMap()
         $vertexQueue = array();
         $edges = array();
 
+        // $edges[$this->vertex->getId()] = array();
+
         $vertexCurrent = $this->vertex;
         $edgesCurrent = array();
 
@@ -62,15 +64,14 @@ public function getEdgesMap()
 
     public function getEdgesTo(Vertex $endVertex)
     {
-        if ($endVertex->getGraph() !== $this->vertex->getGraph()) {
-            throw new InvalidArgumentException('Given target vertex does not belong to the same graph instance');
-        }
-        $map = $this->getEdgesMap();
-        if (!isset($map[$endVertex->getId()])) {
-            throw new OutOfBoundsException('Given target vertex can not be reached from start vertex');
-        }
+        if ($endVertex->getGraph() === $this->vertex->getGraph()) {
+            $map = $this->getEdgesMap();
 
-        return $map[$endVertex->getId()];
+            if (isset($map[$endVertex->getId()])) {
+                return $map[$endVertex->getId()];
+            }
+        }
+        throw new OutOfBoundsException('Given target vertex can not be reached from start vertex');
     }
 
     /**
@@ -94,23 +95,24 @@ public function getDistanceMap()
      *
      * @param  Vertex  $endVertex
      * @return boolean
-     * @uses AlgorithmSpBreadthFirst::getEdgesMap()
+     * @uses self::getEdgesTo()
      */
-    public function hasVertex(Vertex $endVertex)
+    public function hasVertex(Vertex $vertex)
     {
-        if ($endVertex->getGraph() !== $this->vertex->getGraph()) {
-            throw new InvalidArgumentException('Given target vertex does not belong to the same graph instance');
+        try {
+            $this->getEdgesTo($vertex);
         }
-        $map = $this->getEdgesMap();
-
-        return isset($map[$endVertex->getId()]);
+        catch (OutOfBoundsException $e) {
+            return false;
+        }
+        return true;
     }
 
     /**
      * get array of all target vertices this vertex has a path to
      *
      * @return Vertex[]
-     * @uses AlgorithmSpBreadthFirst::getDistanceMap()
+     * @uses self::getEdgesMap()
      */
     public function getVertices()
     {