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

Commit

Permalink
added docstrings to the new methods
Browse files Browse the repository at this point in the history
  • Loading branch information
Jonathan Kliem committed Oct 21, 2019
1 parent 7701062 commit 1b17f6e
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions src/sage/geometry/polyhedron/combinatorial_polyhedron/base.pyx
Expand Up @@ -1435,33 +1435,69 @@ cdef class CombinatorialPolyhedron(SageObject):
return self._all_faces.get_face(dim, newindex)

cdef tuple V(self):
r"""
Return the names of the Vrepresentation, if they exist. Else return ``None``.
"""
return self._V

cdef tuple H(self):
r"""
Return the names Hrepresentatives, which are facets.
If not given, return ``None``.
"""
return self._H

cdef tuple equalities(self):
r"""
Return the names of the equalities.
If not equalities are given, return ``None``.
"""
return self._equalities

cdef unsigned int length_Vrepr(self):
r"""
Return the number of elements in the Vrepresentation.
"""
return self._length_Vrepr

cdef unsigned int length_Hrepr(self):
r"""
Return the number of elements in the Hrepresentation.
"""
return self._length_Hrepr

cdef bint unbounded(self):
r"""
Return whether the polyhedron is unbounded.
"""
return self._unbounded

cdef ListOfFaces bitrep_facets(self):
r"""
Return the facets in bit representation.
"""
return self._bitrep_facets

cdef ListOfFaces bitrep_Vrepr(self):
r"""
Return the Vrepresentations in bit representation.
"""
return self._bitrep_Vrepr

cdef ListOfFaces far_face(self):
r"""
Return a list with only the far face.
This is a face containing all Vrepresentatives that are not vertices.
"""
return self._far_face

cdef tuple far_face_tuple(self):
r"""
Return the far face as it was given on initialization.
"""
return self._far_face_tuple

cdef int _compute_f_vector(self) except -1:
Expand Down

0 comments on commit 1b17f6e

Please sign in to comment.