Implement DigraphIsKing and Digraph2Kings #521
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
james-d-mitchell
requested changes
Jan 5, 2022
| <Oper Name="Digraph2Kings" Arg="D"/> | ||
| <Returns>A list.</Returns> | ||
| <Description> | ||
| If <A>D</A> is a tournament then this operation returns a list of the |
There was a problem hiding this comment.
Suggested change
| If <A>D</A> is a tournament then this operation returns a list of the | |
| If <A>D</A> is a tournament, then this operation returns a list of the |
There was a problem hiding this comment.
The documentation should probably say what happens when D isn't a tournament, is an error thrown, or false returned or an empty list?
| <Description> | ||
| If <A>D</A> is a tournament and <A>v</A> is a vertex in the tournament, | ||
| then this operation returns <K>true</K> if every other vertex of <A>D</A> | ||
| is reachable from <A>v</A> by a path of length at most <A>k</A>. Else, |
There was a problem hiding this comment.
Suggested change
| is reachable from <A>v</A> by a path of length at most <A>k</A>. Else, | |
| is reachable from <A>v</A> by a path of length at most <A>k</A>. Otherwise, |
There was a problem hiding this comment.
The documentation doesn't correspond to the method implemented at present, it gives an error if D is not a tournament. Please update the documentation to reflect this.
| is reachable from <A>v</A> by a path of length at most <A>k</A>. Else, | ||
| <K>false</K> is returned. <P/> | ||
|
|
||
| If <K>true</K> is returned, then the vertex, <A>v</A>, is a k-king. <P/> |
There was a problem hiding this comment.
Suggested change
| If <K>true</K> is returned, then the vertex, <A>v</A>, is a k-king. <P/> | |
| If <K>true</K> is returned, then the vertex, <A>v</A>, is a <A>k</A>-king. <P/> |
wilfwilson
reviewed
Jan 6, 2022
| 2-kings in the tournament. If the tournament contains a source, then the | ||
| source is the only 2-king (see <Ref Attr="DigraphSources"/>). The number | ||
| of 2-kings in a tournament without a source is at least three. A tournament | ||
| cannot have exactly two 2-kings. |
There was a problem hiding this comment.
You could also please provide a cross reference in this manual entry to DigraphIsKing, so that a reader who doesn't know what a 2-king is can easily access that information 🙂
|
Stale pull request message |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.