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

Commit

Permalink
correct hyperlinks
Browse files Browse the repository at this point in the history
  • Loading branch information
Jonathan Kliem committed Apr 18, 2019
1 parent 9b69f50 commit 4e8fd8c
Show file tree
Hide file tree
Showing 5 changed files with 59 additions and 54 deletions.
32 changes: 18 additions & 14 deletions src/sage/geometry/polyhedron/combinatorial_polyhedron/base.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ CombinatorialPolyhedron
This module gathers algorithms for polyhedra that only depend on the
vertex-facet incidences.
Most importantly, one can construct a fast :class:`.face_iterator.FaceIterator`.
Most importantly, one can construct a fast :class:`~sage.geometry.polyhedron.combinatorial_polyhedron.face_iterator.FaceIterator`.
This module uses this construction to quickly generate
- the f-vector,
- the edges,
Expand Down Expand Up @@ -62,7 +62,7 @@ Face lattice::
sage: C.face_lattice()
Finite lattice containing 82 elements
:class:`.face_iterator.FaceIterator`::
:class:`~sage.geometry.polyhedron.combinatorial_polyhedron.face_iterator.FaceIterator`::
sage: C.face_iter()
Iterator over the proper faces of a polyhedron of dimension 4
Expand Down Expand Up @@ -163,13 +163,13 @@ cdef class CombinatorialPolyhedron(SageObject):
EXAMPLES:
Input is :meth:`Polyhedron`::
Input is polyhedron:
sage: P = polytopes.cube()
sage: CombinatorialPolyhedron(P)
Combinatorial type of a polyhedron of dimension 3 with 8 vertices
Input is a LatticePolytope::
Input is a lattice polytope::
sage: points = [(1,0,0), (0,1,0), (0,0,1),
....: (-1,0,0), (0,-1,0), (0,0,-1)]
Expand Down Expand Up @@ -1201,11 +1201,12 @@ cdef class CombinatorialPolyhedron(SageObject):
OUTPUT:
- :class:`FaceIterator`
- :class:`~sage.geometry.polyhedron.combinatorial_polyhedron.face_iterator.FaceIterator`
.. NOTE::
:class:`FaceIterator` is more than just a plain iterator.
:class:`~sage.geometry.polyhedron.combinatorial_polyhedron.face_iterator.FaceIterator`
is more than just a plain iterator.
By default it will iterate over the dimensions of the faces, but
more information can be received.
Expand Down Expand Up @@ -1269,7 +1270,7 @@ cdef class CombinatorialPolyhedron(SageObject):
.. SEEALSO::
:class:`FaceIterator`.
:class:`~sage.geometry.polyhedron.combinatorial_polyhedron.face_iterator.FaceIterator`.
"""
cdef FaceIterator face_iter
if dual is None:
Expand All @@ -1285,7 +1286,8 @@ cdef class CombinatorialPolyhedron(SageObject):
r"""
A method to obtain the FaceIterator as Cython object.
``dimension`` is the ``output_dimension`` of :class:`FaceIterator`.
``dimension`` is the ``output_dimension`` of
:class:`~sage.geometry.polyhedron.combinatorial_polyhedron.face_iterator.FaceIterator`.
If ``dimension == -2`` this will indicate no ``output_dimension``.
See :meth:`CombinatorialPolyhedron.face_iter`
Expand Down Expand Up @@ -1445,8 +1447,9 @@ cdef class CombinatorialPolyhedron(SageObject):
def face_lattice_vertex_repr(self, index, names=True):
r"""
Return for each element in :meth:`CombinatorialPolyhedron.face_lattice`
its vertex-representation as in :meth:`ListOfAllFaces.vertex_repr` or
:meth:`FaceIterator.vertex_repr`.
its vertex-representation as in
:meth:`~sage.geometry.polyhedron.combinatorial_polyhedron.list_of_all_faces.ListOfAllFaces.vertex_repr`
or :meth:`~sage.geometry.polyhedron.combinatorial_polyhedron.face_iterator.FaceIterator.vertex_repr`.
If ``names`` is set to ``True``, then names of the
``[vertices, rays, lines]`` are used.
Expand Down Expand Up @@ -1542,8 +1545,9 @@ cdef class CombinatorialPolyhedron(SageObject):
def face_lattice_facet_repr(self, index, names=True):
r"""
Return for each element in :meth:`CombinatorialPolyhedron.face_lattice`
its facet-representation as in :meth:`ListOfAllFaces.facet_repr` or
:meth:`FaceIterator.facet_repr`.
its facet-representation as in
:meth:`~sage.geometry.polyhedron.combinatorial_polyhedron.list_of_all_faces.ListOfAllFaces.facet_repr`
or :meth:`~sage.geometry.polyhedron.combinatorial_polyhedron.face_iterator.FaceIterator.facet_repr`.
If ``names`` is set to ``True``, then names of the
``facets`` are used.
Expand Down Expand Up @@ -1764,7 +1768,7 @@ cdef class CombinatorialPolyhedron(SageObject):
face_iter = self._face_iter(dual, 1)
else:
# ``output_dimension`` in
# :meth:`FaceIterator.__init__`
# :meth:`~sage.geometry.polyhedron.combinatorial_polyhedron.face_iterator.FaceIterator.__init__`
# requires the dimension of the original polyhedron
face_iter = self._face_iter(dual, dim - 2)

