#14980: graph_generators, some more clean up
----------------------------------+-------------------------------
Reporter: eisermbi | Owner:
Type: enhancement | Status: positive_review
Priority: major | Milestone: sage-5.12
Component: graph theory | Resolution:
Keywords: | Merged in:
Authors: Birk Eisermann | Reviewers: Nathann Cohen
Report Upstream: N/A | Work issues:
Branch: | Commit:
Dependencies: | Stopgaps:
----------------------------------+-------------------------------
Changes (by eisermbi):
* status: needs_review => positive_review
Old description:
> While adding some graph generators I found some confusing things which I
> like
> to improve with this patch first.
>
> * Why are Butterfly, Krackhardt Kite, Barbell graph listed under
> "Basic Structures" while Peterson Graph and CompleteGraph are not?
> Maybe the term "basic structures" is subjective and everyone has a
> different opinion about basic...
>
> * What is a "small graph"? A graph with a small number of vertices,
> alright?
> E.g. 13 vertices on http://www.graphclasses.org/smallgraphs.html
> In general not much more than 15 or 20 vertices. Can "Balaban11Cage()"
> with 112 vertices, "CameronGraph()" with 231 vertices, "Tutte12Cage()"
> with 126 vertices be called "small graphs"??
>
> Overview of modifications on the files 'sage/graphs/graph_generators.py'
> and 'sage/graphs/generators/*'.
>
> Part 1
> * "Small Graphs" (also called "named graphs" previously): Added
> documentation: "A small graph is just a single graph and has no parameter
> influencing the number of edges or vertices."
>
> * Families of Graphs: Added documentation: "A family of graph is an
> infinite set of graphs which can be indexed by fixed number of
> parameters, e.g. two parameters."
>
> * Pseudofractal graphs: The graph "DorogovtsevGoltsevMendesGraph" seems
> to be a quite special graph family. Does it need its own section? I
> completely moved it to Families now.
>
> * HararyGraph is a family of graphs.
>
> Part 2
> * "Platonic Solids" is a subsection of "Small graphs". This section is
> ordered by number of vertices now.
>
> * "Chessboard graphs" is a subsection of "Families".
>
> * RandomGNP returns graph, hence, "n" -- number of nodes of the graph
> (not: ''digraph'')
>
> * NEW: {{{benzenoids}}} is replaced by {{{fusenes}}} in
> {{{__append_to_doc}}}.
>
> Part 3 (not to be applied anymore)
>
> Part 4
> * "Basic structures": Actually these graphs could be listed in the other
> classes. Three not so basic graphs are moved: "BarbellGraph",
> "WheelGraph" to families and "BuckyGraph" to small graphs. The example at
> the beginning of the module is expanded.
>
> Part 5
> * replaces {{{...}}} by {{{....:}}} in doctests;
> * replaces {{{graph.Graph(......)}}} by {{{Graph(......)}}}.
>
> ----
>
> '''Apply:'''
> - [attachment:trac_14980-part1_docu.patch]
> - [attachment:trac_14980-part2_docu.patch]
> - [attachment:trac_14980-part4_basic.patch]
> - [attachment:trac_14980-part5_doctests.patch]
>
> (The 'part3' patch is *NOT* to be applied)
New description:
While adding some graph generators I found some confusing things which I
like
to improve with this patch first.
* Why are Butterfly, Krackhardt Kite, Barbell graph listed under
"Basic Structures" while Peterson Graph and CompleteGraph are not?
Maybe the term "basic structures" is subjective and everyone has a
different opinion about basic...
* What is a "small graph"? A graph with a small number of vertices,
alright?
E.g. 13 vertices on http://www.graphclasses.org/smallgraphs.html
In general not much more than 15 or 20 vertices. Can "Balaban11Cage()"
with 112 vertices, "CameronGraph()" with 231 vertices, "Tutte12Cage()"
with 126 vertices be called "small graphs"??
Overview of modifications on the files 'sage/graphs/graph_generators.py'
and 'sage/graphs/generators/*'.
Part 1
* "Small Graphs" (also called "named graphs" previously): Added
documentation: "A small graph is just a single graph and has no parameter
influencing the number of edges or vertices."
* Families of Graphs: Added documentation: "A family of graph is an
infinite set of graphs which can be indexed by fixed number of parameters,
e.g. two parameters."
* Pseudofractal graphs: The graph "DorogovtsevGoltsevMendesGraph" seems to
be a quite special graph family. Does it need its own section? I
completely moved it to Families now.
* HararyGraph is a family of graphs.
Part 2
* "Platonic Solids" is a subsection of "Small graphs". This section is
ordered by number of vertices now.
* "Chessboard graphs" is a subsection of "Families".
* RandomGNP returns graph, hence, "n" -- number of nodes of the graph
(not: ''digraph'')
* {{{benzenoids}}} is replaced by {{{fusenes}}} in {{{__append_to_doc}}}.
Part 3 (not to be applied anymore)
Part 4
* "Basic structures": Actually these graphs could be listed in the other
classes. Three not so basic graphs are moved: "BarbellGraph", "WheelGraph"
to families and "BuckyGraph" to small graphs. The example at the beginning
of the module is expanded.
Part 5
* replaces {{{...}}} by {{{....:}}} in doctests and removes some empty
"....:" lines after loops;
* replaces {{{graph.Graph(......)}}} by {{{Graph(......)}}}.
----
'''Apply:'''
- [attachment:trac_14980-part1_docu.patch]
- [attachment:trac_14980-part2_docu.patch]
- [attachment:trac_14980-part4_basic.patch]
- [attachment:trac_14980-part5_doctests_noemptylines.patch]
(The 'part3' patch is *NOT* to be applied)
--
Comment:
I saw these empty lines in the examples, too, and was wondering whether to
remove them. Since the examples are short and there is indention, those
empty lines hardly improve readability but take up vertical space. Hence,
I have chosen your version. Since you have agreed I set the ticket to
{{{positive_review}}}.
--
Ticket URL: <http://trac.sagemath.org/ticket/14980#comment:11>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica,
and MATLAB
--
You received this message because you are subscribed to the Google Groups
"sage-trac" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/sage-trac.
For more options, visit https://groups.google.com/groups/opt_out.
