Skip to content

Commit 57790ae

Browse files
committed
Add documentation
1 parent 31bb160 commit 57790ae

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

src/Directed.php

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,29 @@
55
use Fhaculty\Graph\Set;
66
use Fhaculty\Graph\Algorithm\Base;
77
use Fhaculty\Graph\Edge\Directed as EdgeDirected;
8+
use Fhaculty\Graph\Graph;
9+
use Fhaculty\Graph\Walk;
810

11+
/**
12+
* Basic algorithms for working with the undirected or directed Graphs (digraphs) / Walks.
13+
*
14+
* @link http://en.wikipedia.org/wiki/Glossary_of_graph_theory#Direction
15+
* @link http://en.wikipedia.org/wiki/Digraph_%28mathematics%29
16+
*/
917
class Directed extends Base
1018
{
19+
/**
20+
* Graph/Walk to operate on
21+
*
22+
* @var Set
23+
*/
1124
private $set;
1225

26+
/**
27+
* instanciate new directed algorithm
28+
*
29+
* @param Set|Graph|Walk $graphOrWalk either the Graph or Walk to operate on (or the common base class Set)
30+
*/
1331
public function __construct(Set $graphOrWalk)
1432
{
1533
$this->set = $graphOrWalk;

0 commit comments

Comments
 (0)