Skip to content

Commit 9b84d8d

Browse files
authored
Merge pull request #153 from marclaporte/patch-1
Fix a typo and a link, and added a few links
2 parents 577ce76 + 879e1c0 commit 9b84d8d

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ foreach ($rome->getVerticesEdgeFrom() as $vertex) {
3636

3737
## Features
3838

39-
This library is built around the concept of [mathematical graph theory](http://en.wikipedia.org/wiki/Graph_%28mathematics%29) (i.e. it is **not** a [charting](http://en.wikipedia.org/wiki/Chart) library for drawing a [graph of a function](http://en.wikipedia.org/wiki/Graph_of_a_function)). In essence, a graph is a set of *nodes* with any number of *connections* inbetween. In graph theory, [vertices](http://en.wikipedia.org/wiki/Vertex_%28graph_theory%29) (plural of vertex) are an abstract representation of these *nodes*, while *connections* are represented as *edges*. Edges may be either undirected ("two-way") or directed ("one-way", aka di-edges, arcs).
39+
This library is built around the concept of [mathematical graph theory](https://en.wikipedia.org/wiki/Graph_theory) (i.e. it is **not** a [charting](http://en.wikipedia.org/wiki/Chart) library for drawing a [graph of a function](http://en.wikipedia.org/wiki/Graph_of_a_function)). In essence, a graph is a set of *nodes* with any number of *connections* in between. In graph theory, [vertices](http://en.wikipedia.org/wiki/Vertex_%28graph_theory%29) (plural of vertex) are an abstract representation of these *nodes*, while *connections* are represented as *edges*. Edges may be either undirected ("two-way") or directed ("one-way", aka di-edges, arcs).
4040

41-
Depending on how the edges are constructed, the whole graph can either be undirected, can be a [directed graph](http://en.wikipedia.org/wiki/Directed_graph) (aka digraph) or be a [mixed graph](http://en.wikipedia.org/wiki/Simple_graph#Mixed_graph). Edges are also allowed to form [loops](http://en.wikipedia.org/wiki/Loop_%28graph_theory%29) (i.e. an edge from vertex A pointing to vertex A again). Also, [multiple edges](http://en.wikipedia.org/wiki/Multiple_edges) from vertex A to vertex B are supported as well (aka parallel edges), effectively forming a [multigraph](http://en.wikipedia.org/wiki/Multigraph) (aka pseudograph). And of course, any combination thereof is supported as well. While many authors try to differentiate between these core concepts, this library tries hard to not impose any artificial limitations or assumptions on your graphs.
41+
Depending on how the edges are constructed, the whole graph can either be undirected, can be a [directed graph](http://en.wikipedia.org/wiki/Directed_graph) (aka digraph) or be a [mixed graph](https://en.wikipedia.org/wiki/Mixed_graph). Edges are also allowed to form [loops](http://en.wikipedia.org/wiki/Loop_%28graph_theory%29) (i.e. an edge from vertex A pointing to vertex A again). Also, [multiple edges](http://en.wikipedia.org/wiki/Multiple_edges) from vertex A to vertex B are supported as well (aka parallel edges), effectively forming a [multigraph](http://en.wikipedia.org/wiki/Multigraph) (aka pseudograph). And of course, any combination thereof is supported as well. While many authors try to differentiate between these core concepts, this library tries hard to not impose any artificial limitations or assumptions on your graphs.
4242

4343
## Components
4444

@@ -51,31 +51,31 @@ Following is a list of some highlighted components. A list of all official compo
5151

5252
### Graph drawing
5353

54-
This library is built to support visualizing graph images, including them into webpages, opening up images from within CLI applications and exporting them as PNG, JPEG or SVG file formats (among many others). Because [graph drawing](http://en.wikipedia.org/wiki/Graph_drawing) is a complex area on its own, the actual layouting of the graph is left up to the excelent [GraphViz](http://www.graphviz.org/) "Graph Visualization Software" and we merely provide some convenient APIs to interface with GraphViz.
54+
This library is built to support visualizing graph images, including them into webpages, opening up images from within CLI applications and exporting them as PNG, JPEG or SVG file formats (among many others). Because [graph drawing](http://en.wikipedia.org/wiki/Graph_drawing) is a complex area on its own, the actual layouting of the graph is left up to the excellent [GraphViz](http://www.graphviz.org/) "Graph Visualization Software" and we merely provide some convenient APIs to interface with GraphViz.
5555

5656
See [graphp/graphviz](https://github.com/graphp/graphviz) for more details.
5757

5858
### Common algorithms
5959

6060
Besides graph drawing, one of the most common things to do with graphs is running algorithms to solve common graph problems.
61-
Therefor this library is being used as the basis for implementations for a number of commonly used graph algorithms:
61+
Therefore this library is being used as the basis for implementations for a number of commonly used graph algorithms:
6262

6363
* Search
6464
* Deep first (DFS)
6565
* Breadth first search (BFS)
6666
* Shortest path
67-
* Dijkstra
67+
* [Dijkstra](https://en.wikipedia.org/wiki/Dijkstra%27s_algorithm)
6868
* Moore-Bellman-Ford (MBF)
6969
* Counting number of hops (simple BFS)
70-
* Minimum spanning tree (MST)
70+
* [Minimum spanning tree (MST)](https://en.wikipedia.org/wiki/Minimum_spanning_tree)
7171
* Kruskal
7272
* Prim
73-
* Traveling salesman problem (TSP)
73+
* [Traveling salesman problem (TSP)](https://en.wikipedia.org/wiki/Travelling_salesman_problem)
7474
* Bruteforce algorithm
7575
* Minimum spanning tree heuristic (TSP MST heuristic)
7676
* Nearest neighbor heuristic (NN heuristic)
7777
* Maximum flow
78-
* Edmonds-Karp
78+
* [Edmonds-Karp](https://en.wikipedia.org/wiki/Edmonds%E2%80%93Karp_algorithm)
7979
* Minimum cost flow (MCF)
8080
* Cycle canceling
8181
* Successive shortest path
@@ -101,7 +101,7 @@ A list of all official components can be found in the [graphp project](https://g
101101

102102
## Tests
103103

104-
This library uses phpunit for its extensive testsuite.
104+
This library uses PHPUnit for its extensive test suite.
105105
You can either use a global installation or rely on the one composer installs
106106
when you first run `$ composer install`.
107107
This sets up the developer environment, so that you
@@ -113,7 +113,7 @@ $ php vendor/bin/phpunit
113113

114114
## Contributing
115115

116-
This library comes with an extensive testsuite and is regularly tested and used in the *real world*.
116+
This library comes with an extensive test suite and is regularly tested and used in the *real world*.
117117
Despite this, this library is still considered beta software and its API is subject to change.
118118
The [changelog](CHANGELOG.md) lists all relevant information for updates between releases.
119119

0 commit comments

Comments
 (0)