#15255: Assign correct name to GridGraph
---------------------------------+----------------------------
Reporter: dcoudert | Owner:
Type: enhancement | Status: needs_review
Priority: trivial | Milestone: sage-5.13
Component: graph theory | Resolution:
Keywords: | Merged in:
Authors: David Coudert | Reviewers:
Report Upstream: N/A | Work issues:
Branch: | Commit:
Dependencies: | Stopgaps:
---------------------------------+----------------------------
Old description:
> The name assigned to GridGraph was incorrect because the
> {{{networkx.grid_graph(dim)}}} method modifies the input list of
> dimensions. This patch solves this issue.
>
> Before:
> {{{
> sage: G = graphs.GridGraph([2,3,4])
> sage: G
> Grid Graph for []: Graph on 24 vertices
> sage: G = graphs.Grid2dGraph(4,5)
> sage: G
> 2D Grid Graph: Graph on 20 vertices
> }}}
>
> After:
> {{{
> sage: G = graphs.GridGraph([2,3,4])
> sage: G
> Grid Graph for [2, 3, 4]: Graph on 24 vertices
> sage: G = graphs.Grid2dGraph(4,5)
> sage: G
> 2D Grid Graph for (4, 5): Graph on 20 vertices
> }}}
New description:
The name assigned to GridGraph was incorrect because the
{{{networkx.grid_graph(dim)}}} method modifies the input list of
dimensions. This patch solves this issue.
Before:
{{{
sage: G = graphs.GridGraph([2,3,4])
sage: G
Grid Graph for []: Graph on 24 vertices
sage: G = graphs.Grid2dGraph(4,5)
sage: G
2D Grid Graph: Graph on 20 vertices
}}}
After:
{{{
sage: G = graphs.GridGraph([2,3,4])
sage: G
Grid Graph for [2, 3, 4]: Graph on 24 vertices
sage: G = graphs.Grid2dGraph(4,5)
sage: G
2D Grid Graph for [4, 5]: Graph on 20 vertices
}}}
--
Comment (by dcoudert):
Grid2DGraph don't call GridGraph and so names are set in each function.
I have changed the Grid2DGraph function so that in uses {{{[]}}} too.
We can find many other methods for which the naming convention is not
consistent. For instance:
{{{
sage: G = graphs.Toroidal6RegularGrid2dGraph(6,6)
sage: G
Toroidal Hexagonal Grid graph on 6x6 elements: Graph on 36 vertices
sage: G = graphs.ToroidalGrid2dGraph(6,6)
sage: G
Toroidal 2D Grid Graph with parameters 6,6: Graph on 36 vertices
}}}
Should I try to fix them too in this patch? but then which is the best
convention?
Thanks.
--
Ticket URL: <http://trac.sagemath.org/ticket/15255#comment:3>
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.
