Fixed LaTeX- and pretty-printing of Determinant #22773

oscargus · 2021-12-31T12:47:30Z

References to other Issues or PRs

Closes #22763

Brief description of what is fixed or changed

Corrected LaTeX-printing of Determinant.

Other comments

I seem to recall that there was some discussion about this elsewhere, but cannot really recall where...

Release Notes

printing
- Corrected LaTeX- and pretty-printing of Adjoint, Determinant, Inverse, and Transpose.

sympy-bot · 2021-12-31T12:47:32Z

✅

Hi, I am the SymPy bot (v163). I'm here to help you write a release notes entry. Please read the guide on how to write release notes.

Your release notes are in good order.

Here is what the release notes will look like:

printing
- Corrected LaTeX- and pretty-printing of Adjoint, Determinant, Inverse, and Transpose. (#22773 by @dispasha and @oscargus)

This will be added to https://github.com/sympy/sympy/wiki/Release-Notes-for-1.11.

Click here to see the pull request description that was parsed.

<!-- Your title above should be a short description of what
was changed. Do not include the issue number in the title. -->

#### References to other Issues or PRs
<!-- If this pull request fixes an issue, write "Fixes #NNNN" in that exact
format, e.g. "Fixes #1234" (see
https://tinyurl.com/auto-closing for more information). Also, please
write a comment on that issue linking back to this pull request once it is
open. -->

Closes #22763

#### Brief description of what is fixed or changed

Corrected LaTeX-printing of Determinant.

#### Other comments

I seem to recall that there was some discussion about this elsewhere, but cannot really recall where...

#### Release Notes

<!-- Write the release notes for this release below between the BEGIN and END
statements. The basic format is a bulleted list with the name of the subpackage
and the release note for this PR. For example:

* solvers
  * Added a new solver for logarithmic equations.

* functions
  * Fixed a bug with log of integers.

or if no release note(s) should be included use:

NO ENTRY

See https://github.com/sympy/sympy/wiki/Writing-Release-Notes for more
information on how to write release notes. The bot will check your release
notes automatically to see if they are formatted correctly. -->

<!-- BEGIN RELEASE NOTES -->
* printing
   * Corrected LaTeX- and pretty-printing of Adjoint, Determinant, Inverse, and Transpose. 
<!-- END RELEASE NOTES -->

Update

The release notes on the wiki have been updated.

oscargus · 2021-12-31T13:13:39Z

There are things that must be fixed here...

oscargus · 2021-12-31T13:55:59Z

Now it should be working correctly. I noted that this happens:

In [23]: Inverse(m)
Out[23]: 
        -1
⎛⎡1  2⎤⎞  
⎜⎢    ⎥⎟  
⎝⎣3  4⎦⎠

so an extra parenthesis for Inverse. This is fixed here so that it is printed as

      -1
⎡1  2⎤  
⎢    ⎥  
⎣3  4⎦

(similar for LaTeX) and should be fixed similarly for Adjoint and Transpose (at least), but since #22772 changes them, it will have to wait.

github-actions · 2021-12-31T14:02:17Z

Benchmark results from GitHub Actions

Lower numbers are good, higher numbers are bad. A ratio less than 1
means a speed up and greater than 1 means a slowdown. Green lines
beginning with + are slowdowns (the PR is slower then master or
master is slower than the previous release). Red lines beginning
with - are speedups.

Significantly changed benchmark results (PR vs master)

Significantly changed benchmark results (master vs previous release)

Full benchmark results can be found as artifacts in GitHub Actions
(click on checks at the top of the PR).

smichr · 2021-12-31T18:44:27Z

Is this ready if #22772 is in?

oscargus · 2021-12-31T18:46:16Z

Is this ready if #22772 is in?

I think/hope so. As far as I know, the combination should not break anything. (If it does, I'll update the tests ASAP.)

asmeurer · 2021-12-31T22:58:00Z

sympy/printing/latex.py

+        else:
+            mat_delim_backup = self._settings['mat_delim']
+            self._settings['mat_delim'] = ''
+            tex = r"\left|{%s}\right|" % self._print(expr.args[0])


I think you mentioned this on the issue, but why not just set the delimiter to | and recursively print expr.args[0]? The result would be the same but would be less convoluted.

Main reason is that it was like that in the code.

The corresponding code would be:

self._settings['mat_delim'] = '|' tex = self._print(expr.args[0])

and changing

self._delim_dict = {'(': ')', '[': ']'}

to

self._delim_dict = {'(': ')', '[': ']', '|': '|'}

so to me it seemed about the same.

But I can definitely change it. One should probably check how block matrices print though... Things like

X = MatrixSymbol('X', 2, 2) m = Matrix(((1, 2), (3, 4))) BlockMatrix(((OneMatrix(2, 2), X), (m, ZeroMatrix(2, 2))))

Will probably not print in a sensible way independent of solution...

(Right now:

⎡ 𝟙 X⎤ ⎢ ⎥ ⎢⎡1 2⎤ ⎥ ⎢⎢ ⎥ 𝟘⎥ ⎣⎣3 4⎦ ⎦

)

asmeurer · 2021-12-31T23:02:05Z

sympy/printing/latex.py

+            tex = r"\left|{%s}\right|" % self._print(expr.args[0])
+            self._settings['mat_delim'] = mat_delim_backup
+        if exp is not None:
+            return r"%s^{%s}" % (tex, exp)


The Pow printer only uses the exp argument if the argument is a Function. Maybe this could be generalized to allow other classes, although in this case, do we really want powers of determinants to print like |A|^2? A test you added below seems to indicate not. Personally I'd say we should not print determinant powers like that because it makes it unclear if an expression is actually Determinant(MatPow) or Pow(Determinant).

The plan was that it should be printed as |A|^2, yes. And the other way around as |A^2| (or |(A)^2| if A is a Matrix rather than a MatrixSymbol).

Probably adding the exp-argument was a bit too much copy and paste...

oscargus · 2022-04-03T12:52:58Z

This is now refactored to not fiddle with the settings and handle block matrices in a much better way now.

oscargus added printing printing.latex labels Dec 31, 2021

oscargus force-pushed the latexdeterminant branch from 92deba4 to bdbb2ff Compare December 31, 2021 13:56

oscargus changed the title ~~Fixed LaTeX-printing of Determinant~~ Fixed LaTeX- and pretty-printing of Determinant Dec 31, 2021

asmeurer reviewed Dec 31, 2021

View reviewed changes

oscargus marked this pull request as draft January 1, 2022 21:30

dispasha and others added 2 commits April 3, 2022 12:41

Fixed LaTeX-printing of Determinant

96820f8

Added tests

dffb1f6

oscargus force-pushed the latexdeterminant branch 10 times, most recently from 1431de1 to c87299c Compare April 3, 2022 12:42

oscargus marked this pull request as ready for review April 3, 2022 12:52

Added pretty printing and fixed issue with earlier version

ab126b2

oscargus force-pushed the latexdeterminant branch from c87299c to ab126b2 Compare April 3, 2022 13:12

oscargus added the Needs Review label Apr 23, 2022

oscargus merged commit c8ca7fa into sympy:master Apr 25, 2022

oscargus deleted the latexdeterminant branch April 25, 2022 10:50

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Fixed LaTeX- and pretty-printing of Determinant #22773

Fixed LaTeX- and pretty-printing of Determinant #22773

Uh oh!

oscargus commented Dec 31, 2021 •

edited

Loading

Uh oh!

sympy-bot commented Dec 31, 2021 •

edited

Loading

Uh oh!

oscargus commented Dec 31, 2021

Uh oh!

oscargus commented Dec 31, 2021

Uh oh!

github-actions bot commented Dec 31, 2021 •

edited

Loading

Uh oh!

smichr commented Dec 31, 2021

Uh oh!

oscargus commented Dec 31, 2021

Uh oh!

asmeurer Dec 31, 2021

Uh oh!

oscargus Jan 1, 2022

Uh oh!

asmeurer Dec 31, 2021

Uh oh!

oscargus Jan 1, 2022 •

edited

Loading

Uh oh!

oscargus commented Apr 3, 2022

Uh oh!

Uh oh!

Uh oh!

Fixed LaTeX- and pretty-printing of Determinant #22773

Fixed LaTeX- and pretty-printing of Determinant #22773

Uh oh!

Conversation

oscargus commented Dec 31, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

References to other Issues or PRs

Brief description of what is fixed or changed

Other comments

Release Notes

Uh oh!

sympy-bot commented Dec 31, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

oscargus commented Dec 31, 2021

Uh oh!

oscargus commented Dec 31, 2021

Uh oh!

github-actions bot commented Dec 31, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

smichr commented Dec 31, 2021

Uh oh!

oscargus commented Dec 31, 2021

Uh oh!

asmeurer Dec 31, 2021

Choose a reason for hiding this comment

Uh oh!

oscargus Jan 1, 2022

Choose a reason for hiding this comment

Uh oh!

asmeurer Dec 31, 2021

Choose a reason for hiding this comment

Uh oh!

oscargus Jan 1, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

oscargus commented Apr 3, 2022

Uh oh!

Uh oh!

oscargus commented Dec 31, 2021 •

edited

Loading

sympy-bot commented Dec 31, 2021 •

edited

Loading

github-actions bot commented Dec 31, 2021 •

edited

Loading

oscargus Jan 1, 2022 •

edited

Loading