Skip to content

Commit a342fbe

Browse files
author
Xavier Caruso
committed
improve documentation
1 parent 941e26f commit a342fbe

File tree

3 files changed

+22
-28
lines changed

3 files changed

+22
-28
lines changed

src/sage/modules/free_module.py

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3156,16 +3156,13 @@ def pseudohom(self, f, twist, codomain=None, side="left"):
31563156
f(\lambda x) = \theta(\lambda) f(x) + \delta(\lambda) x
31573157
31583158
When `\delta` is nonzero, this requires that `M` coerces into `M'`.
3159-
.. WARNING::
31603159
3161-
At the moment, it is not possible to specify both a twisting
3162-
endomorphism and a twisting derivation. Only one of those can be
3163-
used, preferably using the `twist` argument.
3160+
.. NOTE::
31643161
3165-
We represent pseudo morphisms by matrices with coefficient in the base
3166-
ring `R`. See class
3167-
:class:`sage.modules.free_module_pseudomorphism.FreeModulePseudoMorphism`
3168-
for details.
3162+
Internally, pseudomorphisms are represented by matrices with
3163+
coefficient in the base ring `R`. See class
3164+
:class:`sage.modules.free_module_pseudomorphism.FreeModulePseudoMorphism`
3165+
for details.
31693166
31703167
INPUT:
31713168

src/sage/modules/free_module_pseudohomspace.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,10 @@ def _repr_(self):
202202

203203
def ore_ring(self, var='x'):
204204
r"""
205-
Return the underlying Ore polynomial ring.
205+
Return the underlying Ore polynomial ring, that is
206+
the Ore polynomial ring over the base field twisted
207+
by the twisting morphism and the twisting derivation
208+
attached to this homspace.
206209
207210
INPUT:
208211

src/sage/modules/free_module_pseudomorphism.py

Lines changed: 13 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -49,21 +49,15 @@ class FreeModulePseudoMorphism(Morphism):
4949
5050
The implementation currently requires that `M` and `M'`
5151
are free modules.
52-
.. WARNING::
53-
54-
At the moment, it is not possible to specify both a twisting
55-
endomorphism and a twisting derivation. Only one of those can be
56-
used, preferably using the `twist` argument in the method
57-
:meth:`sage.rings.module.free_module.FreeModule_generic.pseudohom`.
58-
59-
We represent pseudo morphisms by matrices with coefficient in the
60-
base ring `R`. The matrix `\mathcal M_f` representing a pseudo
61-
morphism is such that its lines (resp. columns if ``side`` is
62-
``"right"``) are the coordinates of the images of the distinguished
63-
basis of the domain (see also method :meth:`matrix`). More
64-
concretely, let `n` (resp. `n'`) be the dimension of `M` (resp.
65-
`M'`), let `(e_1, \dots, e_n)` be a basis of `M`. For any `x =
66-
\sum_{i=1}^n x_i e_i \in M`, we have
52+
53+
We represent pseudomorphisms by matrices with coefficient in the
54+
base ring `R`. The matrix `\mathcal M_f` representing `f` is such
55+
that its lines (resp. columns if ``side`` is ``"right"``) are the
56+
coordinates of the images of the distinguished basis of the domain
57+
(see also method :meth:`matrix`).
58+
More concretely, let `n` (resp. `n'`) be the dimension of `M`
59+
(resp. `M'`), let `(e_1, \dots, e_n)` be a basis of `M`.
60+
For any `x = \sum_{i=1}^n x_i e_i \in M`, we have
6761
6862
.. MATH::
6963
@@ -77,23 +71,23 @@ class FreeModulePseudoMorphism(Morphism):
7771
\end{pmatrix}
7872
.
7973
80-
If ``side`` is ``"right"``, we have:
74+
When ``side`` is ``"right"``, the formula is
8175
8276
.. MATH::
8377
8478
f(x) = \mathcal M_f
8579
\begin{pmatrix}
8680
\theta(x_1) \\ \vdots \\ \theta(x_n)
8781
\end{pmatrix}
88-
8982
+
9083
\begin{pmatrix}
9184
\delta(x_1) \\ \vdots \\ \theta(x_n)
9285
\end{pmatrix}
9386
.
9487
95-
This class is not supposed to be instantiated directly; the user should
96-
use instead the method :meth:`sage.rings.module.free_module.FreeModule_generic.pseudohom`
88+
This class is not supposed to be instantiated directly; the user
89+
should use instead the method
90+
:meth:`sage.rings.module.free_module.FreeModule_generic.pseudohom`
9791
to create a pseudomorphism.
9892
9993
TESTS::

0 commit comments

Comments
 (0)