Skip to content

Commit 9f19839

Browse files
committed
Improve documentation
1 parent 105948c commit 9f19839

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

src/Complete.php

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,29 @@
44

55
use Fhaculty\Graph\Graph;
66

7+
/**
8+
* Basic algorithms for working with complete graphs
9+
*
10+
* A complete graph is a graph in which every pair of vertices is connected
11+
* by an edge.
12+
*
13+
* @link http://en.wikipedia.org/wiki/Complete_graph
14+
* @link http://mathworld.wolfram.com/CompleteGraph.html
15+
*/
716
class Complete extends Base
817
{
918
/**
19+
* Graph to operate on
1020
*
1121
* @var Graph
1222
*/
1323
private $graph;
1424

25+
/**
26+
* instantiate new complete algorithm
27+
*
28+
* @param Graph $graph
29+
*/
1530
public function __construct(Graph $graph)
1631
{
1732
$this->graph = $graph;

0 commit comments

Comments
 (0)