Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FreeModuleAutomorphism: Add more invariants #37826

Merged
merged 3 commits into from May 2, 2024

Conversation

mkoeppe
Copy link
Member

@mkoeppe mkoeppe commented Apr 18, 2024

We add more methods that complement the existing methods det and trace, by delegating to the existing methods of Sage matrices.

This is parallel to what is done for ModulesWithBasis in:

📝 Checklist

  • The title is concise and informative.
  • The description explains in detail what this PR is about.
  • I have linked a relevant issue or discussion.
  • I have created tests covering the changes.
  • I have updated the documentation and checked the documentation preview.

⌛ Dependencies

Copy link

github-actions bot commented Apr 18, 2024

Documentation preview for this PR (built with commit 7cfc187; changes) is ready! 🎉
This preview will update shortly after each push to this PR.

Copy link
Collaborator

@tscrim tscrim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@mkoeppe
Copy link
Member Author

mkoeppe commented Apr 19, 2024

Thanks, Travis!

In a follow-up PR, I'll do the same for endomorphisms.

Copy link
Member

@egourgoulhon egourgoulhon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apart from the minor comments below, LGTM.

src/sage/tensor/modules/free_module_automorphism.py Outdated Show resolved Hide resolved
src/sage/tensor/modules/free_module_automorphism.py Outdated Show resolved Hide resolved
return self._some_matrix().fcp

@lazy_attribute
def minimal_polynomial(self):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't var appear in the argument list?

