Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Add overset and underset support for mathtext #18916

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

Merged
merged 3 commits into from
Jan 18, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
66 changes: 66 additions & 0 deletions lib/matplotlib/_mathtext.py
Original file line number Diff line number Diff line change
Expand Up @@ -2035,6 +2035,7 @@ def __init__(self):
p.non_math = Forward()
p.operatorname = Forward()
p.overline = Forward()
p.overset = Forward()
p.placeable = Forward()
p.rbrace = Forward()
p.rbracket = Forward()
Expand All @@ -2053,6 +2054,7 @@ def __init__(self):
p.symbol = Forward()
p.symbol_name = Forward()
p.token = Forward()
p.underset = Forward()
p.unknown_symbol = Forward()

# Set names on everything -- very useful for debugging
Expand Down Expand Up @@ -2169,6 +2171,18 @@ def __init__(self):
- (p.required_group | Error("Expected \\overline{value}"))
)

p.overset <<= Group(
Suppress(Literal(r"\overset"))
- ((p.simple_group + p.simple_group)
| Error("Expected \\overset{body}{annotation}"))
)

p.underset <<= Group(
Suppress(Literal(r"\underset"))
- ((p.simple_group + p.simple_group)
| Error("Expected \\underset{body}{annotation}"))
)

p.unknown_symbol <<= Combine(p.bslash + Regex("[A-Za-z]*"))

p.operatorname <<= Group(
Expand All @@ -2190,6 +2204,8 @@ def __init__(self):
| p.dfrac
| p.binom
| p.genfrac
| p.overset
| p.underset
| p.sqrt
| p.overline
| p.operatorname
Expand Down Expand Up @@ -2842,6 +2858,38 @@ def binom(self, s, loc, toks):
return self._genfrac('(', ')', 0.0, self._MathStyle.TEXTSTYLE,
num, den)

def _genset(self, state, body, annotation, overunder):
thickness = state.font_output.get_underline_thickness(
state.font, state.fontsize, state.dpi)

body.shrink()

cbody = HCentered([body])
cannotation = HCentered([annotation])
width = max(cbody.width, cannotation.width)
cbody.hpack(width, 'exactly')
cannotation.hpack(width, 'exactly')

vgap = thickness * 3
if overunder == "under":
vlist = Vlist([cannotation, # annotation
Vbox(0, vgap), # space
cbody # body
])
# Shift so the annotation sits in the same vertical position
shift_amount = cannotation.depth + cbody.height + vgap

vlist.shift_amount = shift_amount
else:
vlist = Vlist([cbody, # body
Vbox(0, vgap), # space
cannotation # annotation
])

# To add horizontal gap between symbols: wrap the Vlist into
# an Hlist and extend it with an Hbox(0, horizontal_gap)
return vlist

def sqrt(self, s, loc, toks):
(root, body), = toks
state = self.get_state()
Expand Down Expand Up @@ -2902,6 +2950,24 @@ def overline(self, s, loc, toks):
hlist = Hlist([rightside])
return [hlist]

def overset(self, s, loc, toks):
assert len(toks) == 1
assert len(toks[0]) == 2

state = self.get_state()
body, annotation = toks[0]

return self._genset(state, body, annotation, overunder="over")

def underset(self, s, loc, toks):
assert len(toks) == 1
assert len(toks[0]) == 2

state = self.get_state()
body, annotation = toks[0]

return self._genset(state, body, annotation, overunder="under")

def _auto_sized_delimiter(self, front, middle, back):
state = self.get_state()
if len(middle):
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions lib/matplotlib/tests/test_mathtext.py
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,7 @@
# images.
lightweight_math_tests = [
r'$\sqrt[ab]{123}$', # github issue #8665
r'$x \overset{f}{\rightarrow} \overset{f}{x} \underset{xx}{ff} \overset{xx}{ff} \underset{f}{x} \underset{f}{\leftarrow} x$', # github issue #18241
]

digits = "0123456789"
Expand Down Expand Up @@ -246,6 +247,8 @@ def test_fontinfo():
(r'$\left($', r'Expected "\right"'),
(r'$\dfrac$', r'Expected \dfrac{num}{den}'),
(r'$\dfrac{}{}$', r'Expected \dfrac{num}{den}'),
(r'$\overset$', r'Expected \overset{body}{annotation}'),
(r'$\underset$', r'Expected \underset{body}{annotation}'),
],
ids=[
'hspace without value',
Expand All @@ -266,6 +269,8 @@ def test_fontinfo():
'unclosed parentheses without sizing',
'dfrac without parameters',
'dfrac with empty parameters',
'overset without parameters',
'underset without parameters',
]
)
def test_mathtext_exceptions(math, msg):
Expand Down