Initial project skeleton

Author: clue

.gitignore

@@ -0,0 +1,2 @@
+/vendor
+/composer.lock

.travis.yml

@@ -0,0 +1,11 @@
+language: php
+php:
+  - 5.6
+  - 5.5
+  - 5.4
+  - 5.3
+  - hhvm
+install:
+  - composer install --prefer-source --no-interaction
+script:
+  - php vendor/bin/phpunit --coverage-text

CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+## 0.8.0 (2015-xx-xx)
+
+*   First tagged release, split off from [clue/graph](https://github.com/clue/graph) v0.8.0
+    ([#1](https://github.com/graphp/algorithms/issues/1))

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Christian Lück
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is furnished
+to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,21 @@
+# graphp/algorithms [![Build Status](https://travis-ci.org/graphp/algorithms.svg?branch=master)](https://travis-ci.org/graphp/algorithms)
+
+Common mathematical graph algorithms implemented in PHP
+
+> Note: This project is in beta stage! Feel free to report any issues you encounter.
+
+## Install
+
+The recommended way to install this library is [through composer](http://getcomposer.org). [New to composer?](http://getcomposer.org/doc/00-intro.md)
+
+```JSON
+{
+    "require": {
+        "graphp/algorithms": "dev-master"
+    }
+}
+```
+
+## License
+
+Released under the terms of the permissive [MIT license](http://opensource.org/licenses/MIT).

composer.json

@@ -0,0 +1,23 @@
+{
+    "name": "graphp/algorithms",
+    "description": "Common mathematical graph algorithms",
+    "keywords": ["Graph algorithms", "shortest path", "dijkstra", "moore-bellman-ford", "minimum spanning tree", "kruskal", "prim"],
+    "homepage": "https://github.com/graphp/algorithms",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Christian Lück",
+            "email": "[email protected]"
+        }
+    ],
+    "require": {
+        "php": ">=5.3",
+        "clue/graph": "~0.8.0"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "~4.0"
+    },
+    "autoload": {
+        "psr-4": {"Graphp\\Algorithms\\": "src/"}
+    }
+}

phpunit.xml.dist

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<phpunit bootstrap="tests/bootstrap.php"
+         colors="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+>
+    <testsuites>
+        <testsuite name="Algorithm Test Suite">
+            <directory>./tests/</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist>
+            <directory>./src/</directory>
+        </whitelist>
+    </filter>
+</phpunit>

tests/bootstrap.php

@@ -0,0 +1,100 @@
+<?php
+
+use Fhaculty\Graph\Edge\Directed;
+use Fhaculty\Graph\Edge\Base as Edge;
+use Fhaculty\Graph\Graph;
+use Fhaculty\Graph\Vertex;
+use Fhaculty\Graph\Set\Vertices;
+
+(include_once __DIR__ . '/../vendor/autoload.php') OR die(PHP_EOL . 'ERROR: composer autoloader not found, run "composer install" or see README for instructions' . PHP_EOL);
+
+class TestCase extends PHPUnit_Framework_TestCase
+{
+    protected function assertGraphEquals(Graph $expected, Graph $actual)
+    {
+        $f = function(Graph $graph){
+            $ret = get_class($graph);
+            $ret .= PHP_EOL . 'vertices: ' . count($graph->getVertices());
+            $ret .= PHP_EOL . 'edges: ' . count($graph->getEdges());
+
+            return $ret;
+        };
+
+        // assert graph base parameters are equal
+        $this->assertEquals($f($expected), $f($actual));
+
+        // next, assert that all vertices in both graphs are the same
+        // each vertex has a unique ID, therefor it's easy to search a matching partner
+        // do not use assertVertexEquals() in order to not increase assertion counter
+
+        foreach ($expected->getVertices()->getMap() as $vid => $vertex) {
+            try {
+                $other = $actual->getVertex($vid);
+            } catch (Exception $e) {
+                $this->fail();
+            }
+            if ($this->getVertexDump($vertex) !== $this->getVertexDump($vertex)) {
+                $this->fail();
+            }
+        }
+
+        // next, assert that all edges in both graphs are the same
+        // assertEdgeEquals() does not work, as the order of the edges is unknown
+        // therefor, build an array of edge dump and make sure each entry has a match
+
+        $edgesExpected = array();
+        foreach ($expected->getEdges() as $edge) {
+            $edgesExpected []= $this->getEdgeDump($edge);
+        }
+
+        foreach ($actual->getEdges() as $edge) {
+            $dump = $this->getEdgeDump($edge);
+
+            $pos = array_search($dump, $edgesExpected, true);
+            if ($pos === false) {
+                $this->fail('given edge ' . $dump . ' not found');
+            } else {
+                unset($edgesExpected[$pos]);
+            }
+        }
+    }
+
+    protected function assertVertexEquals(Vertex $expected, Vertex $actual)
+    {
+        $this->assertEquals($this->getVertexDump($expected), $this->getVertexDump($actual));
+    }
+
+    protected function assertEdgeEquals(Edge $expected, Edge $actual)
+    {
+        $this->assertEquals($this->getEdgeDump($expected), $this->getEdgeDump($actual));
+    }
+
+    private function getVertexDump(Vertex $vertex)
+    {
+        $ret = get_class($vertex);
+
+        $ret .= PHP_EOL . 'id: ' . $vertex->getId();
+        $ret .= PHP_EOL . 'attributes: ' . json_encode($vertex->getAttributeBag()->getAttributes());
+        $ret .= PHP_EOL . 'balance: ' . $vertex->getBalance();
+        $ret .= PHP_EOL . 'group: ' . $vertex->getGroup();
+
+        return $ret;
+    }
+
+    private function getEdgeDump(Edge $edge)
+    {
+        $ret = get_class($edge) . ' ';
+        if ($edge instanceof Directed) {
+            $ret .= $edge->getVertexStart()->getId() . ' -> ' . $edge->getVertexEnd()->getId();
+        } else {
+            $vertices = $edge->getVertices()->getIds();
+            $ret .= $vertices[0] . ' -- ' . $vertices[1];
+        }
+        $ret .= PHP_EOL . 'flow: ' . $edge->getFlow();
+        $ret .= PHP_EOL . 'capacity: ' . $edge->getCapacity();
+        $ret .= PHP_EOL . 'weight: ' . $edge->getWeight();
+        $ret .= PHP_EOL . 'attributes: ' . json_encode($edge->getAttributeBag()->getAttributes());
+
+        return $ret;
+    }
+}