Skip to content

IPython LaTeX output only generated for small systems #607

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Apr 12, 2021
Merged

IPython LaTeX output only generated for small systems #607

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions control/statesp.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@
'statesp.remove_useless_states': False,
'statesp.latex_num_format': '.3g',
'statesp.latex_repr_type': 'partitioned',
'statesp.latex_maxsize': 10,
}


Expand Down Expand Up @@ -517,19 +518,26 @@ def fmt_matrix(matrix, name):
def _repr_latex_(self):
"""LaTeX representation of state-space model

Output is controlled by config options statesp.latex_repr_type
and statesp.latex_num_format.
Output is controlled by config options statesp.latex_repr_type,
statesp.latex_num_format, and statesp.latex_maxsize.

The output is primarily intended for Jupyter notebooks, which
use MathJax to render the LaTeX, and the results may look odd
when processed by a 'conventional' LaTeX system.


Returns
-------
s : string with LaTeX representation of model

s : string with LaTeX representation of model, or None if
either matrix dimension is greater than
statesp.latex_maxsize

"""
if config.defaults['statesp.latex_repr_type'] == 'partitioned':
syssize = self.nstates + max(self.noutputs, self.ninputs)
if syssize > config.defaults['statesp.latex_maxsize']:
return None
elif config.defaults['statesp.latex_repr_type'] == 'partitioned':
return self._latex_partitioned()
elif config.defaults['statesp.latex_repr_type'] == 'separate':
return self._latex_separate()
Expand Down
26 changes: 26 additions & 0 deletions control/tests/statesp_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1063,3 +1063,29 @@ def test_xferfcn_ndarray_precedence(op, tf, arr):
ss = ct.tf2ss(tf)
result = op(arr, ss)
assert isinstance(result, ct.StateSpace)


def test_latex_repr_testsize(editsdefaults):
# _repr_latex_ returns None when size > maxsize
from control import set_defaults

maxsize = defaults['statesp.latex_maxsize']
nstates = maxsize // 2
ninputs = maxsize - nstates
noutputs = ninputs

assert nstates > 0
assert ninputs > 0

g = rss(nstates, ninputs, noutputs)
assert isinstance(g._repr_latex_(), str)

set_defaults('statesp', latex_maxsize=maxsize - 1)
assert g._repr_latex_() is None

set_defaults('statesp', latex_maxsize=-1)
assert g._repr_latex_() is None

gstatic = ss([], [], [], 1)
assert gstatic._repr_latex_() is None