Skip to content

Commit

Permalink
one-line outputs (5/7)
Browse files Browse the repository at this point in the history
  • Loading branch information
gmou3 committed Jun 5, 2024
1 parent c284b26 commit 021184a
Show file tree
Hide file tree
Showing 99 changed files with 588 additions and 1,670 deletions.
8 changes: 2 additions & 6 deletions src/sage/modules/diamond_cutting.py
Original file line number Diff line number Diff line change
Expand Up @@ -139,9 +139,7 @@ def diamond_cut(V, GM, C, verbose=False):
- ``verbose`` -- (default: ``False``) whether to print debug information
OUTPUT:
A :class:`Polyhedron` instance.
OUTPUT: a :class:`Polyhedron` instance
EXAMPLES::
Expand Down Expand Up @@ -244,9 +242,7 @@ def calculate_voronoi_cell(basis, radius=None, verbose=False):
- ``verbose`` -- whether to print debug information
OUTPUT:
A :class:`Polyhedron` instance.
OUTPUT: a :class:`Polyhedron` instance
EXAMPLES::
Expand Down
36 changes: 9 additions & 27 deletions src/sage/modules/filtered_vector_space.py
Original file line number Diff line number Diff line change
Expand Up @@ -135,9 +135,7 @@ def is_FilteredVectorSpace(X):
- ``X`` -- anything.
OUTPUT:
Boolean.
OUTPUT: boolean
EXAMPLES::
Expand Down Expand Up @@ -225,9 +223,7 @@ def normalize_degree(deg):
- ``deg`` -- something that defines the degree (either integer or
infinity).
OUTPUT:
Plus/minus infinity or a Sage integer.
OUTPUT: plus/minus infinity or a Sage integer
EXAMPLES::
Expand Down Expand Up @@ -511,9 +507,7 @@ def ambient_vector_space(self):
"""
Return the ambient (unfiltered) vector space.
OUTPUT:
A vector space.
OUTPUT: a vector space
EXAMPLES::
Expand Down Expand Up @@ -560,9 +554,7 @@ def is_exhaustive(self):
A filtration `\{F_d\}` in an ambient vector space `V` is
exhaustive if `\cup F_d = V`. See also :meth:`is_separating`.
OUTPUT:
Boolean.
OUTPUT: boolean
EXAMPLES::
Expand All @@ -585,9 +577,7 @@ def is_separating(self):
A filtration `\{F_d\}` in an ambient vector space `V` is
exhaustive if `\cap F_d = 0`. See also :meth:`is_exhaustive`.
OUTPUT:
Boolean.
OUTPUT: boolean
EXAMPLES::
Expand Down Expand Up @@ -729,9 +719,7 @@ def graded(self, d):
- ``d`` -- integer. The degree.
OUTPUT:
The quotient `G_d = F_d / F_{d+1}`.
OUTPUT: the quotient `G_d = F_d / F_{d+1}`
EXAMPLES::
Expand Down Expand Up @@ -824,9 +812,7 @@ def _repr_vector_space(self, dim):
- ``dim`` -- integer.
OUTPUT:
String representation of the vector space of dimension ``dim``.
OUTPUT: string representation of the vector space of dimension ``dim``
EXAMPLES::
Expand Down Expand Up @@ -876,9 +862,7 @@ def _repr_(self):
r"""
Return as string representation of ``self``.
OUTPUT:
A string.
OUTPUT: string
EXAMPLES::
Expand Down Expand Up @@ -984,9 +968,7 @@ def direct_sum(self, other):
- ``other`` -- a filtered vector space.
OUTPUT:
The direct sum as a filtered vector space.
OUTPUT: the direct sum as a filtered vector space
EXAMPLES::
Expand Down
8 changes: 2 additions & 6 deletions src/sage/modules/free_module.py
Original file line number Diff line number Diff line change
Expand Up @@ -1038,9 +1038,7 @@ def some_elements(self):
See :class:`TestSuite` for a typical use case.
OUTPUT:
An iterator.
OUTPUT: an iterator
EXAMPLES::
Expand Down Expand Up @@ -2532,9 +2530,7 @@ def cardinality(self):
r"""
Return the cardinality of the free module.
OUTPUT:
Either an integer or ``+Infinity``.
OUTPUT: either an integer or ``+Infinity``
EXAMPLES::
Expand Down
16 changes: 4 additions & 12 deletions src/sage/modules/free_module_element.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -609,9 +609,7 @@ def prepare(v, R, degree=None):
- ``degree`` -- a requested size for the list when the input is a dictionary,
otherwise ignored
OUTPUT:
A pair.
OUTPUT: a pair
The first item is a list of the values specified in the object ``v``.
If the object is a dictionary , entries are placed in the list
Expand Down Expand Up @@ -1020,9 +1018,7 @@ cdef class FreeModuleElement(Vector): # abstract base class
"""
Convert ``self`` to a PARI vector.
OUTPUT:
A PARI ``gen`` of type ``t_VEC``.
OUTPUT: a PARI ``gen`` of type ``t_VEC``
EXAMPLES::
Expand All @@ -1046,9 +1042,7 @@ cdef class FreeModuleElement(Vector): # abstract base class
Give a string which, when evaluated in GP, gives a PARI
representation of ``self``.
OUTPUT:
A string.
OUTPUT: string
EXAMPLES::
Expand Down Expand Up @@ -2807,9 +2801,7 @@ cdef class FreeModuleElement(Vector): # abstract base class
and also `w \cdot \hat{v} = w \times v` for all vectors `w`.
The basis vectors are assumed to be orthonormal.
OUTPUT:
The cross product matrix of this vector.
OUTPUT: the cross product matrix of this vector
EXAMPLES::
Expand Down
32 changes: 8 additions & 24 deletions src/sage/modules/free_module_integer.py
Original file line number Diff line number Diff line change
Expand Up @@ -484,9 +484,7 @@ def volume(self):
r"""
Return `vol(L)` which is `\sqrt{\det(B \cdot B^T)}` for any basis `B`.
OUTPUT:
An integer.
OUTPUT: integer
EXAMPLES::
Expand All @@ -505,9 +503,7 @@ def discriminant(self):
Return `|\det(G)|`, i.e. the absolute value of the determinant of the
Gram matrix `B \cdot B^T` for any basis `B`.
OUTPUT:
An integer.
OUTPUT: integer
EXAMPLES::
Expand All @@ -522,9 +518,7 @@ def is_unimodular(self):
"""
Return ``True`` if this lattice is unimodular.
OUTPUT:
A boolean.
OUTPUT: boolean
EXAMPLES::
Expand Down Expand Up @@ -611,9 +605,7 @@ def update_reduced_basis(self, w):
- ``w`` -- a vector
OUTPUT:
Nothing is returned but the internal state is modified.
OUTPUT: nothing is returned but the internal state is modified
EXAMPLES::
Expand Down Expand Up @@ -641,9 +633,7 @@ def voronoi_cell(self, radius=None):
- ``radius`` -- (default: automatic determination) radius of ball
containing considered vertices
OUTPUT:
The Voronoi cell as a Polyhedron instance.
OUTPUT: the Voronoi cell as a Polyhedron instance
The result is cached so that subsequent calls to this function
return instantly.
Expand Down Expand Up @@ -702,9 +692,7 @@ def voronoi_relevant_vectors(self):
"""
Compute the embedded vectors inducing the Voronoi cell.
OUTPUT:
The list of Voronoi relevant vectors.
OUTPUT: the list of Voronoi relevant vectors
EXAMPLES::
Expand Down Expand Up @@ -744,9 +732,7 @@ def closest_vector(self, t):
- ``t`` -- the target vector to compute the closest vector to
OUTPUT:
The vector in the lattice closest to ``t``.
OUTPUT: the vector in the lattice closest to ``t``
EXAMPLES::
Expand Down Expand Up @@ -831,9 +817,7 @@ def approximate_closest_vector(self, t, delta=None, *args, **kwargs):
- ``**kwds`` -- passed through to :meth:`LLL`
OUTPUT:
The vector `w` described above.
OUTPUT: the vector `w` described above
EXAMPLES::
Expand Down
16 changes: 4 additions & 12 deletions src/sage/modules/multi_filtered_vector_space.py
Original file line number Diff line number Diff line change
Expand Up @@ -142,9 +142,7 @@ def index_set(self):
"""
Return the allowed indices for the different filtrations.
OUTPUT:
Set.
OUTPUT: set
EXAMPLES::
Expand Down Expand Up @@ -199,9 +197,7 @@ def ambient_vector_space(self):
"""
Return the ambient (unfiltered) vector space.
OUTPUT:
A vector space.
OUTPUT: a vector space
EXAMPLES::
Expand Down Expand Up @@ -355,9 +351,7 @@ def get_filtration(self, key):
"""
Return the filtration indexed by ``key``.
OUTPUT:
A filtered vector space.
OUTPUT: a filtered vector space
EXAMPLES::
Expand Down Expand Up @@ -434,9 +428,7 @@ def _repr_(self):
r"""
Return as string representation of ``self``.
OUTPUT:
A string.
OUTPUT: string
EXAMPLES::
Expand Down
8 changes: 2 additions & 6 deletions src/sage/modules/tensor_operations.py
Original file line number Diff line number Diff line change
Expand Up @@ -209,9 +209,7 @@ def n_vectors(self):
"""
Return the number of vectors
OUTPUT:
Integer.
OUTPUT: integer
EXAMPLES::
Expand Down Expand Up @@ -552,9 +550,7 @@ def codomain(self):
"""
The codomain of the index map.
OUTPUT:
A list of integers. The image of :meth:`index_map`.
OUTPUT: a list of integers. The image of :meth:`index_map`
EXAMPLES::
Expand Down
4 changes: 1 addition & 3 deletions src/sage/modules/torsion_quadratic_module.py
Original file line number Diff line number Diff line change
Expand Up @@ -333,9 +333,7 @@ def _module_constructor(self, V, W, check=False):
* if ``False``, then the value modulus is inherited from ``self``
* if ``True``, it figures it out on its own. But that is expensive
OUTPUT:
The quotient ``V / W`` as a :class:`TorsionQuadraticModule`.
OUTPUT: the quotient ``V / W`` as a :class:`TorsionQuadraticModule`
EXAMPLES::
Expand Down
4 changes: 1 addition & 3 deletions src/sage/modules/with_basis/morphism.py
Original file line number Diff line number Diff line change
Expand Up @@ -477,9 +477,7 @@ class TriangularModuleMorphism(ModuleMorphism):
- :class:`ModuleMorphismFromFunction` and
:class:`TriangularModuleMorphism`.
OUTPUT:
A morphism from `X` to `Y`.
OUTPUT: a morphism from `X` to `Y`
.. WARNING::
Expand Down
4 changes: 1 addition & 3 deletions src/sage/monoids/free_abelian_monoid.py
Original file line number Diff line number Diff line change
Expand Up @@ -128,9 +128,7 @@ def FreeAbelianMonoid(index_set=None, names=None, **kwds):
- ``names`` -- names of generators
OUTPUT:
A free abelian monoid.
OUTPUT: a free abelian monoid
EXAMPLES::
Expand Down
4 changes: 1 addition & 3 deletions src/sage/monoids/free_monoid.py
Original file line number Diff line number Diff line change
Expand Up @@ -88,9 +88,7 @@ class FreeMonoid(Monoid_class, UniqueRepresentation):
- ``commutative`` -- (default: ``False``) whether the free
monoid is commutative or not
OUTPUT:
A free monoid.
OUTPUT: a free monoid
EXAMPLES::
Expand Down
Loading

0 comments on commit 021184a

Please sign in to comment.