Extend FreeModule factory to construction of FiniteRankFreeModule and CombinatorialFreeModule

[mkoeppe]

This is to improve discoverability of these implementations of free modules.

Follow-up:

• Add construction methods to FiniteRankFreeModule, CombinatorialFreeModule and Cartesian products #30235: Add construction methods to FiniteRankFreeModule and CombinatorialFreeModule

CC: @tscrim @nthiery @mjungmath @egourgoulhon

Component: linear algebra

Author: Matthias Koeppe

Branch/Commit: c23b9a4

Reviewer: Travis Scrimshaw

Issue created by migration from https://trac.sagemath.org/ticket/30194

[mkoeppe]

Branch: u/mkoeppe/extend_freemodule_factory_to_construction_of_finiterankfreemodule_and_combinatorialfreemodule

[sagetrac-git]

Commit: 549ebf3

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

549ebf3

Create CombinatorialFreeModule if basis keys given

[sagetrac-git]

Changed commit from 549ebf3 to 88391a2

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

88391a2

CombinatorialFreeModule: Add construction

[sagetrac-git]

Changed commit from 88391a2 to d7d1c14

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:

2a81585	Draft
1fe1d3c	Create CombinatorialFreeModule if basis keys given
d7d1c14	CombinatorialFreeModule: Add construction

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

69fea07	zero_vector: Handle bad input like zero_vector(3.6) before passing it to ZZ.__pow__
6d0fe39	FreeModule: SImplify argument handling

[sagetrac-git]

Changed commit from d7d1c14 to 6d0fe39

[mkoeppe]

Author: Matthias Koeppe

[sagetrac-git]

Changed commit from 6d0fe39 to 4d87237

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

4d87237

src/sage/misc/sageinspect.py: Do not use FreeModule as an example for a class instance

[tscrim]

comment:9

I am happy with this change, but a lot more documentation is needed. Likely you will want to move most of the doc from the FreeModuleFactory.

[mkoeppe]

comment:10

Replying to @tscrim:

Likely you will want to move most of the doc from the FreeModuleFactory.

Yes, will do.

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

47dce47

Extend VectorSpace factory in the same way

[sagetrac-git]

Changed commit from 4d87237 to 47dce47

[sagetrac-git]

Changed commit from 47dce47 to 93c8b79

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

33f0d37	Move documentation from FreeModuleFactory to FreeModule
93c8b79	FreeModule: Add to documentation

[mkoeppe]

comment:13

Documentation needs more work

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

d0c65b4

More documentation

[sagetrac-git]

Changed commit from 93c8b79 to d0c65b4

[sagetrac-git]

Changed commit from d0c65b4 to 78d0633

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:

9ee2a48	Create CombinatorialFreeModule if basis keys given
d08ee98	zero_vector: Handle bad input like zero_vector(3.6) before passing it to ZZ.__pow__
5d56004	FreeModule: SImplify argument handling
9116a1c	src/sage/misc/sageinspect.py: Do not use FreeModule as an example for a class instance
20b10f0	Extend VectorSpace factory in the same way
6af7fa4	Move documentation from FreeModuleFactory to FreeModule
5910876	FreeModule: Add to documentation
78d0633	More documentation

[mkoeppe]

comment:19

Replying to @tscrim:

The construction() will need a doctest.

I have taken out the commit that adds it; I will continue with that on #30235.

[tscrim]

comment:20

Doctest failures in src/sage/structure/factory.pyx according to the patchbot.

[mkoeppe]

comment:21

Thanks, I'll fix this

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

1a07ec4

sage.structure.factory: Update doctests that used FreeModule

[sagetrac-git]

Changed commit from 78d0633 to 1a07ec4

[sagetrac-git]

Changed commit from 1a07ec4 to 0aec972

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

0aec972

Merge tag '9.2.beta7' into t/30194/extend_freemodule_factory_to_construction_of_finiterankfreemodule_and_combinatorialfreemodule

[mkoeppe]

comment:24

patchbot plugin complains about this:

+       EXAMPLE::
+       EXAMPLE::
+       EXAMPLE::

These are headers for a single example each. Should this be changed, or do we just ignore this plugin message?

[egourgoulhon]

comment:25

Replying to @mkoeppe:

patchbot plugin complains about this:

+       EXAMPLE::
+       EXAMPLE::
+       EXAMPLE::

These are headers for a single example each. Should this be changed, or do we just ignore this plugin message?

I think the convention is to always use EXAMPLES (plural) even for a single example, hence the patchbot complaint.

[sagetrac-git]

Changed commit from 0aec972 to d293450

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

d293450

src/sage/modules/free_module.py: EXAMPLE -> EXAMPLES

[tscrim]

comment:27

Thank you. One minor nitpick:

-        TODO: replace the above by ``TestSuite(...).run()``, once
-        :meth:`_test_pickling` will test unique representation and not
-        only equality.
+        .. TODO::
+
+            Replace the above by ``TestSuite(...).run()``, once
+            :meth:`_test_pickling` will test unique representation
+            and not only equality.

Once changed, you can set a positive review on my behalf.

[tscrim]

Reviewer: Travis Scrimshaw

[sagetrac-git]

Changed commit from d293450 to c23b9a4

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1 and set ticket back to needs_review. New commits:

c23b9a4

Fix doc formatting

[mkoeppe]

comment:29

Thanks!

[vbraun]

Changed branch from u/mkoeppe/extend_freemodule_factory_to_construction_of_finiterankfreemodule_and_combinatorialfreemodule to c23b9a4