Make the writing of the factorisations in linalg more uniform #220
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added properties of the returned matrices in the main description and the return section Uniform: Always say "(or a stack of matrices)" rather than repeating the properties of the matrices. E.g. Do not write "a square matrix (or a stack of square matrices)" but simply "a square matrix (or stack of matrices)" Uniform: Prefer "Returns" over "Computes" at the start of every description. Uniform: Prefer "decomposition" over "factorization"
asmeurer
reviewed
Jul 9, 2021
asmeurer
reviewed
Jul 9, 2021
kgryte
reviewed
Nov 1, 2021
kgryte
reviewed
Nov 1, 2021
kgryte
reviewed
Nov 1, 2021
The presentation of equations will be fixed in a follow-up PR including TeX rendering support.
kgryte
reviewed
Nov 1, 2021
kgryte
reviewed
Nov 1, 2021
kgryte
reviewed
Nov 1, 2021
kgryte
reviewed
Nov 1, 2021
kgryte
reviewed
Nov 1, 2021
kgryte
reviewed
Nov 1, 2021
kgryte
reviewed
Nov 1, 2021
kgryte
reviewed
Nov 1, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #209
I also took the liberty to make the descriptions of the factorisations more uniform.
Happy to change any of them if the reviewers believe that a different option is better.
Added explicit formulae for the factorisations in the main description
Added properties (triangular, orthogonal, etc) of the returned matrices in the main description and
the return section
Uniform language: Prefer "Returns" over "Computes" at the start of every
description.
Uniform language: Prefer "decomposition" over "factorization"
cc @rgommers @asmeurer