Expand Down Expand Up @@ -2088,7 +2092,7 @@ cdef class CombinatorialPolyhedron(SageObject):

def _record_all_faces(self):
r"""
Initialize :class:`ListOfAllFaces` for the polyhedron.
Initialize :class:`~sage.geometry.polyhedron.combinatorial_polyhedron.list_of_all_faces.ListOfAllFaces` for the polyhedron.
Record and sort all faces of the polyhedron in that class.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
r"""
Conversions
This module provides conversions to class:`.list_of_faces.ListOfFaces` from
This module provides conversions to class:`~sage.geometry.polyhedron.combinatorial_polyhedron.list_of_faces.ListOfFaces` from
- an incidence matrix of a polyhedron or
- a tuple of facets (as tuple of vertices each).
Also this module provides a conversion from the data of class:`list_of_faces.ListOfFaces`,
Also this module provides a conversion from the data of class:`~sage.geometry.polyhedron.combinatorial_polyhedron.list_of_faces.ListOfFaces`,
which is a Bit-vector representing incidences of a face,
to a list of entries which are incident.
.. SEEALSO::
:mod:`.list_of_faces`,
:mod:`.face_iterator`,
:mod:`.base`.
:mod:`~sage.geometry.polyhedron.combinatorial_polyhedron.list_of_faces`,
:mod:`~sage.geometry.polyhedron.combinatorial_polyhedron.face_iterator`,
:mod:`~sage.geometry.polyhedron.combinatorial_polyhedron.base`.
EXAMPLES:
Obtain the facets of a polyhedron as :class:`.list_of_faces.ListOfFaces`::
Obtain the facets of a polyhedron as :class:`~sage.geometry.polyhedron.combinatorial_polyhedron.list_of_faces.ListOfFaces`::
sage: from sage.geometry.polyhedron.combinatorial_polyhedron.conversions \
....: import incidence_matrix_to_bit_repr_of_facets
Expand All @@ -28,7 +28,7 @@ Obtain the facets of a polyhedron as :class:`.list_of_faces.ListOfFaces`::
4
Obtain the vertices of a polyhedron as facet-incidences stored in
:class:`.list_of_faces.ListOfFaces`::
:class:`~sage.geometry.polyhedron.combinatorial_polyhedron.list_of_faces.ListOfFaces`::
sage: from sage.geometry.polyhedron.combinatorial_polyhedron.conversions \
....: import incidence_matrix_to_bit_repr_of_vertices
Expand All @@ -37,7 +37,7 @@ Obtain the vertices of a polyhedron as facet-incidences stored in
sage: face_list.compute_dimension()
4
Obtain the facets of a polyhedron as :class:`.list_of_faces.ListOfFaces` from a facet list::
Obtain the facets of a polyhedron as :class:`~sage.geometry.polyhedron.combinatorial_polyhedron.list_of_faces.ListOfFaces` from a facet list::
sage: from sage.geometry.polyhedron.combinatorial_polyhedron.conversions \
....: import facets_tuple_to_bit_repr_of_facets
Expand Down Expand Up @@ -232,7 +232,7 @@ cdef int incidences_to_bit_repr(tuple incidences, uint64_t *output,

def incidence_matrix_to_bit_repr_of_facets(matrix):
r"""
Initialize facets in Bit-representation as :class:`ListOfFaces`.
Initialize facets in Bit-representation as :class:`~sage.geometry.polyhedron.combinatorial_polyhedron.list_of_faces.ListOfFaces`.
INPUT:
Expand All @@ -241,7 +241,7 @@ def incidence_matrix_to_bit_repr_of_facets(matrix):
OUTPUT:
- :class:`ListOfFaces`
- :class:`~sage.geometry.polyhedron.combinatorial_polyhedron.list_of_faces.ListOfFaces`
EXAMPLES::
Expand Down Expand Up @@ -317,7 +317,7 @@ def incidence_matrix_to_bit_repr_of_facets(matrix):

def incidence_matrix_to_bit_repr_of_vertices(matrix):
r"""
Initialize vertices in Bit-representation as :class:`ListOfFaces`.
Initialize vertices in Bit-representation as :class:`~sage.geometry.polyhedron.combinatorial_polyhedron.list_of_faces.ListOfFaces`.
Each vertex is represented as the facets it is contained in.
Those are the facets of the polar polyhedron, if it exists.
Expand All @@ -329,7 +329,7 @@ def incidence_matrix_to_bit_repr_of_vertices(matrix):
OUTPUT:
- :class:`ListOfFaces`
- :class:`~sage.geometry.polyhedron.combinatorial_polyhedron.list_of_faces.ListOfFaces`
EXAMPLES::
Expand Down Expand Up @@ -414,7 +414,7 @@ def incidence_matrix_to_bit_repr_of_vertices(matrix):

def facets_tuple_to_bit_repr_of_facets(tuple facets_input, size_t nr_vertices):
r"""
Initializes facets in Bit-representation as :class:`ListOfFaces`.
Initializes facets in Bit-representation as :class:`~sage.geometry.polyhedron.combinatorial_polyhedron.list_of_faces.ListOfFaces`.
INPUT:
Expand All @@ -424,7 +424,7 @@ def facets_tuple_to_bit_repr_of_facets(tuple facets_input, size_t nr_vertices):
OUTPUT:
- :class:`ListOfFaces`
- :class:`~sage.geometry.polyhedron.combinatorial_polyhedron.list_of_faces.ListOfFaces`
EXAMPLES::
Expand Down Expand Up @@ -477,7 +477,7 @@ def facets_tuple_to_bit_repr_of_facets(tuple facets_input, size_t nr_vertices):

def facets_tuple_to_bit_repr_of_vertices(tuple facets_input, size_t nr_vertices):
r"""
Initialize vertices in Bit-representation as :class:`ListOfFaces`.
Initialize vertices in Bit-representation as :class:`~sage.geometry.polyhedron.combinatorial_polyhedron.list_of_faces.ListOfFaces`.
Each vertex is represented as the facets it is contained in.
Those are the facets of the polar polyhedron, if it exists.
Expand All @@ -490,7 +490,7 @@ def facets_tuple_to_bit_repr_of_vertices(tuple facets_input, size_t nr_vertices)
OUTPUT:
- :class:`ListOfFaces`
- :class:`~sage.geometry.polyhedron.combinatorial_polyhedron.list_of_faces.ListOfFaces`
EXAMPLES::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -178,15 +178,15 @@ cdef class FaceIterator(SageObject):
INPUT:
- ``C`` -- a :class:`CombinatorialPolyhedron`
- ``C`` -- a :class:`~sage.geometry.polyhedron.combinatorial_polyhedron.base.CombinatorialPolyhedron`
- ``dual`` -- if ``True``, then dual polyhedron is used for iteration
(only possible for bounded Polyhedra)
- ``output_dimension`` -- if not ``None``, then the FaceIterator will only yield
faces of this dimension
.. SEEALSO::
:class:`CombinatorialPolyhedron`.
:class:`~sage.geometry.polyhedron.combinatorial_polyhedron.base.CombinatorialPolyhedron`.
EXAMPLES:
Expand Down Expand Up @@ -537,7 +537,7 @@ cdef class FaceIterator(SageObject):
INPUT:
- ``names`` -- if ``True`` returns the names of the ``[vertices, rays, lines]``
as given on initialization of the :class:`CombinatorialPolyhedron`
as given on initialization of the :class:`~sage.geometry.polyhedron.combinatorial_polyhedron.base.CombinatorialPolyhedron`
EXAMPLES::
Expand Down Expand Up @@ -638,7 +638,7 @@ cdef class FaceIterator(SageObject):
INPUT:
- ``names`` -- if ``True`` returns the names of the ``[facets, equations]``
as given on initialization of :class:`CombinatorialPolyhedron`
as given on initialization of :class:`~sage.geometry.polyhedron.combinatorial_polyhedron.base.CombinatorialPolyhedron`
EXAMPLES::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ ListOfAllFaces
This module provides a class that stores and sorts all faces of the polyhedron.
:class:`.base.CombinatorialPolyhedron` implicitely uses this class to generate
:class:`~sage.geometry.polyhedron.combinatorial_polyhedron.base.CombinatorialPolyhedron` implicitely uses this class to generate
the face lattice of a polyhedron.
Terminology in this module:
Expand Down Expand Up @@ -40,7 +40,7 @@ EXAMPLES::
.. SEEALSO::
:mod:`.base`,
:mod:`~sage.geometry.polyhedron.combinatorial_polyhedron.base`,
:class:`ListOfAllFaces`.
AUTHOR:
Expand Down Expand Up @@ -75,24 +75,24 @@ cdef extern from "Python.h":

cdef class ListOfAllFaces:
r"""
A class to generate incidences of :class:`CombinatorialPolyhedron`.
A class to generate incidences of :class:`~sage.geometry.polyhedron.combinatorial_polyhedron.base.CombinatorialPolyhedron`.
On initialization all faces of the given :class:`CombinatorialPolyhedron`
On initialization all faces of the given :class:`~sage.geometry.polyhedron.combinatorial_polyhedron.base.CombinatorialPolyhedron`
are added and sorted (except coatoms). The incidences can be used to
generate the ``face_lattice``.
Might generate the faces of the dual polyhedron for speed.
INPUT:
- :class:`CombinatorialPolyhedron`
- :class:`~sage.geometry.polyhedron.combinatorial_polyhedron.baseCombinatorialPolyhedron`
.. SEEALSO::
:meth:`CombinatorialPolyhedron._record_all_faces`,
:meth:`CombinatorialPolyhedron._record_all_faces_helper`,
:meth:`CombinatorialPolyhedron.face_lattice`,
:meth:`CombinatorialPolyhedron._compute_face_lattice_incidences`.
:meth:`~sage.geometry.polyhedron.combinatorial_polyhedron.base.CombinatorialPolyhedron._record_all_faces`,
:meth:`~sage.geometry.polyhedron.combinatorial_polyhedron.base.CombinatorialPolyhedron._record_all_faces_helper`,
:meth:`~sage.geometry.polyhedron.combinatorial_polyhedron.base.CombinatorialPolyhedron.face_lattice`,
:meth:`~sage.geometry.polyhedron.combinatorial_polyhedron.base.CombinatorialPolyhedron._compute_face_lattice_incidences`.
EXAMPLES::
Expand All @@ -103,7 +103,7 @@ cdef class ListOfAllFaces:
ALGORITHM:
The faces are recorded with :class:`FaceIterator` in Bit-representation.
The faces are recorded with :class:`~sage.geometry.polyhedron.combinatorial_polyhedron.face_iterator.FaceIterator` in Bit-representation.
Once created, all level-sets but the coatoms are sorted with merge sort.
Non-trivial incidences of elements whos rank differs by 1 are determined
by intersecting with all coatoms. Then each intersection is looked up in
Expand Down Expand Up @@ -418,7 +418,7 @@ cdef class ListOfAllFaces:
- ``dimension`` -- dimension of the face
- ``index`` -- index of the face
- ``names`` -- if ``True`` returns the names of the ``[vertices, rays, lines]``
as given on initialization of :class:`CombinatorialPolyhedron`
as given on initialization of :class:`~sage.geometry.polyhedron.combinatorial_polyhedron.base.CombinatorialPolyhedron`
EXAMPLES::
Expand Down Expand Up @@ -500,7 +500,7 @@ cdef class ListOfAllFaces:
- ``dimension`` -- dimension of the face
- ``index`` -- index of the face
- ``names`` -- if ``True`` returns the names of the ``[facets, equations]``
as given on initialization of :class:`CombinatorialPolyhedron`
as given on initialization of :class:`~sage.geometry.polyhedron.combinatorial_polyhedron.base.CombinatorialPolyhedron`
EXAMPLES::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ This module provides a class to store faces of a polyhedron in Bit-representatio
This class allocates memory to store the faces in.
A face will be stored as vertex-incidences, where each Bit represents an incidence.
In :mod:`.conversions` there a methods to actually convert facets of a polyhedron
In :mod:`~sage.geometry.polyhedron.combinatorial_polyhedron.conversions` there a methods to actually convert facets of a polyhedron
to bit-representations of vertices stored in :class:`ListOfFaces`.
Moreover, :class:`ListOfFaces` calculates the dimension of a polyhedron, assuming the
faces are the facets of this polyhedron.
Each face is stored over-aligned according to :meth:`.bit_vector_operations.chunktype`.
Each face is stored over-aligned according to :meth:`~sage.geometry.polyhedron.combinatorial_polyhedron.bit_vector_operations.chunktype`.
EXAMPLES:
Expand Down Expand Up @@ -56,10 +56,10 @@ Likewise for the vertices as facet-incidences::
.. SEEALSO::
:mod:`.base`,
:mod:`.face_iterator`,
:mod:`.conversions`,
:mod:`.list_of_all_faces`.
:mod:`~sage.geometry.polyhedron.combinatorial_polyhedron.base`,
:mod:`~sage.geometry.polyhedron.combinatorial_polyhedron.face_iterator`,
:mod:`~sage.geometry.polyhedron.combinatorial_polyhedron.conversions`,
:mod:`~sage.geometry.polyhedron.combinatorial_polyhedron.list_of_all_faces`.
AUTHOR:
Expand All @@ -75,6 +75,7 @@ AUTHOR:
# (at your option) any later version.
# http://www.gnu.org/licenses/
#*****************************************************************************

from __future__ import absolute_import, division
from sage.structure.element import is_Matrix

Expand All @@ -101,8 +102,8 @@ cdef class ListOfFaces:
:meth:`incidence_matrix_to_bit_repr_of_vertices`,
:meth:`facets_tuple_to_bit_repr_of_facets`,
:meth:`facets_tuple_to_bit_repr_of_vertices`,
:class:`FaceIterator`,
:class:`CombinatorialPolyhedron`.
:class:`~sage.geometry.polyhedron.combinatorial_polyhedron.face_iterator.FaceIterator`,
:class:`~sage.geometry.polyhedron.combinatorial_polyhedron.base.CombinatorialPolyhedron`.
EXAMPLES::
Expand Down

0 comments on commit 4e8fd8c

Please sign in to comment.