Skip to content
This repository has been archived by the owner on Jan 30, 2023. It is now read-only.

Commit

Permalink
matroids_plot_helpers: rst fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
mezzarobba committed Apr 11, 2015
1 parent a3261b8 commit ca7ac34
Showing 1 changed file with 20 additions and 18 deletions.
38 changes: 20 additions & 18 deletions src/sage/matroids/matroids_plot_helpers.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
- Jayant Apte (2014-06-06): initial version
.. NOTE::
.. NOTE::
This file provides functions that are called by ``show()`` and ``plot()``
methods of abstract matroids class. The basic idea is to first decide
Expand All @@ -28,22 +28,24 @@
matroid. Loops and parallel elements are added as per conventions in
[Oxley] using function ``addlp``. The priority order for point placement
methods used inside plot() and show() is as follows:
1) User Specified points dictionary and lineorders
2) cached point placement dictionary and line orders (a list of ordered
lists) in M._cached_info (a dictionary)
3) Internal point placement and orders deciding heuristics
If a custom point placement and/or line orders is desired, then user can
simply specify the custom points dictionary as ``M.cached info =
{'plot_positions':<dictionary_of _points>,
'plot_lineorders':<list of lists>}``
1. User Specified points dictionary and lineorders
2. cached point placement dictionary and line orders (a list of ordered
lists) in M._cached_info (a dictionary)
3. Internal point placement and orders deciding heuristics
If a custom point placement and/or line orders is desired, then user
can simply specify the custom points dictionary as::
M.cached info = {'plot_positions':<dictionary_of _points>,
'plot_lineorders':<list of lists>}
REFERENCES
==========
.. [Oxley] James Oxley, "Matroid Theory, Second Edition". Oxford University
Press, 2011.
[Oxley] James Oxley, "Matroid Theory, Second Edition". Oxford University
Press, 2011.
EXAMPLES::
Expand Down Expand Up @@ -744,16 +746,16 @@ def geomrep(M1, B1=None, lineorders1=None, pd=None, sp=False):
- ``M1`` -- A matroid.
- ``B1`` -- (optional) A list of elements in ``M1.groundset()`` that
correspond to a basis of ``M1`` and will be placed as vertices of the
triangle in the geometric representation of ``M1``.
correspond to a basis of ``M1`` and will be placed as vertices of the
triangle in the geometric representation of ``M1``.
- ``lineorders1`` -- (optional) A list of ordered lists of elements of
``M1.grondset()`` such that if a line in geometric representation is
setwise same as any of these then points contained will be traversed in
that order thus overriding internal order deciding heuristic.
``M1.grondset()`` such that if a line in geometric representation is
setwise same as any of these then points contained will be traversed in
that order thus overriding internal order deciding heuristic.
- ``pd`` - (optional) A dictionary mapping ground set elements to their
(x,y) positions.
(x,y) positions.
- ``sp`` -- (optional) If True, a positioning dictionary and line orders
will be placed in ``M._cached_info``.
will be placed in ``M._cached_info``.
OUTPUT:
Expand Down

0 comments on commit ca7ac34

Please sign in to comment.