Merge branch 'master' into fix-algo-minimumcostflow

Conflicts:
	lib/Fhaculty/Graph/Algorithm/MinimumCostFlow/SuccessiveShortestPath.php

Author: clue

CHANGELOG.md

@@ -4,7 +4,50 @@ This file is a manually maintained list of changes for each release. Feel free
 to add your changes here when sending pull requests. Also send corrections if
 you spot any mistakes.
 
-## 0.7.0 (2013-xx-xx)
+## 0.8.0 (2013-xx-xx)
+
+*   BC break: Rename `Algorithm\Directed::isDirected()` to remove its ambiguity
+    in regards to mixed and/or empty graphs
+    ([#80](https://github.com/clue/graph/issues/80))
+
+    | Old name | New name |
+    |---|---|
+    | `Algorithm\Directed::isDirected()` | `Algorithm\Directed::hasDirected()` |
+
+*   Feature:: Add new `Algorithm\Directed::hasUndirected()` and
+    `Algorithm\Directed::isMixed()` in order to complement the renamed
+    `Algorithm\Directed::hasDirected()`
+    ([#80](https://github.com/clue/graph/issues/80))
+
+*   BC break: `Walk::factoryCycleFromVertices()` no longer tries to auto-complete
+    a cycle if the first vertex does not match the last one, but now throws an
+    `InvalidArgumentException` instead ([#87](https://github.com/clue/graph/issues/87)
+
+*   Feature: Support loop `Walk`s, i.e. a walk with only a single edge from
+    vertex A back to A ([#87](https://github.com/clue/graph/issues/87)
+
+*   Fix: Stricter checks for invalid cycles, such as one with an invalid
+    predecessor-map or no edges at all ([#87](https://github.com/clue/graph/issues/87)
+
+*   Fix: The `Algorithm\ShortestPath\MooreBellmanFord` now also works for unweighted
+    edges. This also fixes an issue where `Algorithm\DetectNegativeCycle` didn't work
+    for unweighted edges. ([#81](https://github.com/clue/graph/issues/81)
+
+*   Fix: Throwing an `UnexpectedValueException` if writing GraphViz Dot script
+    to a temporary file fails and remove its debugging output
+    ([#77](https://github.com/clue/graph/issues/77) and [#78](https://github.com/clue/graph/issues/78) @Metabor)
+    
+*   BC break: Remove unneeded alias definitions of `getVertexFirst()`,
+    `getVertexSource()` and `getVertexTarget()`
+    [#76]https://github.com/clue/graph/issues/76)):
+
+    | Old name | New name |
+    |---|---|
+    | `Graph::getVertexFirst()` | `Graph::getVertices()->getVertexFirst()` |
+    | `Walk::getVertexSource()` | `Walk::getVertices()->getVertexFirst()` |
+    | `Walk::getVertexTarget()` | `Walk::getVertices()->getVertexLast()` |
+
+## 0.7.0 (2013-09-11)
 
 *   Feature: Add new `Set\Vertices` and `Set\Edges` classes that handle common
     operations on a Set of multiple `Vertex` and `Edge` instances respectively.
@@ -75,6 +118,20 @@ you spot any mistakes.
     accordingly.
     ([#72](https://github.com/clue/graph/issues/72))
 
+*   BC break: Remove all occurances of `getNumberOfVertices()` and
+    `getNumberOfEdges()` ([#75](https://github.com/clue/graph/issues/75) and
+    [#48](https://github.com/clue/graph/issues/48)):
+
+    | Old name | New name |
+    |---|---|
+    | `$set->getNumberOfVertices()` | `count($set->getVertices())` |
+    | `$set->getNumberOfEdges()` | `count($set->getEdges())` |
+    
+*   BC break: Replace base `Set` class with `Set\DualAggregate` interface. This
+    is unlikely to affect you, but might potentially break your custom
+    inheritance or polymorphism for algorithms.
+    ([#75](https://github.com/clue/graph/issues/75))
+
 *   Feature: Add `Algorithm\ShortestPath\Base::hasVertex(Vertex $vertex)` to check whether
     a path to the given Vertex exists ([#62](https://github.com/clue/graph/issues/62)).
 

README.md

@@ -81,7 +81,7 @@ The recommended way to install this library is [through composer](http://getcomp
 ```JSON
 {
     "require": {
-        "clue/graph": "dev-master"
+        "clue/graph": "0.7.*"
     }
 }
 ```

lib/Fhaculty/Graph/Algorithm/BaseSet.php lib/Fhaculty/Graph/Algorithm/BaseDual.phplib/Fhaculty/Graph/Algorithm/BaseSet.php renamed to lib/Fhaculty/Graph/Algorithm/BaseDual.php

@@ -3,7 +3,7 @@
 namespace Fhaculty\Graph\Algorithm;
 
 use Fhaculty\Graph\Algorithm\Base;
-use Fhaculty\Graph\Set;
+use Fhaculty\Graph\Set\DualAggregate;
 use Fhaculty\Graph\Graph;
 use Fhaculty\Graph\Walk;
 
@@ -12,12 +12,12 @@
  *
  * @see Set
  */
-abstract class BaseSet extends Base
+abstract class BaseDual extends Base
 {
     /**
      * Set to operate on
      *
-     * @var Set
+     * @var DualAggregate
      */
     protected $set;
 
@@ -26,7 +26,7 @@ abstract class BaseSet extends Base
      *
      * @param Graph|Walk|Set $graphOrWalk either the Graph or Walk to operate on (or the common base class Set)
      */
-    public function __construct(Set $graphOrWalk)
+    public function __construct(DualAggregate $graphOrWalk)
     {
         $this->set = $graphOrWalk;
     }

lib/Fhaculty/Graph/Algorithm/ConnectedComponents.php

@@ -65,21 +65,20 @@ private function createSearch(Vertex $vertex)
      * connected here.
      *
      * @return boolean
-     * @uses AlgorithmSearchBreadthFirst::getNumberOfVertices()
      * @see self::getNumberOfComponents()
      */
     public function isSingle()
     {
         try {
-            $vertex = $this->graph->getVertexFirst();
+            $vertex = $this->graph->getVertices()->getVertexFirst();
         }
         catch (UnderflowException $e) {
             // no first vertex => empty graph => has zero components
             return false;
         }
         $alg = $this->createSearch($vertex);
 
-        return ($this->graph->getNumberOfVertices() === $alg->getNumberOfVertices());
+        return (count($this->graph->getVertices()) === count($alg->getVertices()));
     }
 
     /**

lib/Fhaculty/Graph/Algorithm/Degree.php

@@ -31,7 +31,7 @@ class Degree extends BaseGraph
     public function getDegree()
     {
         // get initial degree of any start vertex to compare others to
-        $degree = $this->getDegreeVertex($this->graph->getVertexFirst());
+        $degree = $this->getDegreeVertex($this->graph->getVertices()->getVertexFirst());
 
         foreach ($this->graph->getVertices() as $vertex) {
             /** @var $vertex Vertex */

lib/Fhaculty/Graph/Algorithm/Directed.php

@@ -4,21 +4,25 @@
 
 use Fhaculty\Graph\Algorithm\BaseGraph;
 use Fhaculty\Graph\Edge\Directed as EdgeDirected;
+use Fhaculty\Graph\Edge\Undirected as EdgeUndirected;
 
 /**
  * Basic algorithms for working with the undirected or directed Graphs (digraphs) / Walks.
  *
  * @link http://en.wikipedia.org/wiki/Glossary_of_graph_theory#Direction
  * @link http://en.wikipedia.org/wiki/Digraph_%28mathematics%29
  */
-class Directed extends BaseSet
+class Directed extends BaseDual
 {
     /**
-     * checks whether the graph has any directed edges (aka digraph)
+     * checks whether the graph has any directed edges
+     *
+     * This method is intentionally not named "isDirected()" (aka digraph),
+     * because that might be misleading in regards to empty and/or mixed graphs.
      *
      * @return boolean
      */
-    public function isDirected()
+    public function hasDirected()
     {
         foreach ($this->set->getEdges() as $edge) {
             if ($edge instanceof EdgeDirected) {
@@ -28,4 +32,35 @@ public function isDirected()
 
         return false;
     }
+
+    /**
+     * checks whether the graph has any undirected edges
+     *
+     * This method is intentionally not named "isUndirected()",
+     * because that might be misleading in regards to empty and/or mixed graphs.
+     *
+     * @return boolean
+     */
+    public function hasUndirected()
+    {
+        foreach ($this->set->getEdges() as $edge) {
+            if ($edge instanceof EdgeUndirected) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * checks whether this is a mixed graph (contains both directed and undirected edges)
+     *
+     * @return boolean
+     * @uses self::hasDirected()
+     * @uses self::hasUndirected()
+     */
+    public function isMixed()
+    {
+        return ($this->hasDirected() && $this->hasUndirected());
+    }
 }

lib/Fhaculty/Graph/Algorithm/Flow.php

@@ -18,7 +18,7 @@
  * @link http://en.wikipedia.org/wiki/Flow_network
  * @see Algorithm\Balance
  */
-class Flow extends BaseSet
+class Flow extends BaseDual
 {
     /**
      * check if this graph has any flow set (any edge has a non-NULL flow)

lib/Fhaculty/Graph/Algorithm/Loop.php

@@ -2,7 +2,7 @@
 
 namespace Fhaculty\Graph\Algorithm;
 
-use Fhaculty\Graph\Algorithm\BaseSet;
+use Fhaculty\Graph\Algorithm\BaseDual;
 use Fhaculty\Graph\Edge\Base as Edge;
 use Fhaculty\Graph\Vertex;
 
@@ -14,7 +14,7 @@
  *
  * @link http://en.wikipedia.org/wiki/Loop_%28graph_theory%29
  */
-class Loop extends BaseSet
+class Loop extends BaseDual
 {
     /**
      * checks whether this graph has any loops (edges from vertex to itself)

lib/Fhaculty/Graph/Algorithm/MaximumMatching/Flow.php

@@ -18,7 +18,7 @@ class Flow extends Base
     public function getEdges()
     {
         $alg = new Directed($this->graph);
-        if ($alg->isDirected()) {
+        if ($alg->hasDirected()) {
             throw new UnexpectedValueException('Input graph contains directed edges');
         }
 

lib/Fhaculty/Graph/Algorithm/MinimumSpanningTree/Kruskal.php

@@ -125,7 +125,7 @@ public function getEdges()
 
         // definition of spanning tree: number of edges = number of vertices - 1
         // above algorithm does not check isolated edges or may otherwise return multiple connected components => force check
-        if (count($returnEdges) !== ($this->graph->getNumberOfVertices() - 1)) {
+        if (count($returnEdges) !== (count($this->graph->getVertices()) - 1)) {
             throw new UnexpectedValueException('Graph is not connected');
         }