Skip to content

Commit 1f70835

Browse files
committed
Add documentation for common aliases
1 parent c25894a commit 1f70835

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

src/Property/WalkProperty.php

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,9 @@ public function __construct(Walk $walk)
3333
/**
3434
* checks whether walk is a cycle (i.e. source vertex = target vertex)
3535
*
36+
* A cycle is also known as a closed path, a walk that is NOT a cycle is
37+
* alsos known as an open path.
38+
*
3639
* A walk with no edges is not considered a cycle. The shortest possible
3740
* cycle is a single loop edge.
3841
*
@@ -48,8 +51,11 @@ public function isCycle()
4851
/**
4952
* checks whether walk is a path (i.e. does not contain any duplicate edges)
5053
*
54+
* A path Walk is also known as a trail.
55+
*
5156
* @return bool
5257
* @uses self::hasArrayDuplicates()
58+
* @link http://www.proofwiki.org/wiki/Definition:Trail
5359
*/
5460
public function isPath()
5561
{
@@ -140,6 +146,8 @@ public function isTriangle()
140146
* contains no duplicate/repeated vertices (and thus no duplicate edges either)
141147
* other than the starting and ending vertices of cycles.
142148
*
149+
* A simple Walk is also known as a chain.
150+
*
143151
* @return boolean
144152
* @uses self::isCycle()
145153
* @uses self::hasArrayDuplicates()
@@ -158,6 +166,8 @@ public function isSimple()
158166
/**
159167
* checks whether walk is hamiltonian (i.e. walk over ALL VERTICES of the graph)
160168
*
169+
* A hamiltonian Walk is also known as a spanning walk.
170+
*
161171
* @return boolean
162172
* @see self::isEulerian() if you want to check for all EDGES instead of VERTICES
163173
* @uses self::isArrayContentsEqual()

0 commit comments

Comments
 (0)