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

Commit

Permalink
FreeModule: Add to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Matthias Koeppe committed Jul 28, 2020
1 parent 6af7fa4 commit 5910876
Showing 1 changed file with 16 additions and 5 deletions.
21 changes: 16 additions & 5 deletions src/sage/modules/free_module.py
Original file line number Diff line number Diff line change
Expand Up @@ -269,21 +269,32 @@ def create_object(self, version, key):
def FreeModule(base_ring, rank_or_basis_keys=None, sparse=False, inner_product_matrix=None, *,
with_basis='standard', rank=None, basis_keys=None, **args):
"""
Create a free module over the given commutative ``base_ring`` of the given
rank.
Create a free module over the given commutative ``base_ring``
INPUT:
``FreeModule`` can be called with the following positional arguments:
- ``FreeModule(base_ring, rank, ...)``
- ``FreeModule(base_ring, basis_keys, ...)``
INPUT:
- ``base_ring`` - a commutative ring
- ``rank`` - a nonnegative integer
- ``basis_keys`` - a finite or enumerated family of arbitrary objects
- ``sparse`` - bool; (default False)
- ``inner_product_matrix`` - the inner product
matrix (default None)
- ``inner_product_matrix`` - the inner product matrix (default ``None``)
- ``with_basis`` - either ``"standard"`` (the default), in which case
a free module with the standard basis as the distinguished basis is created;
or ``None``, in which case a free module without distinguished basis is
created.
- further options may be accepted by various implementation classes
OUTPUT: a free module
Expand Down

0 comments on commit 5910876

Please sign in to comment.