Skip to content

Commit ce094d1

Browse files
author
Xavier Caruso
committed
add details in documentation
1 parent 1a65521 commit ce094d1

File tree

3 files changed

+23
-6
lines changed

3 files changed

+23
-6
lines changed

src/sage/modules/free_module.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3163,6 +3163,8 @@ def pseudohom(self, f, twist, codomain=None, side="left"):
31633163
pseudomorphism
31643164
31653165
- ``twist`` -- the twisting morphism or the twisting derivation
3166+
(if a derivation is given, the corresponding morphism `\theta`
3167+
is automatically infered)
31663168
31673169
- ``codomain`` -- (default: ``None``) the codomain of the pseudo
31683170
morphisms; if ``None``, the codomain is the same than the domain

src/sage/modules/free_module_pseudohomspace.py

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,10 @@ class FreeModulePseudoHomspace(UniqueRepresentation, HomsetWithBase):
3737
For free modules, the elements of a pseudomorphism correspond to matrices
3838
which define the mapping on elements of a basis.
3939
40+
This class is not supposed to be instantiated directly; the user should
41+
use instead the method :meth:`sage.rings.module.free_module.FreeModule_generic.pseudoHom`
42+
to create a space of pseudomorphisms.
43+
4044
TESTS::
4145
4246
sage: F = GF(125)
@@ -57,11 +61,12 @@ def __classcall_private__(cls, domain, codomain, twist):
5761
5862
INPUT:
5963
60-
- ``domain`` -- a free module, the domain of this pseudomorphism
64+
- ``domain`` -- a free module, the domain of this pseudomorphism
6165
62-
- ``codomain`` -- a free module, the codomain of this pseudomorphism
66+
- ``codomain`` -- a free module, the codomain of this pseudomorphism
6367
64-
- ``twist`` -- a twisting morphism/derivation or a Ore polynomial ring
68+
- ``twist`` -- a twisting morphism/derivation or the corresponding
69+
Ore polynomial ring
6570
6671
TESTS::
6772
@@ -94,11 +99,12 @@ def __init__(self, domain, codomain, ore):
9499
95100
INPUT:
96101
97-
- ``domain`` -- a free module, the domain of this pseudomorphism
102+
- ``domain`` -- a free module, the domain of this pseudomorphism
98103
99-
- ``codomain`` -- a free module, the codomain of this pseudomorphism
104+
- ``codomain`` -- a free module, the codomain of this pseudomorphism
100105
101-
- ``ore`` -- the underlying Ore polynomial ring
106+
- ``ore`` -- the underlying Ore polynomial ring (built from the
107+
twisting morphism and derivation)
102108
103109
TESTS::
104110

src/sage/modules/free_module_pseudomorphism.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,15 @@ class FreeModulePseudoMorphism(Morphism):
4545
The map `\theta` (resp. `\delta`) is referred to as the
4646
twisting endomorphism (resp. the twisting derivation) of `f`.
4747
48+
.. NOTE::
49+
50+
The implementation currently requires that `M` and `M'`
51+
are free modules.
52+
53+
This class is not supposed to be instantiated directly; the user should
54+
use instead the method :meth:`sage.rings.module.free_module.FreeModule_generic.pseudohom`
55+
to create a pseudomorphism.
56+
4857
TESTS::
4958
5059
sage: P.<x> = ZZ[]

0 commit comments

Comments
 (0)