Merge pull request #75 from clue/remove-set

Remove base `Set`

Author: clue

CHANGELOG.md

@@ -75,6 +75,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)).
 

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,7 +65,6 @@ private function createSearch(Vertex $vertex)
      * connected here.
      *
      * @return boolean
-     * @uses AlgorithmSearchBreadthFirst::getNumberOfVertices()
      * @see self::getNumberOfComponents()
      */
     public function isSingle()
@@ -79,7 +78,7 @@ public function isSingle()
         }
         $alg = $this->createSearch($vertex);
 
-        return ($this->graph->getNumberOfVertices() === $alg->getNumberOfVertices());
+        return (count($this->graph->getVertices()) === count($alg->getVertices()));
     }
 
     /**

lib/Fhaculty/Graph/Algorithm/Directed.php

@@ -11,7 +11,7 @@
  * @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)

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/MinimumCostFlow/SuccessiveShortestPath.php

@@ -124,13 +124,12 @@ public function createGraph()
      * @param  Graph     $graph
      * @return boolean
      * @throws Exception if given graph is not a clone of the original graph (each vertex has to be present in both graphs)
-     * @uses Graph::getNumberOfVertices()
      * @uses Graph::getBalanace()
      * @uses Graph::getVertex()
      */
     private function isBalanceReached(Graph $graph)
     {
-        if ($graph->getNumberOfVertices() !== $this->graph->getNumberOfVertices()) {
+        if (count($graph->getVertices()) !== count($this->graph->getVertices())) {
             throw new DomainException('Given graph does not appear to be a clone of input graph');
         }
         foreach ($this->graph->getVertices()->getMap() as $vid => $vertex) {

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');
         }
 

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

@@ -35,7 +35,7 @@ public function getEdges()
         $returnEdges = array();
 
         // iterate n-1 times (per definition, resulting MST MUST have n-1 edges)
-        for ($i = 0, $n = $this->startVertex->getGraph()->getNumberOfVertices() - 1; $i < $n; ++$i) {
+        for ($i = 0, $n = count($this->startVertex->getGraph()->getVertices()) - 1; $i < $n; ++$i) {
             $markInserted[$vertexCurrent->getId()] = true;
 
             // get unvisited vertex of the edge and add edges from new vertex

lib/Fhaculty/Graph/Algorithm/Property/GraphProperty.php

@@ -46,6 +46,6 @@ public function isNull()
      */
     public function isTrivial()
     {
-        return ($this->graph->getEdges()->isEmpty() && $this->graph->getNumberOfVertices() === 1);
+        return ($this->graph->getEdges()->isEmpty() && count($this->graph->getVertices()) === 1);
     }
 }