Corrected the output of latex method in latex.py to return valid latex command #15151

ayushmankoul · 2018-08-26T17:19:04Z

References to other Issues or PRs

Brief description of what is fixed or changed

The problem was that latex function wasn't printing valid Latex commands for Indexed results.In order to overcome this issue we altered the code to wrap the indexedbase in {} so that printer would print valid latex command.

Example:-

Before Correction in code.
Output:-x_{1}_{i} which was not a valid latex command.
After correction in code.
Output:-{x_{1}}_{i} which is valid latex command.

Other comments

Release Notes

printing
- fix latex printing of Indexed results not pretty printing indexed(x1, i) #15059

…x commands. Example:- ln[1]:-from sympy import* ln[2]:-from sympy import init_printing;init_printing() ln[3]:-i=symbols('i') ln[4]:-print(latex(Indexed('x1',i)) Before Correction in code. Output:-x_{1}_{i} which was not a valid latex command. After correction in code. Output:- {x_{1}}_{i} which is valid latex command.

sympy-bot · 2018-08-26T17:19:04Z

✅

Hi, I am the SymPy bot (v129). 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
- fix latex printing of Indexed results not pretty printing indexed(x1, i) #15059 (#15151 by @ayushmankoul)

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

Note: This comment will be updated with the latest check if you edit the pull request. You need to reload the page to see it.

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://github.com/blog/1506-closing-issues-via-pull-requests .-->
Fixes #15059
#### Brief description of what is fixed or changed
The problem was that latex function wasn't printing valid Latex commands for Indexed results.In order to overcome this issue we altered the code to wrap the indexedbase in {} so that printer would print valid latex command.
Example:-
![43878942-9caaee84-9b6f-11e8-9f49-44800d684ceb](https://user-images.githubusercontent.com/22992482/44660055-00935400-aa24-11e8-8702-2a279d87f4e2.png)
```
Before Correction in code.
Output:-x_{1}_{i} which was not a valid latex command.
After correction in code.
Output:-{x_{1}}_{i} which is valid latex command.
```
#### Other comments
#### Release Notes
<!-- Write the release notes for this release below. See
https://github.com/sympy/sympy/wiki/Writing-Release-Notes for more information
on how to write release notes. If there is no release notes entry for this PR,
write "NO ENTRY". The bot will check your release notes automatically to see
if they are formatted correctly. -->
<!-- BEGIN RELEASE NOTES -->
* printing
    * fix latex printing of Indexed results #15059
<!-- END RELEASE NOTES -->

Update

The release notes on the wiki have been updated.

jksuom · 2018-08-26T17:28:25Z

sympy/printing/tests/test_latex.py

-        or symbol_latex.split() == indexed_latex.split()[::-1]
+    # \\overline{{\\Psi}_{0}} {\\Psi}_{0}   vs.   \\Psi_{0} \\overline{\\Psi_{0}}
+    assert symbol_latex=='\\Psi_{0} \\overline{\\Psi_{0}}' \
+        or indexed_latex=='\\overline{{\\Psi}_{0}} {\\Psi}_{0}'


This should be another assert (no or).

jksuom · 2018-08-26T17:29:39Z

sympy/printing/latex.py

-        tex = self._print(expr.base)+'_{%s}' % ','.join(
+        tex_base = self._print(expr.base)
+        tex_base = '{'+tex_base+'}'
+        tex = tex_base+'_{%s}' % ','.join(


Braces could be added on this line. No need for the one above.

jksuom · 2018-08-26T18:00:03Z

sympy/printing/tests/test_latex.py

@@ -524,7 +524,7 @@ def test_latex_indexed():
    indexed_latex = latex(Psi_indexed[0] * conjugate(Psi_indexed[0]))
    # \\overline{{\\Psi}_{0}} {\\Psi}_{0}   vs.   \\Psi_{0} \\overline{\\Psi_{0}}
    assert symbol_latex=='\\Psi_{0} \\overline{\\Psi_{0}}' \
-        or indexed_latex=='\\overline{{\\Psi}_{0}} {\\Psi}_{0}'
+        and indexed_latex=='\\overline{{\\Psi}_{0}} {\\Psi}_{0}'


This should not be a continuation line with and but assert indexed_latex == .... The results are now different and each one should have its own test line.

sidhantnagpal · 2018-08-27T10:39:16Z

sympy/printing/tests/test_latex.py

-        or symbol_latex.split() == indexed_latex.split()[::-1]
+    # \\overline{{\\Psi}_{0}} {\\Psi}_{0}   vs.   \\Psi_{0} \\overline{\\Psi_{0}}
+    assert symbol_latex=='\\Psi_{0} \\overline{\\Psi_{0}}'
+    assert indexed_latex=='\\overline{{\\Psi}_{0}} {\\Psi}_{0}'


SymPy uses spaces around ==.

Also, it would be good to have meaningful commit messages.

jksuom · 2018-08-27T12:19:23Z

test_issue_15059() with the original example should also be added.

ayushmankoul · 2018-08-27T16:17:50Z

Thank You @jksuom for pointing out my mistakes and helping me to fix it.I have made the necessary changes as advised by you and other contributors.Is the description of pull request fine now or should I also add the expected output of @majidaldo inside the description ? I am new to open source contributions and I am trying to contribute to organisation as much I can.

jksuom · 2018-08-27T16:30:17Z

Please add a test for latex(Indexed('x1', Symbol('i'))).

jksuom · 2018-08-27T18:30:12Z

sympy/printing/tests/test_latex.py

@@ -1,6 +1,6 @@
 from sympy import (
    Add, Abs, Chi, Ci, CosineTransform, Dict, Ei, Eq, FallingFactorial,
-    FiniteSet, Float, FourierTransform, Function, IndexedBase, Integral,
+    FiniteSet, Float, FourierTransform, Function,Indexed, IndexedBase, Integral,


Please add a space after comma.

@jksuom Sure sir I have updated the code as asked by you.

jksuom · 2018-08-28T17:31:06Z

This looks good. Thank you for your contribution.

jksuom reviewed Aug 26, 2018

View reviewed changes

ayushmankoul added 2 commits August 26, 2018 23:08

Update test_latex.py

6f85e0f

Update latex.py

96b1047

jksuom reviewed Aug 26, 2018

View reviewed changes

ayushmankoul added 2 commits August 27, 2018 00:14

Update test_latex.py

3b0ae12

Update test_latex.py

ff7f47f

sidhantnagpal reviewed Aug 27, 2018

View reviewed changes

Update test_latex.py

daf9cff

ayushmankoul changed the title ~~Corrected the output of latex method in latex.py to return valid late…~~ Corrected the output of latex method in latex.py to return valid latex command Aug 27, 2018

Update test_latex.py

a42bda9

jksuom reviewed Aug 27, 2018

View reviewed changes

Update test_latex.py

1eb612e

jksuom merged commit 576180d into sympy:master Aug 28, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Corrected the output of latex method in latex.py to return valid latex command #15151

Corrected the output of latex method in latex.py to return valid latex command #15151

Uh oh!

ayushmankoul commented Aug 26, 2018 •

edited

Loading

Uh oh!

sympy-bot commented Aug 26, 2018 •

edited

Loading

Uh oh!

jksuom Aug 26, 2018

Uh oh!

jksuom Aug 26, 2018

Uh oh!

jksuom Aug 26, 2018

Uh oh!

sidhantnagpal Aug 27, 2018

Uh oh!

jksuom commented Aug 27, 2018

Uh oh!

ayushmankoul commented Aug 27, 2018 •

edited

Loading

Uh oh!

jksuom commented Aug 27, 2018

Uh oh!

jksuom Aug 27, 2018

Uh oh!

ayushmankoul Aug 28, 2018

Uh oh!

jksuom commented Aug 28, 2018

Uh oh!

Uh oh!

Uh oh!

Corrected the output of latex method in latex.py to return valid latex command #15151

Corrected the output of latex method in latex.py to return valid latex command #15151

Uh oh!

Conversation

ayushmankoul commented Aug 26, 2018 • 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 Aug 26, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jksuom Aug 26, 2018

Choose a reason for hiding this comment

Uh oh!

jksuom Aug 26, 2018

Choose a reason for hiding this comment

Uh oh!

jksuom Aug 26, 2018

Choose a reason for hiding this comment

Uh oh!

sidhantnagpal Aug 27, 2018

Choose a reason for hiding this comment

Uh oh!

jksuom commented Aug 27, 2018

Uh oh!

ayushmankoul commented Aug 27, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jksuom commented Aug 27, 2018

Uh oh!

jksuom Aug 27, 2018

Choose a reason for hiding this comment

Uh oh!

ayushmankoul Aug 28, 2018

Choose a reason for hiding this comment

Uh oh!

jksuom commented Aug 28, 2018

Uh oh!

Uh oh!

ayushmankoul commented Aug 26, 2018 •

edited

Loading

sympy-bot commented Aug 26, 2018 •

edited

Loading

ayushmankoul commented Aug 27, 2018 •

edited

Loading