Suggested change
def minimal_polynomial(self):
def minimal_polynomial(self, var):

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, because this is the implementation of the lazy attribute. When it is invoked, it returns the method of the matrix.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, I see. This is unfortunate regarding the documentation as shown in the reference manual (https://deploy-preview-37826--sagemath.netlify.app/html/en/reference/tensor_free_modules/sage/tensor/modules/free_module_automorphism#sage.tensor.modules.free_module_automorphism.FreeModuleAutomorphism.minimal_polynomial) : the method minimal_polynomial appears as if it takes no argument.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree that this is unfortunate...

return next(iter(self._matrices.values()))

@lazy_attribute
def characteristic_polynomial(self):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't var appear in the argument list?

Suggested change
def characteristic_polynomial(self):
def characteristic_polynomial(self, var):

determinant = det

@lazy_attribute
def fcp(self):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same question as for characteristic_polynomial:

Suggested change
def fcp(self):
def fcp(self, var):

Co-authored-by: Eric Gourgoulhon <eric.gourgoulhon@obspm.fr>
Copy link
Member

@egourgoulhon egourgoulhon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the changes.

return self._some_matrix().fcp

@lazy_attribute
def minimal_polynomial(self):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, I see. This is unfortunate regarding the documentation as shown in the reference manual (https://deploy-preview-37826--sagemath.netlify.app/html/en/reference/tensor_free_modules/sage/tensor/modules/free_module_automorphism#sage.tensor.modules.free_module_automorphism.FreeModuleAutomorphism.minimal_polynomial) : the method minimal_polynomial appears as if it takes no argument.

@mkoeppe
Copy link
Member Author

mkoeppe commented Apr 19, 2024

Thanks!

vbraun pushed a commit to vbraun/sage that referenced this pull request Apr 28, 2024
    
<!-- ^ Please provide a concise and informative title. -->
<!-- ^ Don't put issue numbers in the title, do this in the PR
description below. -->
<!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method
to calculate 1 + 2". -->
<!-- v Describe your changes below in detail. -->
<!-- v Why is this change required? What problem does it solve? -->
<!-- v If this PR resolves an open issue, please link to it here. For
example, "Fixes sagemath#12345". -->

We add more methods that complement the existing methods `det` and
`trace`, by delegating to the existing methods of Sage matrices.

This is parallel to what is done for ModulesWithBasis in:
- sagemath#37731

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->

- [x] The title is concise and informative.
- [x] The description explains in detail what this PR is about.
- [x] I have linked a relevant issue or discussion.
- [x] I have created tests covering the changes.
- [ ] I have updated the documentation and checked the documentation
preview.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on. For example,
-->
<!-- - sagemath#12345: short description why this is a dependency -->
<!-- - sagemath#34567: ... -->
    
URL: sagemath#37826
Reported by: Matthias Köppe
Reviewer(s): Eric Gourgoulhon, Matthias Köppe, Travis Scrimshaw
@vbraun vbraun merged commit 7d0a347 into sagemath:develop May 2, 2024
18 checks passed
@mkoeppe mkoeppe added this to the sage-10.4 milestone May 2, 2024
vbraun pushed a commit to vbraun/sage that referenced this pull request May 4, 2024
…et`, add element methods for invariants `det`, `charpoly`, `fcp`, etc.

    
<!-- ^ Please provide a concise and informative title. -->
<!-- ^ Don't put issue numbers in the title, do this in the PR
description below. -->
<!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method
to calculate 1 + 2". -->
<!-- v Describe your changes below in detail. -->
<!-- v Why is this change required? What problem does it solve? -->
<!-- v If this PR resolves an open issue, please link to it here. For
example, "Fixes sagemath#12345". -->

We create
- a parent subclass `FreeModuleEndset` (of `FreeModuleHomset`)
- an element subclass `FiniteRankFreeModuleEndomorphism` (of
`FiniteRankFreeModuleMorphism`)

for the purpose of providing specific methods of endomorphisms, namely
the endomorphism invariants `det`, `trace`, `charpoly`, etc.

This is parallel to what is done
- for ModulesWithBasis in sagemath#37731
- in sagemath#37826

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->

- [x] The title is concise and informative.
- [x] The description explains in detail what this PR is about.
- [x] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [ ] I have updated the documentation and checked the documentation
preview.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on. For example,
-->
<!-- - sagemath#12345: short description why this is a dependency -->
<!-- - sagemath#34567: ... -->
    
URL: sagemath#37831
Reported by: Matthias Köppe
Reviewer(s): Eric Gourgoulhon, Travis Scrimshaw
vbraun pushed a commit to vbraun/sage that referenced this pull request May 9, 2024
…et`, add element methods for invariants `det`, `charpoly`, `fcp`, etc.

    
<!-- ^ Please provide a concise and informative title. -->
<!-- ^ Don't put issue numbers in the title, do this in the PR
description below. -->
<!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method
to calculate 1 + 2". -->
<!-- v Describe your changes below in detail. -->
<!-- v Why is this change required? What problem does it solve? -->
<!-- v If this PR resolves an open issue, please link to it here. For
example, "Fixes sagemath#12345". -->

We create
- a parent subclass `FreeModuleEndset` (of `FreeModuleHomset`)
- an element subclass `FiniteRankFreeModuleEndomorphism` (of
`FiniteRankFreeModuleMorphism`)

for the purpose of providing specific methods of endomorphisms, namely
the endomorphism invariants `det`, `trace`, `charpoly`, etc.

This is parallel to what is done
- for ModulesWithBasis in sagemath#37731
- in sagemath#37826

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->

- [x] The title is concise and informative.
- [x] The description explains in detail what this PR is about.
- [x] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [ ] I have updated the documentation and checked the documentation
preview.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on. For example,
-->
<!-- - sagemath#12345: short description why this is a dependency -->
<!-- - sagemath#34567: ... -->
    
URL: sagemath#37831
Reported by: Matthias Köppe
Reviewer(s): Eric Gourgoulhon, Travis Scrimshaw
vbraun pushed a commit to vbraun/sage that referenced this pull request May 11, 2024
…et`, add element methods for invariants `det`, `charpoly`, `fcp`, etc.

    
<!-- ^ Please provide a concise and informative title. -->
<!-- ^ Don't put issue numbers in the title, do this in the PR
description below. -->
<!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method
to calculate 1 + 2". -->
<!-- v Describe your changes below in detail. -->
<!-- v Why is this change required? What problem does it solve? -->
<!-- v If this PR resolves an open issue, please link to it here. For
example, "Fixes sagemath#12345". -->

We create
- a parent subclass `FreeModuleEndset` (of `FreeModuleHomset`)
- an element subclass `FiniteRankFreeModuleEndomorphism` (of
`FiniteRankFreeModuleMorphism`)

for the purpose of providing specific methods of endomorphisms, namely
the endomorphism invariants `det`, `trace`, `charpoly`, etc.

This is parallel to what is done
- for ModulesWithBasis in sagemath#37731
- in sagemath#37826

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->

- [x] The title is concise and informative.
- [x] The description explains in detail what this PR is about.
- [x] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [ ] I have updated the documentation and checked the documentation
preview.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on. For example,
-->
<!-- - sagemath#12345: short description why this is a dependency -->
<!-- - sagemath#34567: ... -->
    
URL: sagemath#37831
Reported by: Matthias Köppe
Reviewer(s): Eric Gourgoulhon, Travis Scrimshaw
vbraun pushed a commit to vbraun/sage that referenced this pull request May 12, 2024
…et`, add element methods for invariants `det`, `charpoly`, `fcp`, etc.

    
<!-- ^ Please provide a concise and informative title. -->
<!-- ^ Don't put issue numbers in the title, do this in the PR
description below. -->
<!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method
to calculate 1 + 2". -->
<!-- v Describe your changes below in detail. -->
<!-- v Why is this change required? What problem does it solve? -->
<!-- v If this PR resolves an open issue, please link to it here. For
example, "Fixes sagemath#12345". -->

We create
- a parent subclass `FreeModuleEndset` (of `FreeModuleHomset`)
- an element subclass `FiniteRankFreeModuleEndomorphism` (of
`FiniteRankFreeModuleMorphism`)

for the purpose of providing specific methods of endomorphisms, namely
the endomorphism invariants `det`, `trace`, `charpoly`, etc.

This is parallel to what is done
- for ModulesWithBasis in sagemath#37731
- in sagemath#37826

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->

- [x] The title is concise and informative.
- [x] The description explains in detail what this PR is about.
- [x] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [ ] I have updated the documentation and checked the documentation
preview.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on. For example,
-->
<!-- - sagemath#12345: short description why this is a dependency -->
<!-- - sagemath#34567: ... -->
    
URL: sagemath#37831
Reported by: Matthias Köppe
Reviewer(s): Eric Gourgoulhon, Travis Scrimshaw
vbraun pushed a commit to vbraun/sage that referenced this pull request May 12, 2024
…et`, add element methods for invariants `det`, `charpoly`, `fcp`, etc.

    
<!-- ^ Please provide a concise and informative title. -->
<!-- ^ Don't put issue numbers in the title, do this in the PR
description below. -->
<!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method
to calculate 1 + 2". -->
<!-- v Describe your changes below in detail. -->
<!-- v Why is this change required? What problem does it solve? -->
<!-- v If this PR resolves an open issue, please link to it here. For
example, "Fixes sagemath#12345". -->

We create
- a parent subclass `FreeModuleEndset` (of `FreeModuleHomset`)
- an element subclass `FiniteRankFreeModuleEndomorphism` (of
`FiniteRankFreeModuleMorphism`)

for the purpose of providing specific methods of endomorphisms, namely
the endomorphism invariants `det`, `trace`, `charpoly`, etc.

This is parallel to what is done
- for ModulesWithBasis in sagemath#37731
- in sagemath#37826

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->

- [x] The title is concise and informative.
- [x] The description explains in detail what this PR is about.
- [x] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [ ] I have updated the documentation and checked the documentation
preview.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on. For example,
-->
<!-- - sagemath#12345: short description why this is a dependency -->
<!-- - sagemath#34567: ... -->
    
URL: sagemath#37831
Reported by: Matthias Köppe
Reviewer(s): Eric Gourgoulhon, Travis Scrimshaw
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants