Skip to content

Commit abf4ca6

Browse files
committed
Add documentation
1 parent 26f876c commit abf4ca6

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

src/Symmetric.php

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,28 @@
66
use Fhaculty\Graph\Graph;
77
use Fhaculty\Graph\Vertex;
88

9+
/**
10+
* Basic algorithms for working with symmetric digraphs
11+
*
12+
* A directed graph is called symmetric if, for every arc that belongs to it,
13+
* the corresponding reversed arc (antiparallel directed edge) also belongs to it.
14+
*
15+
* @link http://en.wikipedia.org/wiki/Directed_graph#Classes_of_digraphs
16+
*/
917
class Symmetric extends Base
1018
{
1119
/**
12-
*
20+
* Graph to operate on
21+
*
1322
* @var Graph
1423
*/
1524
private $graph;
1625

26+
/**
27+
* instantiate symmetric algorithm
28+
*
29+
* @param Graph $graph Graph
30+
*/
1731
public function __construct(Graph $graph)
1832
{
1933
$this->graph = $graph;

0 commit comments

Comments
 (0)