latex.py 121 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318
  1. """
  2. A Printer which converts an expression into its LaTeX equivalent.
  3. """
  4. from __future__ import annotations
  5. from typing import Any, Callable, TYPE_CHECKING
  6. import itertools
  7. from sympy.core import Add, Float, Mod, Mul, Number, S, Symbol, Expr
  8. from sympy.core.alphabets import greeks
  9. from sympy.core.containers import Tuple
  10. from sympy.core.function import Function, AppliedUndef, Derivative
  11. from sympy.core.operations import AssocOp
  12. from sympy.core.power import Pow
  13. from sympy.core.sorting import default_sort_key
  14. from sympy.core.sympify import SympifyError
  15. from sympy.logic.boolalg import true, BooleanTrue, BooleanFalse
  16. # sympy.printing imports
  17. from sympy.printing.precedence import precedence_traditional
  18. from sympy.printing.printer import Printer, print_function
  19. from sympy.printing.conventions import split_super_sub, requires_partial
  20. from sympy.printing.precedence import precedence, PRECEDENCE
  21. from mpmath.libmp.libmpf import prec_to_dps, to_str as mlib_to_str
  22. from sympy.utilities.iterables import has_variety, sift
  23. import re
  24. if TYPE_CHECKING:
  25. from sympy.tensor.array import NDimArray
  26. from sympy.vector.basisdependent import BasisDependent
  27. # Hand-picked functions which can be used directly in both LaTeX and MathJax
  28. # Complete list at
  29. # https://docs.mathjax.org/en/latest/tex.html#supported-latex-commands
  30. # This variable only contains those functions which SymPy uses.
  31. accepted_latex_functions = ['arcsin', 'arccos', 'arctan', 'sin', 'cos', 'tan',
  32. 'sinh', 'cosh', 'tanh', 'sqrt', 'ln', 'log', 'sec',
  33. 'csc', 'cot', 'coth', 're', 'im', 'frac', 'root',
  34. 'arg',
  35. ]
  36. tex_greek_dictionary = {
  37. 'Alpha': r'\mathrm{A}',
  38. 'Beta': r'\mathrm{B}',
  39. 'Gamma': r'\Gamma',
  40. 'Delta': r'\Delta',
  41. 'Epsilon': r'\mathrm{E}',
  42. 'Zeta': r'\mathrm{Z}',
  43. 'Eta': r'\mathrm{H}',
  44. 'Theta': r'\Theta',
  45. 'Iota': r'\mathrm{I}',
  46. 'Kappa': r'\mathrm{K}',
  47. 'Lambda': r'\Lambda',
  48. 'Mu': r'\mathrm{M}',
  49. 'Nu': r'\mathrm{N}',
  50. 'Xi': r'\Xi',
  51. 'omicron': 'o',
  52. 'Omicron': r'\mathrm{O}',
  53. 'Pi': r'\Pi',
  54. 'Rho': r'\mathrm{P}',
  55. 'Sigma': r'\Sigma',
  56. 'Tau': r'\mathrm{T}',
  57. 'Upsilon': r'\Upsilon',
  58. 'Phi': r'\Phi',
  59. 'Chi': r'\mathrm{X}',
  60. 'Psi': r'\Psi',
  61. 'Omega': r'\Omega',
  62. 'lamda': r'\lambda',
  63. 'Lamda': r'\Lambda',
  64. 'khi': r'\chi',
  65. 'Khi': r'\mathrm{X}',
  66. 'varepsilon': r'\varepsilon',
  67. 'varkappa': r'\varkappa',
  68. 'varphi': r'\varphi',
  69. 'varpi': r'\varpi',
  70. 'varrho': r'\varrho',
  71. 'varsigma': r'\varsigma',
  72. 'vartheta': r'\vartheta',
  73. }
  74. other_symbols = {'aleph', 'beth', 'daleth', 'gimel', 'ell', 'eth', 'hbar',
  75. 'hslash', 'mho', 'wp'}
  76. # Variable name modifiers
  77. modifier_dict: dict[str, Callable[[str], str]] = {
  78. # Accents
  79. 'mathring': lambda s: r'\mathring{'+s+r'}',
  80. 'ddddot': lambda s: r'\ddddot{'+s+r'}',
  81. 'dddot': lambda s: r'\dddot{'+s+r'}',
  82. 'ddot': lambda s: r'\ddot{'+s+r'}',
  83. 'dot': lambda s: r'\dot{'+s+r'}',
  84. 'check': lambda s: r'\check{'+s+r'}',
  85. 'breve': lambda s: r'\breve{'+s+r'}',
  86. 'acute': lambda s: r'\acute{'+s+r'}',
  87. 'grave': lambda s: r'\grave{'+s+r'}',
  88. 'tilde': lambda s: r'\tilde{'+s+r'}',
  89. 'hat': lambda s: r'\hat{'+s+r'}',
  90. 'bar': lambda s: r'\bar{'+s+r'}',
  91. 'vec': lambda s: r'\vec{'+s+r'}',
  92. 'prime': lambda s: "{"+s+"}'",
  93. 'prm': lambda s: "{"+s+"}'",
  94. # Faces
  95. 'bold': lambda s: r'\boldsymbol{'+s+r'}',
  96. 'bm': lambda s: r'\boldsymbol{'+s+r'}',
  97. 'cal': lambda s: r'\mathcal{'+s+r'}',
  98. 'scr': lambda s: r'\mathscr{'+s+r'}',
  99. 'frak': lambda s: r'\mathfrak{'+s+r'}',
  100. # Brackets
  101. 'norm': lambda s: r'\left\|{'+s+r'}\right\|',
  102. 'avg': lambda s: r'\left\langle{'+s+r'}\right\rangle',
  103. 'abs': lambda s: r'\left|{'+s+r'}\right|',
  104. 'mag': lambda s: r'\left|{'+s+r'}\right|',
  105. }
  106. greek_letters_set = frozenset(greeks)
  107. _between_two_numbers_p = (
  108. re.compile(r'[0-9][} ]*$'), # search
  109. re.compile(r'(\d|\\frac{\d+}{\d+})'), # match
  110. )
  111. def latex_escape(s: str) -> str:
  112. """
  113. Escape a string such that latex interprets it as plaintext.
  114. We cannot use verbatim easily with mathjax, so escaping is easier.
  115. Rules from https://tex.stackexchange.com/a/34586/41112.
  116. """
  117. s = s.replace('\\', r'\textbackslash')
  118. for c in '&%$#_{}':
  119. s = s.replace(c, '\\' + c)
  120. s = s.replace('~', r'\textasciitilde')
  121. s = s.replace('^', r'\textasciicircum')
  122. return s
  123. class LatexPrinter(Printer):
  124. printmethod = "_latex"
  125. _default_settings: dict[str, Any] = {
  126. "full_prec": False,
  127. "fold_frac_powers": False,
  128. "fold_func_brackets": False,
  129. "fold_short_frac": None,
  130. "inv_trig_style": "abbreviated",
  131. "itex": False,
  132. "ln_notation": False,
  133. "long_frac_ratio": None,
  134. "mat_delim": "[",
  135. "mat_str": None,
  136. "mode": "plain",
  137. "mul_symbol": None,
  138. "order": None,
  139. "symbol_names": {},
  140. "root_notation": True,
  141. "mat_symbol_style": "plain",
  142. "imaginary_unit": "i",
  143. "gothic_re_im": False,
  144. "decimal_separator": "period",
  145. "perm_cyclic": True,
  146. "parenthesize_super": True,
  147. "min": None,
  148. "max": None,
  149. "diff_operator": "d",
  150. "adjoint_style": "dagger",
  151. "disable_split_super_sub": False,
  152. }
  153. def __init__(self, settings=None):
  154. Printer.__init__(self, settings)
  155. if 'mode' in self._settings:
  156. valid_modes = ['inline', 'plain', 'equation',
  157. 'equation*']
  158. if self._settings['mode'] not in valid_modes:
  159. raise ValueError("'mode' must be one of 'inline', 'plain', "
  160. "'equation' or 'equation*'")
  161. if self._settings['fold_short_frac'] is None and \
  162. self._settings['mode'] == 'inline':
  163. self._settings['fold_short_frac'] = True
  164. mul_symbol_table = {
  165. None: r" ",
  166. "ldot": r" \,.\, ",
  167. "dot": r" \cdot ",
  168. "times": r" \times "
  169. }
  170. try:
  171. self._settings['mul_symbol_latex'] = \
  172. mul_symbol_table[self._settings['mul_symbol']]
  173. except KeyError:
  174. self._settings['mul_symbol_latex'] = \
  175. self._settings['mul_symbol']
  176. try:
  177. self._settings['mul_symbol_latex_numbers'] = \
  178. mul_symbol_table[self._settings['mul_symbol'] or 'dot']
  179. except KeyError:
  180. if (self._settings['mul_symbol'].strip() in
  181. ['', ' ', '\\', '\\,', '\\:', '\\;', '\\quad']):
  182. self._settings['mul_symbol_latex_numbers'] = \
  183. mul_symbol_table['dot']
  184. else:
  185. self._settings['mul_symbol_latex_numbers'] = \
  186. self._settings['mul_symbol']
  187. self._delim_dict = {'(': ')', '[': ']'}
  188. imaginary_unit_table = {
  189. None: r"i",
  190. "i": r"i",
  191. "ri": r"\mathrm{i}",
  192. "ti": r"\text{i}",
  193. "j": r"j",
  194. "rj": r"\mathrm{j}",
  195. "tj": r"\text{j}",
  196. }
  197. imag_unit = self._settings['imaginary_unit']
  198. self._settings['imaginary_unit_latex'] = imaginary_unit_table.get(imag_unit, imag_unit)
  199. diff_operator_table = {
  200. None: r"d",
  201. "d": r"d",
  202. "rd": r"\mathrm{d}",
  203. "td": r"\text{d}",
  204. }
  205. diff_operator = self._settings['diff_operator']
  206. self._settings["diff_operator_latex"] = diff_operator_table.get(diff_operator, diff_operator)
  207. def _add_parens(self, s) -> str:
  208. return r"\left({}\right)".format(s)
  209. # TODO: merge this with the above, which requires a lot of test changes
  210. def _add_parens_lspace(self, s) -> str:
  211. return r"\left( {}\right)".format(s)
  212. def parenthesize(self, item, level, is_neg=False, strict=False) -> str:
  213. prec_val = precedence_traditional(item)
  214. if is_neg and strict:
  215. return self._add_parens(self._print(item))
  216. if (prec_val < level) or ((not strict) and prec_val <= level):
  217. return self._add_parens(self._print(item))
  218. else:
  219. return self._print(item)
  220. def parenthesize_super(self, s):
  221. """
  222. Protect superscripts in s
  223. If the parenthesize_super option is set, protect with parentheses, else
  224. wrap in braces.
  225. """
  226. if "^" in s:
  227. if self._settings['parenthesize_super']:
  228. return self._add_parens(s)
  229. else:
  230. return "{{{}}}".format(s)
  231. return s
  232. def doprint(self, expr) -> str:
  233. tex = Printer.doprint(self, expr)
  234. if self._settings['mode'] == 'plain':
  235. return tex
  236. elif self._settings['mode'] == 'inline':
  237. return r"$%s$" % tex
  238. elif self._settings['itex']:
  239. return r"$$%s$$" % tex
  240. else:
  241. env_str = self._settings['mode']
  242. return r"\begin{%s}%s\end{%s}" % (env_str, tex, env_str)
  243. def _needs_brackets(self, expr) -> bool:
  244. """
  245. Returns True if the expression needs to be wrapped in brackets when
  246. printed, False otherwise. For example: a + b => True; a => False;
  247. 10 => False; -10 => True.
  248. """
  249. return not ((expr.is_Integer and expr.is_nonnegative)
  250. or (expr.is_Atom and (expr is not S.NegativeOne
  251. and expr.is_Rational is False)))
  252. def _needs_function_brackets(self, expr) -> bool:
  253. """
  254. Returns True if the expression needs to be wrapped in brackets when
  255. passed as an argument to a function, False otherwise. This is a more
  256. liberal version of _needs_brackets, in that many expressions which need
  257. to be wrapped in brackets when added/subtracted/raised to a power do
  258. not need them when passed to a function. Such an example is a*b.
  259. """
  260. if not self._needs_brackets(expr):
  261. return False
  262. else:
  263. # Muls of the form a*b*c... can be folded
  264. if expr.is_Mul and not self._mul_is_clean(expr):
  265. return True
  266. # Pows which don't need brackets can be folded
  267. elif expr.is_Pow and not self._pow_is_clean(expr):
  268. return True
  269. # Add and Function always need brackets
  270. elif expr.is_Add or expr.is_Function:
  271. return True
  272. else:
  273. return False
  274. def _needs_mul_brackets(self, expr, first=False, last=False) -> bool:
  275. """
  276. Returns True if the expression needs to be wrapped in brackets when
  277. printed as part of a Mul, False otherwise. This is True for Add,
  278. but also for some container objects that would not need brackets
  279. when appearing last in a Mul, e.g. an Integral. ``last=True``
  280. specifies that this expr is the last to appear in a Mul.
  281. ``first=True`` specifies that this expr is the first to appear in
  282. a Mul.
  283. """
  284. from sympy.concrete.products import Product
  285. from sympy.concrete.summations import Sum
  286. from sympy.integrals.integrals import Integral
  287. if expr.is_Mul:
  288. if not first and expr.could_extract_minus_sign():
  289. return True
  290. elif precedence_traditional(expr) < PRECEDENCE["Mul"]:
  291. return True
  292. elif expr.is_Relational:
  293. return True
  294. if expr.is_Piecewise:
  295. return True
  296. if any(expr.has(x) for x in (Mod,)):
  297. return True
  298. if (not last and
  299. any(expr.has(x) for x in (Integral, Product, Sum))):
  300. return True
  301. return False
  302. def _needs_add_brackets(self, expr) -> bool:
  303. """
  304. Returns True if the expression needs to be wrapped in brackets when
  305. printed as part of an Add, False otherwise. This is False for most
  306. things.
  307. """
  308. if expr.is_Relational:
  309. return True
  310. if any(expr.has(x) for x in (Mod,)):
  311. return True
  312. if expr.is_Add:
  313. return True
  314. return False
  315. def _mul_is_clean(self, expr) -> bool:
  316. for arg in expr.args:
  317. if arg.is_Function:
  318. return False
  319. return True
  320. def _pow_is_clean(self, expr) -> bool:
  321. return not self._needs_brackets(expr.base)
  322. def _do_exponent(self, expr: str, exp):
  323. if exp is not None:
  324. return r"\left(%s\right)^{%s}" % (expr, exp)
  325. else:
  326. return expr
  327. def _print_Basic(self, expr):
  328. name = self._deal_with_super_sub(expr.__class__.__name__)
  329. if expr.args:
  330. ls = [self._print(o) for o in expr.args]
  331. s = r"\operatorname{{{}}}\left({}\right)"
  332. return s.format(name, ", ".join(ls))
  333. else:
  334. return r"\text{{{}}}".format(name)
  335. def _print_bool(self, e: bool | BooleanTrue | BooleanFalse):
  336. return r"\text{%s}" % e
  337. _print_BooleanTrue = _print_bool
  338. _print_BooleanFalse = _print_bool
  339. def _print_NoneType(self, e):
  340. return r"\text{%s}" % e
  341. def _print_Add(self, expr, order=None):
  342. terms = self._as_ordered_terms(expr, order=order)
  343. tex = ""
  344. for i, term in enumerate(terms):
  345. if i == 0:
  346. pass
  347. elif term.could_extract_minus_sign():
  348. tex += " - "
  349. term = -term
  350. else:
  351. tex += " + "
  352. term_tex = self._print(term)
  353. if self._needs_add_brackets(term):
  354. term_tex = r"\left(%s\right)" % term_tex
  355. tex += term_tex
  356. return tex
  357. def _print_Cycle(self, expr):
  358. from sympy.combinatorics.permutations import Permutation
  359. if expr.size == 0:
  360. return r"\left( \right)"
  361. expr = Permutation(expr)
  362. expr_perm = expr.cyclic_form
  363. siz = expr.size
  364. if expr.array_form[-1] == siz - 1:
  365. expr_perm = expr_perm + [[siz - 1]]
  366. term_tex = ''
  367. for i in expr_perm:
  368. term_tex += str(i).replace(',', r"\;")
  369. term_tex = term_tex.replace('[', r"\left( ")
  370. term_tex = term_tex.replace(']', r"\right)")
  371. return term_tex
  372. def _print_Permutation(self, expr):
  373. from sympy.combinatorics.permutations import Permutation
  374. from sympy.utilities.exceptions import sympy_deprecation_warning
  375. perm_cyclic = Permutation.print_cyclic
  376. if perm_cyclic is not None:
  377. sympy_deprecation_warning(
  378. f"""
  379. Setting Permutation.print_cyclic is deprecated. Instead use
  380. init_printing(perm_cyclic={perm_cyclic}).
  381. """,
  382. deprecated_since_version="1.6",
  383. active_deprecations_target="deprecated-permutation-print_cyclic",
  384. stacklevel=8,
  385. )
  386. else:
  387. perm_cyclic = self._settings.get("perm_cyclic", True)
  388. if perm_cyclic:
  389. return self._print_Cycle(expr)
  390. if expr.size == 0:
  391. return r"\left( \right)"
  392. lower = [self._print(arg) for arg in expr.array_form]
  393. upper = [self._print(arg) for arg in range(len(lower))]
  394. row1 = " & ".join(upper)
  395. row2 = " & ".join(lower)
  396. mat = r" \\ ".join((row1, row2))
  397. return r"\begin{pmatrix} %s \end{pmatrix}" % mat
  398. def _print_AppliedPermutation(self, expr):
  399. perm, var = expr.args
  400. return r"\sigma_{%s}(%s)" % (self._print(perm), self._print(var))
  401. def _print_Float(self, expr):
  402. # Based off of that in StrPrinter
  403. dps = prec_to_dps(expr._prec)
  404. strip = False if self._settings['full_prec'] else True
  405. low = self._settings["min"] if "min" in self._settings else None
  406. high = self._settings["max"] if "max" in self._settings else None
  407. str_real = mlib_to_str(expr._mpf_, dps, strip_zeros=strip, min_fixed=low, max_fixed=high)
  408. # Must always have a mul symbol (as 2.5 10^{20} just looks odd)
  409. # thus we use the number separator
  410. separator = self._settings['mul_symbol_latex_numbers']
  411. if 'e' in str_real:
  412. (mant, exp) = str_real.split('e')
  413. if exp[0] == '+':
  414. exp = exp[1:]
  415. if self._settings['decimal_separator'] == 'comma':
  416. mant = mant.replace('.','{,}')
  417. return r"%s%s10^{%s}" % (mant, separator, exp)
  418. elif str_real == "+inf":
  419. return r"\infty"
  420. elif str_real == "-inf":
  421. return r"- \infty"
  422. else:
  423. if self._settings['decimal_separator'] == 'comma':
  424. str_real = str_real.replace('.','{,}')
  425. return str_real
  426. def _print_Cross(self, expr):
  427. vec1 = expr._expr1
  428. vec2 = expr._expr2
  429. return r"%s \times %s" % (self.parenthesize(vec1, PRECEDENCE['Mul']),
  430. self.parenthesize(vec2, PRECEDENCE['Mul']))
  431. def _print_Curl(self, expr):
  432. vec = expr._expr
  433. return r"\nabla\times %s" % self.parenthesize(vec, PRECEDENCE['Mul'])
  434. def _print_Divergence(self, expr):
  435. vec = expr._expr
  436. return r"\nabla\cdot %s" % self.parenthesize(vec, PRECEDENCE['Mul'])
  437. def _print_Dot(self, expr):
  438. vec1 = expr._expr1
  439. vec2 = expr._expr2
  440. return r"%s \cdot %s" % (self.parenthesize(vec1, PRECEDENCE['Mul']),
  441. self.parenthesize(vec2, PRECEDENCE['Mul']))
  442. def _print_Gradient(self, expr):
  443. func = expr._expr
  444. return r"\nabla %s" % self.parenthesize(func, PRECEDENCE['Mul'])
  445. def _print_Laplacian(self, expr):
  446. func = expr._expr
  447. return r"\Delta %s" % self.parenthesize(func, PRECEDENCE['Mul'])
  448. def _print_Mul(self, expr: Expr):
  449. from sympy.simplify import fraction
  450. separator: str = self._settings['mul_symbol_latex']
  451. numbersep: str = self._settings['mul_symbol_latex_numbers']
  452. def convert(expr) -> str:
  453. if not expr.is_Mul:
  454. return str(self._print(expr))
  455. else:
  456. if self.order not in ('old', 'none'):
  457. args = expr.as_ordered_factors()
  458. else:
  459. args = list(expr.args)
  460. # If there are quantities or prefixes, append them at the back.
  461. units, nonunits = sift(args, lambda x: (hasattr(x, "_scale_factor") or hasattr(x, "is_physical_constant")) or
  462. (isinstance(x, Pow) and
  463. hasattr(x.base, "is_physical_constant")), binary=True)
  464. prefixes, units = sift(units, lambda x: hasattr(x, "_scale_factor"), binary=True)
  465. return convert_args(nonunits + prefixes + units)
  466. def convert_args(args) -> str:
  467. _tex = last_term_tex = ""
  468. for i, term in enumerate(args):
  469. term_tex = self._print(term)
  470. if not (hasattr(term, "_scale_factor") or hasattr(term, "is_physical_constant")):
  471. if self._needs_mul_brackets(term, first=(i == 0),
  472. last=(i == len(args) - 1)):
  473. term_tex = r"\left(%s\right)" % term_tex
  474. if _between_two_numbers_p[0].search(last_term_tex) and \
  475. _between_two_numbers_p[1].match(term_tex):
  476. # between two numbers
  477. _tex += numbersep
  478. elif _tex:
  479. _tex += separator
  480. elif _tex:
  481. _tex += separator
  482. _tex += term_tex
  483. last_term_tex = term_tex
  484. return _tex
  485. # Check for unevaluated Mul. In this case we need to make sure the
  486. # identities are visible, multiple Rational factors are not combined
  487. # etc so we display in a straight-forward form that fully preserves all
  488. # args and their order.
  489. # XXX: _print_Pow calls this routine with instances of Pow...
  490. if isinstance(expr, Mul):
  491. args = expr.args
  492. if args[0] is S.One or any(isinstance(arg, Number) for arg in args[1:]):
  493. return convert_args(args)
  494. include_parens = False
  495. if expr.could_extract_minus_sign():
  496. expr = -expr
  497. tex = "- "
  498. if expr.is_Add:
  499. tex += "("
  500. include_parens = True
  501. else:
  502. tex = ""
  503. numer, denom = fraction(expr, exact=True)
  504. if denom is S.One and Pow(1, -1, evaluate=False) not in expr.args:
  505. # use the original expression here, since fraction() may have
  506. # altered it when producing numer and denom
  507. tex += convert(expr)
  508. else:
  509. snumer = convert(numer)
  510. sdenom = convert(denom)
  511. ldenom = len(sdenom.split())
  512. ratio = self._settings['long_frac_ratio']
  513. if self._settings['fold_short_frac'] and ldenom <= 2 and \
  514. "^" not in sdenom:
  515. # handle short fractions
  516. if self._needs_mul_brackets(numer, last=False):
  517. tex += r"\left(%s\right) / %s" % (snumer, sdenom)
  518. else:
  519. tex += r"%s / %s" % (snumer, sdenom)
  520. elif ratio is not None and \
  521. len(snumer.split()) > ratio*ldenom:
  522. # handle long fractions
  523. if self._needs_mul_brackets(numer, last=True):
  524. tex += r"\frac{1}{%s}%s\left(%s\right)" \
  525. % (sdenom, separator, snumer)
  526. elif numer.is_Mul:
  527. # split a long numerator
  528. a = S.One
  529. b = S.One
  530. for x in numer.args:
  531. if self._needs_mul_brackets(x, last=False) or \
  532. len(convert(a*x).split()) > ratio*ldenom or \
  533. (b.is_commutative is x.is_commutative is False):
  534. b *= x
  535. else:
  536. a *= x
  537. if self._needs_mul_brackets(b, last=True):
  538. tex += r"\frac{%s}{%s}%s\left(%s\right)" \
  539. % (convert(a), sdenom, separator, convert(b))
  540. else:
  541. tex += r"\frac{%s}{%s}%s%s" \
  542. % (convert(a), sdenom, separator, convert(b))
  543. else:
  544. tex += r"\frac{1}{%s}%s%s" % (sdenom, separator, snumer)
  545. else:
  546. tex += r"\frac{%s}{%s}" % (snumer, sdenom)
  547. if include_parens:
  548. tex += ")"
  549. return tex
  550. def _print_AlgebraicNumber(self, expr):
  551. if expr.is_aliased:
  552. return self._print(expr.as_poly().as_expr())
  553. else:
  554. return self._print(expr.as_expr())
  555. def _print_PrimeIdeal(self, expr):
  556. p = self._print(expr.p)
  557. if expr.is_inert:
  558. return rf'\left({p}\right)'
  559. alpha = self._print(expr.alpha.as_expr())
  560. return rf'\left({p}, {alpha}\right)'
  561. def _print_Pow(self, expr: Pow):
  562. # Treat x**Rational(1,n) as special case
  563. if expr.exp.is_Rational:
  564. p: int = expr.exp.p # type: ignore
  565. q: int = expr.exp.q # type: ignore
  566. if abs(p) == 1 and q != 1 and self._settings['root_notation']:
  567. base = self._print(expr.base)
  568. if q == 2:
  569. tex = r"\sqrt{%s}" % base
  570. elif self._settings['itex']:
  571. tex = r"\root{%d}{%s}" % (q, base)
  572. else:
  573. tex = r"\sqrt[%d]{%s}" % (q, base)
  574. if expr.exp.is_negative:
  575. return r"\frac{1}{%s}" % tex
  576. else:
  577. return tex
  578. elif self._settings['fold_frac_powers'] and q != 1:
  579. base = self.parenthesize(expr.base, PRECEDENCE['Pow'])
  580. # issue #12886: add parentheses for superscripts raised to powers
  581. if expr.base.is_Symbol:
  582. base = self.parenthesize_super(base)
  583. if expr.base.is_Function:
  584. return self._print(expr.base, exp="%s/%s" % (p, q))
  585. return r"%s^{%s/%s}" % (base, p, q)
  586. elif expr.exp.is_negative and expr.base.is_commutative:
  587. # special case for 1^(-x), issue 9216
  588. if expr.base == 1:
  589. return r"%s^{%s}" % (expr.base, expr.exp)
  590. # special case for (1/x)^(-y) and (-1/-x)^(-y), issue 20252
  591. if expr.base.is_Rational:
  592. base_p: int = expr.base.p # type: ignore
  593. base_q: int = expr.base.q # type: ignore
  594. if base_p * base_q == abs(base_q):
  595. if expr.exp == -1:
  596. return r"\frac{1}{\frac{%s}{%s}}" % (base_p, base_q)
  597. else:
  598. return r"\frac{1}{(\frac{%s}{%s})^{%s}}" % (base_p, base_q, abs(expr.exp))
  599. # things like 1/x
  600. return self._print_Mul(expr)
  601. if expr.base.is_Function:
  602. return self._print(expr.base, exp=self._print(expr.exp))
  603. tex = r"%s^{%s}"
  604. return self._helper_print_standard_power(expr, tex)
  605. def _helper_print_standard_power(self, expr, template: str) -> str:
  606. exp = self._print(expr.exp)
  607. # issue #12886: add parentheses around superscripts raised
  608. # to powers
  609. base = self.parenthesize(expr.base, PRECEDENCE['Pow'])
  610. if expr.base.is_Symbol:
  611. base = self.parenthesize_super(base)
  612. elif expr.base.is_Float:
  613. base = r"{%s}" % base
  614. elif (isinstance(expr.base, Derivative)
  615. and base.startswith(r'\left(')
  616. and re.match(r'\\left\(\\d?d?dot', base)
  617. and base.endswith(r'\right)')):
  618. # don't use parentheses around dotted derivative
  619. base = base[6: -7] # remove outermost added parens
  620. return template % (base, exp)
  621. def _print_UnevaluatedExpr(self, expr):
  622. return self._print(expr.args[0])
  623. def _print_Sum(self, expr):
  624. if len(expr.limits) == 1:
  625. tex = r"\sum_{%s=%s}^{%s} " % \
  626. tuple([self._print(i) for i in expr.limits[0]])
  627. else:
  628. def _format_ineq(l):
  629. return r"%s \leq %s \leq %s" % \
  630. tuple([self._print(s) for s in (l[1], l[0], l[2])])
  631. tex = r"\sum_{\substack{%s}} " % \
  632. str.join('\\\\', [_format_ineq(l) for l in expr.limits])
  633. if isinstance(expr.function, Add):
  634. tex += r"\left(%s\right)" % self._print(expr.function)
  635. else:
  636. tex += self._print(expr.function)
  637. return tex
  638. def _print_Product(self, expr):
  639. if len(expr.limits) == 1:
  640. tex = r"\prod_{%s=%s}^{%s} " % \
  641. tuple([self._print(i) for i in expr.limits[0]])
  642. else:
  643. def _format_ineq(l):
  644. return r"%s \leq %s \leq %s" % \
  645. tuple([self._print(s) for s in (l[1], l[0], l[2])])
  646. tex = r"\prod_{\substack{%s}} " % \
  647. str.join('\\\\', [_format_ineq(l) for l in expr.limits])
  648. if isinstance(expr.function, Add):
  649. tex += r"\left(%s\right)" % self._print(expr.function)
  650. else:
  651. tex += self._print(expr.function)
  652. return tex
  653. def _print_BasisDependent(self, expr: 'BasisDependent'):
  654. from sympy.vector import Vector
  655. o1: list[str] = []
  656. if expr == expr.zero:
  657. return expr.zero._latex_form
  658. if isinstance(expr, Vector):
  659. items = expr.separate().items()
  660. else:
  661. items = [(0, expr)]
  662. for system, vect in items:
  663. inneritems = list(vect.components.items())
  664. inneritems.sort(key=lambda x: x[0].__str__())
  665. for k, v in inneritems:
  666. if v == 1:
  667. o1.append(' + ' + k._latex_form)
  668. elif v == -1:
  669. o1.append(' - ' + k._latex_form)
  670. else:
  671. arg_str = r'\left(' + self._print(v) + r'\right)'
  672. o1.append(' + ' + arg_str + k._latex_form)
  673. outstr = (''.join(o1))
  674. if outstr[1] != '-':
  675. outstr = outstr[3:]
  676. else:
  677. outstr = outstr[1:]
  678. return outstr
  679. def _print_Indexed(self, expr):
  680. tex_base = self._print(expr.base)
  681. tex = '{'+tex_base+'}'+'_{%s}' % ','.join(
  682. map(self._print, expr.indices))
  683. return tex
  684. def _print_IndexedBase(self, expr):
  685. return self._print(expr.label)
  686. def _print_Idx(self, expr):
  687. label = self._print(expr.label)
  688. if expr.upper is not None:
  689. upper = self._print(expr.upper)
  690. if expr.lower is not None:
  691. lower = self._print(expr.lower)
  692. else:
  693. lower = self._print(S.Zero)
  694. interval = '{lower}\\mathrel{{..}}\\nobreak {upper}'.format(
  695. lower = lower, upper = upper)
  696. return '{{{label}}}_{{{interval}}}'.format(
  697. label = label, interval = interval)
  698. #if no bounds are defined this just prints the label
  699. return label
  700. def _print_Derivative(self, expr):
  701. if requires_partial(expr.expr):
  702. diff_symbol = r'\partial'
  703. else:
  704. diff_symbol = self._settings["diff_operator_latex"]
  705. tex = ""
  706. dim = 0
  707. for x, num in reversed(expr.variable_count):
  708. dim += num
  709. if num == 1:
  710. tex += r"%s %s" % (diff_symbol, self._print(x))
  711. else:
  712. tex += r"%s %s^{%s}" % (diff_symbol,
  713. self.parenthesize_super(self._print(x)),
  714. self._print(num))
  715. if dim == 1:
  716. tex = r"\frac{%s}{%s}" % (diff_symbol, tex)
  717. else:
  718. tex = r"\frac{%s^{%s}}{%s}" % (diff_symbol, self._print(dim), tex)
  719. if any(i.could_extract_minus_sign() for i in expr.args):
  720. return r"%s %s" % (tex, self.parenthesize(expr.expr,
  721. PRECEDENCE["Mul"],
  722. is_neg=True,
  723. strict=True))
  724. return r"%s %s" % (tex, self.parenthesize(expr.expr,
  725. PRECEDENCE["Mul"],
  726. is_neg=False,
  727. strict=True))
  728. def _print_Subs(self, subs):
  729. expr, old, new = subs.args
  730. latex_expr = self._print(expr)
  731. latex_old = (self._print(e) for e in old)
  732. latex_new = (self._print(e) for e in new)
  733. latex_subs = r'\\ '.join(
  734. e[0] + '=' + e[1] for e in zip(latex_old, latex_new))
  735. return r'\left. %s \right|_{\substack{ %s }}' % (latex_expr,
  736. latex_subs)
  737. def _print_Integral(self, expr):
  738. tex, symbols = "", []
  739. diff_symbol = self._settings["diff_operator_latex"]
  740. # Only up to \iiiint exists
  741. if len(expr.limits) <= 4 and all(len(lim) == 1 for lim in expr.limits):
  742. # Use len(expr.limits)-1 so that syntax highlighters don't think
  743. # \" is an escaped quote
  744. tex = r"\i" + "i"*(len(expr.limits) - 1) + "nt"
  745. symbols = [r"\, %s%s" % (diff_symbol, self._print(symbol[0]))
  746. for symbol in expr.limits]
  747. else:
  748. for lim in reversed(expr.limits):
  749. symbol = lim[0]
  750. tex += r"\int"
  751. if len(lim) > 1:
  752. if self._settings['mode'] != 'inline' \
  753. and not self._settings['itex']:
  754. tex += r"\limits"
  755. if len(lim) == 3:
  756. tex += "_{%s}^{%s}" % (self._print(lim[1]),
  757. self._print(lim[2]))
  758. if len(lim) == 2:
  759. tex += "^{%s}" % (self._print(lim[1]))
  760. symbols.insert(0, r"\, %s%s" % (diff_symbol, self._print(symbol)))
  761. return r"%s %s%s" % (tex, self.parenthesize(expr.function,
  762. PRECEDENCE["Mul"],
  763. is_neg=any(i.could_extract_minus_sign() for i in expr.args),
  764. strict=True),
  765. "".join(symbols))
  766. def _print_Limit(self, expr):
  767. e, z, z0, dir = expr.args
  768. tex = r"\lim_{%s \to " % self._print(z)
  769. if str(dir) == '+-' or z0 in (S.Infinity, S.NegativeInfinity):
  770. tex += r"%s}" % self._print(z0)
  771. else:
  772. tex += r"%s^%s}" % (self._print(z0), self._print(dir))
  773. if isinstance(e, AssocOp):
  774. return r"%s\left(%s\right)" % (tex, self._print(e))
  775. else:
  776. return r"%s %s" % (tex, self._print(e))
  777. def _hprint_Function(self, func: str) -> str:
  778. r'''
  779. Logic to decide how to render a function to latex
  780. - if it is a recognized latex name, use the appropriate latex command
  781. - if it is a single letter, excluding sub- and superscripts, just use that letter
  782. - if it is a longer name, then put \operatorname{} around it and be
  783. mindful of undercores in the name
  784. '''
  785. func = self._deal_with_super_sub(func)
  786. superscriptidx = func.find("^")
  787. subscriptidx = func.find("_")
  788. if func in accepted_latex_functions:
  789. name = r"\%s" % func
  790. elif len(func) == 1 or func.startswith('\\') or subscriptidx == 1 or superscriptidx == 1:
  791. name = func
  792. else:
  793. if superscriptidx > 0 and subscriptidx > 0:
  794. name = r"\operatorname{%s}%s" %(
  795. func[:min(subscriptidx,superscriptidx)],
  796. func[min(subscriptidx,superscriptidx):])
  797. elif superscriptidx > 0:
  798. name = r"\operatorname{%s}%s" %(
  799. func[:superscriptidx],
  800. func[superscriptidx:])
  801. elif subscriptidx > 0:
  802. name = r"\operatorname{%s}%s" %(
  803. func[:subscriptidx],
  804. func[subscriptidx:])
  805. else:
  806. name = r"\operatorname{%s}" % func
  807. return name
  808. def _print_Function(self, expr: Function, exp=None) -> str:
  809. r'''
  810. Render functions to LaTeX, handling functions that LaTeX knows about
  811. e.g., sin, cos, ... by using the proper LaTeX command (\sin, \cos, ...).
  812. For single-letter function names, render them as regular LaTeX math
  813. symbols. For multi-letter function names that LaTeX does not know
  814. about, (e.g., Li, sech) use \operatorname{} so that the function name
  815. is rendered in Roman font and LaTeX handles spacing properly.
  816. expr is the expression involving the function
  817. exp is an exponent
  818. '''
  819. func = expr.func.__name__
  820. if hasattr(self, '_print_' + func) and \
  821. not isinstance(expr, AppliedUndef):
  822. return getattr(self, '_print_' + func)(expr, exp)
  823. else:
  824. args = [str(self._print(arg)) for arg in expr.args]
  825. # How inverse trig functions should be displayed, formats are:
  826. # abbreviated: asin, full: arcsin, power: sin^-1
  827. inv_trig_style = self._settings['inv_trig_style']
  828. # If we are dealing with a power-style inverse trig function
  829. inv_trig_power_case = False
  830. # If it is applicable to fold the argument brackets
  831. can_fold_brackets = self._settings['fold_func_brackets'] and \
  832. len(args) == 1 and \
  833. not self._needs_function_brackets(expr.args[0])
  834. inv_trig_table = [
  835. "asin", "acos", "atan",
  836. "acsc", "asec", "acot",
  837. "asinh", "acosh", "atanh",
  838. "acsch", "asech", "acoth",
  839. ]
  840. # If the function is an inverse trig function, handle the style
  841. if func in inv_trig_table:
  842. if inv_trig_style == "abbreviated":
  843. pass
  844. elif inv_trig_style == "full":
  845. func = ("ar" if func[-1] == "h" else "arc") + func[1:]
  846. elif inv_trig_style == "power":
  847. func = func[1:]
  848. inv_trig_power_case = True
  849. # Can never fold brackets if we're raised to a power
  850. if exp is not None:
  851. can_fold_brackets = False
  852. if inv_trig_power_case:
  853. if func in accepted_latex_functions:
  854. name = r"\%s^{-1}" % func
  855. else:
  856. name = r"\operatorname{%s}^{-1}" % func
  857. elif exp is not None:
  858. func_tex = self._hprint_Function(func)
  859. func_tex = self.parenthesize_super(func_tex)
  860. name = r'%s^{%s}' % (func_tex, exp)
  861. else:
  862. name = self._hprint_Function(func)
  863. if can_fold_brackets:
  864. if func in accepted_latex_functions:
  865. # Wrap argument safely to avoid parse-time conflicts
  866. # with the function name itself
  867. name += r" {%s}"
  868. else:
  869. name += r"%s"
  870. else:
  871. name += r"{\left(%s \right)}"
  872. if inv_trig_power_case and exp is not None:
  873. name += r"^{%s}" % exp
  874. return name % ",".join(args)
  875. def _print_UndefinedFunction(self, expr):
  876. return self._hprint_Function(str(expr))
  877. def _print_ElementwiseApplyFunction(self, expr):
  878. return r"{%s}_{\circ}\left({%s}\right)" % (
  879. self._print(expr.function),
  880. self._print(expr.expr),
  881. )
  882. @property
  883. def _special_function_classes(self):
  884. from sympy.functions.special.tensor_functions import KroneckerDelta
  885. from sympy.functions.special.gamma_functions import gamma, lowergamma
  886. from sympy.functions.special.beta_functions import beta
  887. from sympy.functions.special.delta_functions import DiracDelta
  888. from sympy.functions.special.error_functions import Chi
  889. return {KroneckerDelta: r'\delta',
  890. gamma: r'\Gamma',
  891. lowergamma: r'\gamma',
  892. beta: r'\operatorname{B}',
  893. DiracDelta: r'\delta',
  894. Chi: r'\operatorname{Chi}'}
  895. def _print_FunctionClass(self, expr):
  896. for cls in self._special_function_classes:
  897. if issubclass(expr, cls) and expr.__name__ == cls.__name__:
  898. return self._special_function_classes[cls]
  899. return self._hprint_Function(str(expr))
  900. def _print_Lambda(self, expr):
  901. symbols, expr = expr.args
  902. if len(symbols) == 1:
  903. symbols = self._print(symbols[0])
  904. else:
  905. symbols = self._print(tuple(symbols))
  906. tex = r"\left( %s \mapsto %s \right)" % (symbols, self._print(expr))
  907. return tex
  908. def _print_IdentityFunction(self, expr):
  909. return r"\left( x \mapsto x \right)"
  910. def _hprint_variadic_function(self, expr, exp=None) -> str:
  911. args = sorted(expr.args, key=default_sort_key)
  912. texargs = [r"%s" % self._print(symbol) for symbol in args]
  913. tex = r"\%s\left(%s\right)" % (str(expr.func).lower(),
  914. ", ".join(texargs))
  915. if exp is not None:
  916. return r"%s^{%s}" % (tex, exp)
  917. else:
  918. return tex
  919. _print_Min = _print_Max = _hprint_variadic_function
  920. def _print_floor(self, expr, exp=None):
  921. tex = r"\left\lfloor{%s}\right\rfloor" % self._print(expr.args[0])
  922. if exp is not None:
  923. return r"%s^{%s}" % (tex, exp)
  924. else:
  925. return tex
  926. def _print_ceiling(self, expr, exp=None):
  927. tex = r"\left\lceil{%s}\right\rceil" % self._print(expr.args[0])
  928. if exp is not None:
  929. return r"%s^{%s}" % (tex, exp)
  930. else:
  931. return tex
  932. def _print_log(self, expr, exp=None):
  933. if not self._settings["ln_notation"]:
  934. tex = r"\log{\left(%s \right)}" % self._print(expr.args[0])
  935. else:
  936. tex = r"\ln{\left(%s \right)}" % self._print(expr.args[0])
  937. if exp is not None:
  938. return r"%s^{%s}" % (tex, exp)
  939. else:
  940. return tex
  941. def _print_Abs(self, expr, exp=None):
  942. tex = r"\left|{%s}\right|" % self._print(expr.args[0])
  943. if exp is not None:
  944. return r"%s^{%s}" % (tex, exp)
  945. else:
  946. return tex
  947. def _print_re(self, expr, exp=None):
  948. if self._settings['gothic_re_im']:
  949. tex = r"\Re{%s}" % self.parenthesize(expr.args[0], PRECEDENCE['Atom'])
  950. else:
  951. tex = r"\operatorname{{re}}{{{}}}".format(self.parenthesize(expr.args[0], PRECEDENCE['Atom']))
  952. return self._do_exponent(tex, exp)
  953. def _print_im(self, expr, exp=None):
  954. if self._settings['gothic_re_im']:
  955. tex = r"\Im{%s}" % self.parenthesize(expr.args[0], PRECEDENCE['Atom'])
  956. else:
  957. tex = r"\operatorname{{im}}{{{}}}".format(self.parenthesize(expr.args[0], PRECEDENCE['Atom']))
  958. return self._do_exponent(tex, exp)
  959. def _print_Not(self, e):
  960. from sympy.logic.boolalg import (Equivalent, Implies)
  961. if isinstance(e.args[0], Equivalent):
  962. return self._print_Equivalent(e.args[0], r"\not\Leftrightarrow")
  963. if isinstance(e.args[0], Implies):
  964. return self._print_Implies(e.args[0], r"\not\Rightarrow")
  965. if (e.args[0].is_Boolean):
  966. return r"\neg \left(%s\right)" % self._print(e.args[0])
  967. else:
  968. return r"\neg %s" % self._print(e.args[0])
  969. def _print_LogOp(self, args, char):
  970. arg = args[0]
  971. if arg.is_Boolean and not arg.is_Not:
  972. tex = r"\left(%s\right)" % self._print(arg)
  973. else:
  974. tex = r"%s" % self._print(arg)
  975. for arg in args[1:]:
  976. if arg.is_Boolean and not arg.is_Not:
  977. tex += r" %s \left(%s\right)" % (char, self._print(arg))
  978. else:
  979. tex += r" %s %s" % (char, self._print(arg))
  980. return tex
  981. def _print_And(self, e):
  982. args = sorted(e.args, key=default_sort_key)
  983. return self._print_LogOp(args, r"\wedge")
  984. def _print_Or(self, e):
  985. args = sorted(e.args, key=default_sort_key)
  986. return self._print_LogOp(args, r"\vee")
  987. def _print_Xor(self, e):
  988. args = sorted(e.args, key=default_sort_key)
  989. return self._print_LogOp(args, r"\veebar")
  990. def _print_Implies(self, e, altchar=None):
  991. return self._print_LogOp(e.args, altchar or r"\Rightarrow")
  992. def _print_Equivalent(self, e, altchar=None):
  993. args = sorted(e.args, key=default_sort_key)
  994. return self._print_LogOp(args, altchar or r"\Leftrightarrow")
  995. def _print_conjugate(self, expr, exp=None):
  996. tex = r"\overline{%s}" % self._print(expr.args[0])
  997. if exp is not None:
  998. return r"%s^{%s}" % (tex, exp)
  999. else:
  1000. return tex
  1001. def _print_polar_lift(self, expr, exp=None):
  1002. func = r"\operatorname{polar\_lift}"
  1003. arg = r"{\left(%s \right)}" % self._print(expr.args[0])
  1004. if exp is not None:
  1005. return r"%s^{%s}%s" % (func, exp, arg)
  1006. else:
  1007. return r"%s%s" % (func, arg)
  1008. def _print_ExpBase(self, expr, exp=None):
  1009. # TODO should exp_polar be printed differently?
  1010. # what about exp_polar(0), exp_polar(1)?
  1011. tex = r"e^{%s}" % self._print(expr.args[0])
  1012. return self._do_exponent(tex, exp)
  1013. def _print_Exp1(self, expr, exp=None):
  1014. return "e"
  1015. def _print_elliptic_k(self, expr, exp=None):
  1016. tex = r"\left(%s\right)" % self._print(expr.args[0])
  1017. if exp is not None:
  1018. return r"K^{%s}%s" % (exp, tex)
  1019. else:
  1020. return r"K%s" % tex
  1021. def _print_elliptic_f(self, expr, exp=None):
  1022. tex = r"\left(%s\middle| %s\right)" % \
  1023. (self._print(expr.args[0]), self._print(expr.args[1]))
  1024. if exp is not None:
  1025. return r"F^{%s}%s" % (exp, tex)
  1026. else:
  1027. return r"F%s" % tex
  1028. def _print_elliptic_e(self, expr, exp=None):
  1029. if len(expr.args) == 2:
  1030. tex = r"\left(%s\middle| %s\right)" % \
  1031. (self._print(expr.args[0]), self._print(expr.args[1]))
  1032. else:
  1033. tex = r"\left(%s\right)" % self._print(expr.args[0])
  1034. if exp is not None:
  1035. return r"E^{%s}%s" % (exp, tex)
  1036. else:
  1037. return r"E%s" % tex
  1038. def _print_elliptic_pi(self, expr, exp=None):
  1039. if len(expr.args) == 3:
  1040. tex = r"\left(%s; %s\middle| %s\right)" % \
  1041. (self._print(expr.args[0]), self._print(expr.args[1]),
  1042. self._print(expr.args[2]))
  1043. else:
  1044. tex = r"\left(%s\middle| %s\right)" % \
  1045. (self._print(expr.args[0]), self._print(expr.args[1]))
  1046. if exp is not None:
  1047. return r"\Pi^{%s}%s" % (exp, tex)
  1048. else:
  1049. return r"\Pi%s" % tex
  1050. def _print_beta(self, expr, exp=None):
  1051. x = expr.args[0]
  1052. # Deal with unevaluated single argument beta
  1053. y = expr.args[0] if len(expr.args) == 1 else expr.args[1]
  1054. tex = rf"\left({x}, {y}\right)"
  1055. if exp is not None:
  1056. return r"\operatorname{B}^{%s}%s" % (exp, tex)
  1057. else:
  1058. return r"\operatorname{B}%s" % tex
  1059. def _print_betainc(self, expr, exp=None, operator='B'):
  1060. largs = [self._print(arg) for arg in expr.args]
  1061. tex = r"\left(%s, %s\right)" % (largs[0], largs[1])
  1062. if exp is not None:
  1063. return r"\operatorname{%s}_{(%s, %s)}^{%s}%s" % (operator, largs[2], largs[3], exp, tex)
  1064. else:
  1065. return r"\operatorname{%s}_{(%s, %s)}%s" % (operator, largs[2], largs[3], tex)
  1066. def _print_betainc_regularized(self, expr, exp=None):
  1067. return self._print_betainc(expr, exp, operator='I')
  1068. def _print_uppergamma(self, expr, exp=None):
  1069. tex = r"\left(%s, %s\right)" % (self._print(expr.args[0]),
  1070. self._print(expr.args[1]))
  1071. if exp is not None:
  1072. return r"\Gamma^{%s}%s" % (exp, tex)
  1073. else:
  1074. return r"\Gamma%s" % tex
  1075. def _print_lowergamma(self, expr, exp=None):
  1076. tex = r"\left(%s, %s\right)" % (self._print(expr.args[0]),
  1077. self._print(expr.args[1]))
  1078. if exp is not None:
  1079. return r"\gamma^{%s}%s" % (exp, tex)
  1080. else:
  1081. return r"\gamma%s" % tex
  1082. def _hprint_one_arg_func(self, expr, exp=None) -> str:
  1083. tex = r"\left(%s\right)" % self._print(expr.args[0])
  1084. if exp is not None:
  1085. return r"%s^{%s}%s" % (self._print(expr.func), exp, tex)
  1086. else:
  1087. return r"%s%s" % (self._print(expr.func), tex)
  1088. _print_gamma = _hprint_one_arg_func
  1089. def _print_Chi(self, expr, exp=None):
  1090. tex = r"\left(%s\right)" % self._print(expr.args[0])
  1091. if exp is not None:
  1092. return r"\operatorname{Chi}^{%s}%s" % (exp, tex)
  1093. else:
  1094. return r"\operatorname{Chi}%s" % tex
  1095. def _print_expint(self, expr, exp=None):
  1096. tex = r"\left(%s\right)" % self._print(expr.args[1])
  1097. nu = self._print(expr.args[0])
  1098. if exp is not None:
  1099. return r"\operatorname{E}_{%s}^{%s}%s" % (nu, exp, tex)
  1100. else:
  1101. return r"\operatorname{E}_{%s}%s" % (nu, tex)
  1102. def _print_fresnels(self, expr, exp=None):
  1103. tex = r"\left(%s\right)" % self._print(expr.args[0])
  1104. if exp is not None:
  1105. return r"S^{%s}%s" % (exp, tex)
  1106. else:
  1107. return r"S%s" % tex
  1108. def _print_fresnelc(self, expr, exp=None):
  1109. tex = r"\left(%s\right)" % self._print(expr.args[0])
  1110. if exp is not None:
  1111. return r"C^{%s}%s" % (exp, tex)
  1112. else:
  1113. return r"C%s" % tex
  1114. def _print_subfactorial(self, expr, exp=None):
  1115. tex = r"!%s" % self.parenthesize(expr.args[0], PRECEDENCE["Func"])
  1116. if exp is not None:
  1117. return r"\left(%s\right)^{%s}" % (tex, exp)
  1118. else:
  1119. return tex
  1120. def _print_factorial(self, expr, exp=None):
  1121. tex = r"%s!" % self.parenthesize(expr.args[0], PRECEDENCE["Func"])
  1122. if exp is not None:
  1123. return r"%s^{%s}" % (tex, exp)
  1124. else:
  1125. return tex
  1126. def _print_factorial2(self, expr, exp=None):
  1127. tex = r"%s!!" % self.parenthesize(expr.args[0], PRECEDENCE["Func"])
  1128. if exp is not None:
  1129. return r"%s^{%s}" % (tex, exp)
  1130. else:
  1131. return tex
  1132. def _print_binomial(self, expr, exp=None):
  1133. tex = r"{\binom{%s}{%s}}" % (self._print(expr.args[0]),
  1134. self._print(expr.args[1]))
  1135. if exp is not None:
  1136. return r"%s^{%s}" % (tex, exp)
  1137. else:
  1138. return tex
  1139. def _print_RisingFactorial(self, expr, exp=None):
  1140. n, k = expr.args
  1141. base = r"%s" % self.parenthesize(n, PRECEDENCE['Func'])
  1142. tex = r"{%s}^{\left(%s\right)}" % (base, self._print(k))
  1143. return self._do_exponent(tex, exp)
  1144. def _print_FallingFactorial(self, expr, exp=None):
  1145. n, k = expr.args
  1146. sub = r"%s" % self.parenthesize(k, PRECEDENCE['Func'])
  1147. tex = r"{\left(%s\right)}_{%s}" % (self._print(n), sub)
  1148. return self._do_exponent(tex, exp)
  1149. def _hprint_BesselBase(self, expr, exp, sym: str) -> str:
  1150. tex = r"%s" % (sym)
  1151. need_exp = False
  1152. if exp is not None:
  1153. if tex.find('^') == -1:
  1154. tex = r"%s^{%s}" % (tex, exp)
  1155. else:
  1156. need_exp = True
  1157. tex = r"%s_{%s}\left(%s\right)" % (tex, self._print(expr.order),
  1158. self._print(expr.argument))
  1159. if need_exp:
  1160. tex = self._do_exponent(tex, exp)
  1161. return tex
  1162. def _hprint_vec(self, vec) -> str:
  1163. if not vec:
  1164. return ""
  1165. s = ""
  1166. for i in vec[:-1]:
  1167. s += "%s, " % self._print(i)
  1168. s += self._print(vec[-1])
  1169. return s
  1170. def _print_besselj(self, expr, exp=None):
  1171. return self._hprint_BesselBase(expr, exp, 'J')
  1172. def _print_besseli(self, expr, exp=None):
  1173. return self._hprint_BesselBase(expr, exp, 'I')
  1174. def _print_besselk(self, expr, exp=None):
  1175. return self._hprint_BesselBase(expr, exp, 'K')
  1176. def _print_bessely(self, expr, exp=None):
  1177. return self._hprint_BesselBase(expr, exp, 'Y')
  1178. def _print_yn(self, expr, exp=None):
  1179. return self._hprint_BesselBase(expr, exp, 'y')
  1180. def _print_jn(self, expr, exp=None):
  1181. return self._hprint_BesselBase(expr, exp, 'j')
  1182. def _print_hankel1(self, expr, exp=None):
  1183. return self._hprint_BesselBase(expr, exp, 'H^{(1)}')
  1184. def _print_hankel2(self, expr, exp=None):
  1185. return self._hprint_BesselBase(expr, exp, 'H^{(2)}')
  1186. def _print_hn1(self, expr, exp=None):
  1187. return self._hprint_BesselBase(expr, exp, 'h^{(1)}')
  1188. def _print_hn2(self, expr, exp=None):
  1189. return self._hprint_BesselBase(expr, exp, 'h^{(2)}')
  1190. def _hprint_airy(self, expr, exp=None, notation="") -> str:
  1191. tex = r"\left(%s\right)" % self._print(expr.args[0])
  1192. if exp is not None:
  1193. return r"%s^{%s}%s" % (notation, exp, tex)
  1194. else:
  1195. return r"%s%s" % (notation, tex)
  1196. def _hprint_airy_prime(self, expr, exp=None, notation="") -> str:
  1197. tex = r"\left(%s\right)" % self._print(expr.args[0])
  1198. if exp is not None:
  1199. return r"{%s^\prime}^{%s}%s" % (notation, exp, tex)
  1200. else:
  1201. return r"%s^\prime%s" % (notation, tex)
  1202. def _print_airyai(self, expr, exp=None):
  1203. return self._hprint_airy(expr, exp, 'Ai')
  1204. def _print_airybi(self, expr, exp=None):
  1205. return self._hprint_airy(expr, exp, 'Bi')
  1206. def _print_airyaiprime(self, expr, exp=None):
  1207. return self._hprint_airy_prime(expr, exp, 'Ai')
  1208. def _print_airybiprime(self, expr, exp=None):
  1209. return self._hprint_airy_prime(expr, exp, 'Bi')
  1210. def _print_hyper(self, expr, exp=None):
  1211. tex = r"{{}_{%s}F_{%s}\left(\begin{matrix} %s \\ %s \end{matrix}" \
  1212. r"\middle| {%s} \right)}" % \
  1213. (self._print(len(expr.ap)), self._print(len(expr.bq)),
  1214. self._hprint_vec(expr.ap), self._hprint_vec(expr.bq),
  1215. self._print(expr.argument))
  1216. if exp is not None:
  1217. tex = r"{%s}^{%s}" % (tex, exp)
  1218. return tex
  1219. def _print_meijerg(self, expr, exp=None):
  1220. tex = r"{G_{%s, %s}^{%s, %s}\left(\begin{matrix} %s & %s \\" \
  1221. r"%s & %s \end{matrix} \middle| {%s} \right)}" % \
  1222. (self._print(len(expr.ap)), self._print(len(expr.bq)),
  1223. self._print(len(expr.bm)), self._print(len(expr.an)),
  1224. self._hprint_vec(expr.an), self._hprint_vec(expr.aother),
  1225. self._hprint_vec(expr.bm), self._hprint_vec(expr.bother),
  1226. self._print(expr.argument))
  1227. if exp is not None:
  1228. tex = r"{%s}^{%s}" % (tex, exp)
  1229. return tex
  1230. def _print_dirichlet_eta(self, expr, exp=None):
  1231. tex = r"\left(%s\right)" % self._print(expr.args[0])
  1232. if exp is not None:
  1233. return r"\eta^{%s}%s" % (exp, tex)
  1234. return r"\eta%s" % tex
  1235. def _print_zeta(self, expr, exp=None):
  1236. if len(expr.args) == 2:
  1237. tex = r"\left(%s, %s\right)" % tuple(map(self._print, expr.args))
  1238. else:
  1239. tex = r"\left(%s\right)" % self._print(expr.args[0])
  1240. if exp is not None:
  1241. return r"\zeta^{%s}%s" % (exp, tex)
  1242. return r"\zeta%s" % tex
  1243. def _print_stieltjes(self, expr, exp=None):
  1244. if len(expr.args) == 2:
  1245. tex = r"_{%s}\left(%s\right)" % tuple(map(self._print, expr.args))
  1246. else:
  1247. tex = r"_{%s}" % self._print(expr.args[0])
  1248. if exp is not None:
  1249. return r"\gamma%s^{%s}" % (tex, exp)
  1250. return r"\gamma%s" % tex
  1251. def _print_lerchphi(self, expr, exp=None):
  1252. tex = r"\left(%s, %s, %s\right)" % tuple(map(self._print, expr.args))
  1253. if exp is None:
  1254. return r"\Phi%s" % tex
  1255. return r"\Phi^{%s}%s" % (exp, tex)
  1256. def _print_polylog(self, expr, exp=None):
  1257. s, z = map(self._print, expr.args)
  1258. tex = r"\left(%s\right)" % z
  1259. if exp is None:
  1260. return r"\operatorname{Li}_{%s}%s" % (s, tex)
  1261. return r"\operatorname{Li}_{%s}^{%s}%s" % (s, exp, tex)
  1262. def _print_jacobi(self, expr, exp=None):
  1263. n, a, b, x = map(self._print, expr.args)
  1264. tex = r"P_{%s}^{\left(%s,%s\right)}\left(%s\right)" % (n, a, b, x)
  1265. if exp is not None:
  1266. tex = r"\left(" + tex + r"\right)^{%s}" % (exp)
  1267. return tex
  1268. def _print_gegenbauer(self, expr, exp=None):
  1269. n, a, x = map(self._print, expr.args)
  1270. tex = r"C_{%s}^{\left(%s\right)}\left(%s\right)" % (n, a, x)
  1271. if exp is not None:
  1272. tex = r"\left(" + tex + r"\right)^{%s}" % (exp)
  1273. return tex
  1274. def _print_chebyshevt(self, expr, exp=None):
  1275. n, x = map(self._print, expr.args)
  1276. tex = r"T_{%s}\left(%s\right)" % (n, x)
  1277. if exp is not None:
  1278. tex = r"\left(" + tex + r"\right)^{%s}" % (exp)
  1279. return tex
  1280. def _print_chebyshevu(self, expr, exp=None):
  1281. n, x = map(self._print, expr.args)
  1282. tex = r"U_{%s}\left(%s\right)" % (n, x)
  1283. if exp is not None:
  1284. tex = r"\left(" + tex + r"\right)^{%s}" % (exp)
  1285. return tex
  1286. def _print_legendre(self, expr, exp=None):
  1287. n, x = map(self._print, expr.args)
  1288. tex = r"P_{%s}\left(%s\right)" % (n, x)
  1289. if exp is not None:
  1290. tex = r"\left(" + tex + r"\right)^{%s}" % (exp)
  1291. return tex
  1292. def _print_assoc_legendre(self, expr, exp=None):
  1293. n, a, x = map(self._print, expr.args)
  1294. tex = r"P_{%s}^{\left(%s\right)}\left(%s\right)" % (n, a, x)
  1295. if exp is not None:
  1296. tex = r"\left(" + tex + r"\right)^{%s}" % (exp)
  1297. return tex
  1298. def _print_hermite(self, expr, exp=None):
  1299. n, x = map(self._print, expr.args)
  1300. tex = r"H_{%s}\left(%s\right)" % (n, x)
  1301. if exp is not None:
  1302. tex = r"\left(" + tex + r"\right)^{%s}" % (exp)
  1303. return tex
  1304. def _print_laguerre(self, expr, exp=None):
  1305. n, x = map(self._print, expr.args)
  1306. tex = r"L_{%s}\left(%s\right)" % (n, x)
  1307. if exp is not None:
  1308. tex = r"\left(" + tex + r"\right)^{%s}" % (exp)
  1309. return tex
  1310. def _print_assoc_laguerre(self, expr, exp=None):
  1311. n, a, x = map(self._print, expr.args)
  1312. tex = r"L_{%s}^{\left(%s\right)}\left(%s\right)" % (n, a, x)
  1313. if exp is not None:
  1314. tex = r"\left(" + tex + r"\right)^{%s}" % (exp)
  1315. return tex
  1316. def _print_Ynm(self, expr, exp=None):
  1317. n, m, theta, phi = map(self._print, expr.args)
  1318. tex = r"Y_{%s}^{%s}\left(%s,%s\right)" % (n, m, theta, phi)
  1319. if exp is not None:
  1320. tex = r"\left(" + tex + r"\right)^{%s}" % (exp)
  1321. return tex
  1322. def _print_Znm(self, expr, exp=None):
  1323. n, m, theta, phi = map(self._print, expr.args)
  1324. tex = r"Z_{%s}^{%s}\left(%s,%s\right)" % (n, m, theta, phi)
  1325. if exp is not None:
  1326. tex = r"\left(" + tex + r"\right)^{%s}" % (exp)
  1327. return tex
  1328. def __print_mathieu_functions(self, character, args, prime=False, exp=None):
  1329. a, q, z = map(self._print, args)
  1330. sup = r"^{\prime}" if prime else ""
  1331. exp = "" if not exp else "^{%s}" % exp
  1332. return r"%s%s\left(%s, %s, %s\right)%s" % (character, sup, a, q, z, exp)
  1333. def _print_mathieuc(self, expr, exp=None):
  1334. return self.__print_mathieu_functions("C", expr.args, exp=exp)
  1335. def _print_mathieus(self, expr, exp=None):
  1336. return self.__print_mathieu_functions("S", expr.args, exp=exp)
  1337. def _print_mathieucprime(self, expr, exp=None):
  1338. return self.__print_mathieu_functions("C", expr.args, prime=True, exp=exp)
  1339. def _print_mathieusprime(self, expr, exp=None):
  1340. return self.__print_mathieu_functions("S", expr.args, prime=True, exp=exp)
  1341. def _print_Rational(self, expr):
  1342. if expr.q != 1:
  1343. sign = ""
  1344. p = expr.p
  1345. if expr.p < 0:
  1346. sign = "- "
  1347. p = -p
  1348. if self._settings['fold_short_frac']:
  1349. return r"%s%d / %d" % (sign, p, expr.q)
  1350. return r"%s\frac{%d}{%d}" % (sign, p, expr.q)
  1351. else:
  1352. return self._print(expr.p)
  1353. def _print_Order(self, expr):
  1354. s = self._print(expr.expr)
  1355. if expr.point and any(p != S.Zero for p in expr.point) or \
  1356. len(expr.variables) > 1:
  1357. s += '; '
  1358. if len(expr.variables) > 1:
  1359. s += self._print(expr.variables)
  1360. elif expr.variables:
  1361. s += self._print(expr.variables[0])
  1362. s += r'\rightarrow '
  1363. if len(expr.point) > 1:
  1364. s += self._print(expr.point)
  1365. else:
  1366. s += self._print(expr.point[0])
  1367. return r"O\left(%s\right)" % s
  1368. def _print_Symbol(self, expr: Symbol, style='plain'):
  1369. name: str = self._settings['symbol_names'].get(expr)
  1370. if name is not None:
  1371. return name
  1372. return self._deal_with_super_sub(expr.name, style=style)
  1373. _print_RandomSymbol = _print_Symbol
  1374. def _split_super_sub(self, name: str) -> tuple[str, list[str], list[str]]:
  1375. if name is None or '{' in name:
  1376. return (name, [], [])
  1377. elif self._settings["disable_split_super_sub"]:
  1378. name, supers, subs = (name.replace('_', '\\_').replace('^', '\\^'), [], [])
  1379. else:
  1380. name, supers, subs = split_super_sub(name)
  1381. name = translate(name)
  1382. supers = [translate(sup) for sup in supers]
  1383. subs = [translate(sub) for sub in subs]
  1384. return (name, supers, subs)
  1385. def _deal_with_super_sub(self, string: str, style='plain') -> str:
  1386. name, supers, subs = self._split_super_sub(string)
  1387. # apply the style only to the name
  1388. if style == 'bold':
  1389. name = "\\mathbf{{{}}}".format(name)
  1390. # glue all items together:
  1391. if supers:
  1392. name += "^{%s}" % " ".join(supers)
  1393. if subs:
  1394. name += "_{%s}" % " ".join(subs)
  1395. return name
  1396. def _print_Relational(self, expr):
  1397. if self._settings['itex']:
  1398. gt = r"\gt"
  1399. lt = r"\lt"
  1400. else:
  1401. gt = ">"
  1402. lt = "<"
  1403. charmap = {
  1404. "==": "=",
  1405. ">": gt,
  1406. "<": lt,
  1407. ">=": r"\geq",
  1408. "<=": r"\leq",
  1409. "!=": r"\neq",
  1410. }
  1411. return "%s %s %s" % (self._print(expr.lhs),
  1412. charmap[expr.rel_op], self._print(expr.rhs))
  1413. def _print_Piecewise(self, expr):
  1414. ecpairs = [r"%s & \text{for}\: %s" % (self._print(e), self._print(c))
  1415. for e, c in expr.args[:-1]]
  1416. if expr.args[-1].cond == true:
  1417. ecpairs.append(r"%s & \text{otherwise}" %
  1418. self._print(expr.args[-1].expr))
  1419. else:
  1420. ecpairs.append(r"%s & \text{for}\: %s" %
  1421. (self._print(expr.args[-1].expr),
  1422. self._print(expr.args[-1].cond)))
  1423. tex = r"\begin{cases} %s \end{cases}"
  1424. return tex % r" \\".join(ecpairs)
  1425. def _print_matrix_contents(self, expr):
  1426. lines = []
  1427. for line in range(expr.rows): # horrible, should be 'rows'
  1428. lines.append(" & ".join([self._print(i) for i in expr[line, :]]))
  1429. mat_str = self._settings['mat_str']
  1430. if mat_str is None:
  1431. if self._settings['mode'] == 'inline':
  1432. mat_str = 'smallmatrix'
  1433. else:
  1434. if (expr.cols <= 10) is True:
  1435. mat_str = 'matrix'
  1436. else:
  1437. mat_str = 'array'
  1438. out_str = r'\begin{%MATSTR%}%s\end{%MATSTR%}'
  1439. out_str = out_str.replace('%MATSTR%', mat_str)
  1440. if mat_str == 'array':
  1441. out_str = out_str.replace('%s', '{' + 'c'*expr.cols + '}%s')
  1442. return out_str % r"\\".join(lines)
  1443. def _print_MatrixBase(self, expr):
  1444. out_str = self._print_matrix_contents(expr)
  1445. if self._settings['mat_delim']:
  1446. left_delim = self._settings['mat_delim']
  1447. right_delim = self._delim_dict[left_delim]
  1448. out_str = r'\left' + left_delim + out_str + \
  1449. r'\right' + right_delim
  1450. return out_str
  1451. def _print_MatrixElement(self, expr):
  1452. matrix_part = self.parenthesize(expr.parent, PRECEDENCE['Atom'], strict=True)
  1453. index_part = f"{self._print(expr.i)},{self._print(expr.j)}"
  1454. return f"{{{matrix_part}}}_{{{index_part}}}"
  1455. def _print_MatrixSlice(self, expr):
  1456. def latexslice(x, dim):
  1457. x = list(x)
  1458. if x[2] == 1:
  1459. del x[2]
  1460. if x[0] == 0:
  1461. x[0] = None
  1462. if x[1] == dim:
  1463. x[1] = None
  1464. return ':'.join(self._print(xi) if xi is not None else '' for xi in x)
  1465. return (self.parenthesize(expr.parent, PRECEDENCE["Atom"], strict=True) + r'\left[' +
  1466. latexslice(expr.rowslice, expr.parent.rows) + ', ' +
  1467. latexslice(expr.colslice, expr.parent.cols) + r'\right]')
  1468. def _print_BlockMatrix(self, expr):
  1469. return self._print(expr.blocks)
  1470. def _print_Transpose(self, expr):
  1471. mat = expr.arg
  1472. from sympy.matrices import MatrixSymbol, BlockMatrix
  1473. if (not isinstance(mat, MatrixSymbol) and
  1474. not isinstance(mat, BlockMatrix) and mat.is_MatrixExpr):
  1475. return r"\left(%s\right)^{T}" % self._print(mat)
  1476. else:
  1477. s = self.parenthesize(mat, precedence_traditional(expr), True)
  1478. if '^' in s:
  1479. return r"\left(%s\right)^{T}" % s
  1480. else:
  1481. return "%s^{T}" % s
  1482. def _print_Trace(self, expr):
  1483. mat = expr.arg
  1484. return r"\operatorname{tr}\left(%s \right)" % self._print(mat)
  1485. def _print_Adjoint(self, expr):
  1486. style_to_latex = {
  1487. "dagger" : r"\dagger",
  1488. "star" : r"\ast",
  1489. "hermitian": r"\mathsf{H}"
  1490. }
  1491. adjoint_style = style_to_latex.get(self._settings["adjoint_style"], r"\dagger")
  1492. mat = expr.arg
  1493. from sympy.matrices import MatrixSymbol, BlockMatrix
  1494. if (not isinstance(mat, MatrixSymbol) and
  1495. not isinstance(mat, BlockMatrix) and mat.is_MatrixExpr):
  1496. return r"\left(%s\right)^{%s}" % (self._print(mat), adjoint_style)
  1497. else:
  1498. s = self.parenthesize(mat, precedence_traditional(expr), True)
  1499. if '^' in s:
  1500. return r"\left(%s\right)^{%s}" % (s, adjoint_style)
  1501. else:
  1502. return r"%s^{%s}" % (s, adjoint_style)
  1503. def _print_MatMul(self, expr):
  1504. from sympy import MatMul
  1505. # Parenthesize nested MatMul but not other types of Mul objects:
  1506. parens = lambda x: self._print(x) if isinstance(x, Mul) and not isinstance(x, MatMul) else \
  1507. self.parenthesize(x, precedence_traditional(expr), False)
  1508. args = list(expr.args)
  1509. if expr.could_extract_minus_sign():
  1510. if args[0] == -1:
  1511. args = args[1:]
  1512. else:
  1513. args[0] = -args[0]
  1514. return '- ' + ' '.join(map(parens, args))
  1515. else:
  1516. return ' '.join(map(parens, args))
  1517. def _print_DotProduct(self, expr):
  1518. level = precedence_traditional(expr)
  1519. left, right = expr.args
  1520. return rf"{self.parenthesize(left, level)} \cdot {self.parenthesize(right, level)}"
  1521. def _print_Determinant(self, expr):
  1522. mat = expr.arg
  1523. if mat.is_MatrixExpr:
  1524. from sympy.matrices.expressions.blockmatrix import BlockMatrix
  1525. if isinstance(mat, BlockMatrix):
  1526. return r"\left|{%s}\right|" % self._print_matrix_contents(mat.blocks)
  1527. return r"\left|{%s}\right|" % self._print(mat)
  1528. return r"\left|{%s}\right|" % self._print_matrix_contents(mat)
  1529. def _print_Mod(self, expr, exp=None):
  1530. if exp is not None:
  1531. return r'\left(%s \bmod %s\right)^{%s}' % \
  1532. (self.parenthesize(expr.args[0], PRECEDENCE['Mul'],
  1533. strict=True),
  1534. self.parenthesize(expr.args[1], PRECEDENCE['Mul'],
  1535. strict=True),
  1536. exp)
  1537. return r'%s \bmod %s' % (self.parenthesize(expr.args[0],
  1538. PRECEDENCE['Mul'],
  1539. strict=True),
  1540. self.parenthesize(expr.args[1],
  1541. PRECEDENCE['Mul'],
  1542. strict=True))
  1543. def _print_HadamardProduct(self, expr):
  1544. args = expr.args
  1545. prec = PRECEDENCE['Pow']
  1546. parens = self.parenthesize
  1547. return r' \circ '.join(
  1548. (parens(arg, prec, strict=True) for arg in args))
  1549. def _print_HadamardPower(self, expr):
  1550. if precedence_traditional(expr.exp) < PRECEDENCE["Mul"]:
  1551. template = r"%s^{\circ \left({%s}\right)}"
  1552. else:
  1553. template = r"%s^{\circ {%s}}"
  1554. return self._helper_print_standard_power(expr, template)
  1555. def _print_KroneckerProduct(self, expr):
  1556. args = expr.args
  1557. prec = PRECEDENCE['Pow']
  1558. parens = self.parenthesize
  1559. return r' \otimes '.join(
  1560. (parens(arg, prec, strict=True) for arg in args))
  1561. def _print_MatPow(self, expr):
  1562. base, exp = expr.base, expr.exp
  1563. from sympy.matrices import MatrixSymbol
  1564. if not isinstance(base, MatrixSymbol) and base.is_MatrixExpr:
  1565. return "\\left(%s\\right)^{%s}" % (self._print(base),
  1566. self._print(exp))
  1567. else:
  1568. base_str = self._print(base)
  1569. if '^' in base_str:
  1570. return r"\left(%s\right)^{%s}" % (base_str, self._print(exp))
  1571. else:
  1572. return "%s^{%s}" % (base_str, self._print(exp))
  1573. def _print_MatrixSymbol(self, expr):
  1574. return self._print_Symbol(expr, style=self._settings[
  1575. 'mat_symbol_style'])
  1576. def _print_ZeroMatrix(self, Z):
  1577. return "0" if self._settings[
  1578. 'mat_symbol_style'] == 'plain' else r"\mathbf{0}"
  1579. def _print_OneMatrix(self, O):
  1580. return "1" if self._settings[
  1581. 'mat_symbol_style'] == 'plain' else r"\mathbf{1}"
  1582. def _print_Identity(self, I):
  1583. return r"\mathbb{I}" if self._settings[
  1584. 'mat_symbol_style'] == 'plain' else r"\mathbf{I}"
  1585. def _print_PermutationMatrix(self, P):
  1586. perm_str = self._print(P.args[0])
  1587. return "P_{%s}" % perm_str
  1588. def _print_NDimArray(self, expr: NDimArray):
  1589. if expr.rank() == 0:
  1590. return self._print(expr[()])
  1591. mat_str = self._settings['mat_str']
  1592. if mat_str is None:
  1593. if self._settings['mode'] == 'inline':
  1594. mat_str = 'smallmatrix'
  1595. else:
  1596. if (expr.rank() == 0) or (expr.shape[-1] <= 10):
  1597. mat_str = 'matrix'
  1598. else:
  1599. mat_str = 'array'
  1600. block_str = r'\begin{%MATSTR%}%s\end{%MATSTR%}'
  1601. block_str = block_str.replace('%MATSTR%', mat_str)
  1602. if mat_str == 'array':
  1603. block_str = block_str.replace('%s', '{' + 'c'*expr.shape[0] + '}%s')
  1604. if self._settings['mat_delim']:
  1605. left_delim: str = self._settings['mat_delim']
  1606. right_delim = self._delim_dict[left_delim]
  1607. block_str = r'\left' + left_delim + block_str + \
  1608. r'\right' + right_delim
  1609. if expr.rank() == 0:
  1610. return block_str % ""
  1611. level_str: list[list[str]] = [[] for i in range(expr.rank() + 1)]
  1612. shape_ranges = [list(range(i)) for i in expr.shape]
  1613. for outer_i in itertools.product(*shape_ranges):
  1614. level_str[-1].append(self._print(expr[outer_i]))
  1615. even = True
  1616. for back_outer_i in range(expr.rank()-1, -1, -1):
  1617. if len(level_str[back_outer_i+1]) < expr.shape[back_outer_i]:
  1618. break
  1619. if even:
  1620. level_str[back_outer_i].append(
  1621. r" & ".join(level_str[back_outer_i+1]))
  1622. else:
  1623. level_str[back_outer_i].append(
  1624. block_str % (r"\\".join(level_str[back_outer_i+1])))
  1625. if len(level_str[back_outer_i+1]) == 1:
  1626. level_str[back_outer_i][-1] = r"\left[" + \
  1627. level_str[back_outer_i][-1] + r"\right]"
  1628. even = not even
  1629. level_str[back_outer_i+1] = []
  1630. out_str = level_str[0][0]
  1631. if expr.rank() % 2 == 1:
  1632. out_str = block_str % out_str
  1633. return out_str
  1634. def _printer_tensor_indices(self, name, indices, index_map: dict):
  1635. out_str = self._print(name)
  1636. last_valence = None
  1637. prev_map = None
  1638. for index in indices:
  1639. new_valence = index.is_up
  1640. if ((index in index_map) or prev_map) and \
  1641. last_valence == new_valence:
  1642. out_str += ","
  1643. if last_valence != new_valence:
  1644. if last_valence is not None:
  1645. out_str += "}"
  1646. if index.is_up:
  1647. out_str += "{}^{"
  1648. else:
  1649. out_str += "{}_{"
  1650. out_str += self._print(index.args[0])
  1651. if index in index_map:
  1652. out_str += "="
  1653. out_str += self._print(index_map[index])
  1654. prev_map = True
  1655. else:
  1656. prev_map = False
  1657. last_valence = new_valence
  1658. if last_valence is not None:
  1659. out_str += "}"
  1660. return out_str
  1661. def _print_Tensor(self, expr):
  1662. name = expr.args[0].args[0]
  1663. indices = expr.get_indices()
  1664. return self._printer_tensor_indices(name, indices, {})
  1665. def _print_TensorElement(self, expr):
  1666. name = expr.expr.args[0].args[0]
  1667. indices = expr.expr.get_indices()
  1668. index_map = expr.index_map
  1669. return self._printer_tensor_indices(name, indices, index_map)
  1670. def _print_TensMul(self, expr):
  1671. # prints expressions like "A(a)", "3*A(a)", "(1+x)*A(a)"
  1672. sign, args = expr._get_args_for_traditional_printer()
  1673. return sign + "".join(
  1674. [self.parenthesize(arg, precedence(expr)) for arg in args]
  1675. )
  1676. def _print_TensAdd(self, expr):
  1677. a = []
  1678. args = expr.args
  1679. for x in args:
  1680. a.append(self.parenthesize(x, precedence(expr)))
  1681. a.sort()
  1682. s = ' + '.join(a)
  1683. s = s.replace('+ -', '- ')
  1684. return s
  1685. def _print_TensorIndex(self, expr):
  1686. return "{}%s{%s}" % (
  1687. "^" if expr.is_up else "_",
  1688. self._print(expr.args[0])
  1689. )
  1690. def _print_PartialDerivative(self, expr):
  1691. if len(expr.variables) == 1:
  1692. return r"\frac{\partial}{\partial {%s}}{%s}" % (
  1693. self._print(expr.variables[0]),
  1694. self.parenthesize(expr.expr, PRECEDENCE["Mul"], False)
  1695. )
  1696. else:
  1697. return r"\frac{\partial^{%s}}{%s}{%s}" % (
  1698. len(expr.variables),
  1699. " ".join([r"\partial {%s}" % self._print(i) for i in expr.variables]),
  1700. self.parenthesize(expr.expr, PRECEDENCE["Mul"], False)
  1701. )
  1702. def _print_ArraySymbol(self, expr):
  1703. return self._print(expr.name)
  1704. def _print_ArrayElement(self, expr):
  1705. return "{{%s}_{%s}}" % (
  1706. self.parenthesize(expr.name, PRECEDENCE["Func"], True),
  1707. ", ".join([f"{self._print(i)}" for i in expr.indices]))
  1708. def _print_UniversalSet(self, expr):
  1709. return r"\mathbb{U}"
  1710. def _print_frac(self, expr, exp=None):
  1711. if exp is None:
  1712. return r"\operatorname{frac}{\left(%s\right)}" % self._print(expr.args[0])
  1713. else:
  1714. return r"\operatorname{frac}{\left(%s\right)}^{%s}" % (
  1715. self._print(expr.args[0]), exp)
  1716. def _print_tuple(self, expr):
  1717. if self._settings['decimal_separator'] == 'comma':
  1718. sep = ";"
  1719. elif self._settings['decimal_separator'] == 'period':
  1720. sep = ","
  1721. else:
  1722. raise ValueError('Unknown Decimal Separator')
  1723. if len(expr) == 1:
  1724. # 1-tuple needs a trailing separator
  1725. return self._add_parens_lspace(self._print(expr[0]) + sep)
  1726. else:
  1727. return self._add_parens_lspace(
  1728. (sep + r" \ ").join([self._print(i) for i in expr]))
  1729. def _print_TensorProduct(self, expr):
  1730. elements = [self._print(a) for a in expr.args]
  1731. return r' \otimes '.join(elements)
  1732. def _print_WedgeProduct(self, expr):
  1733. elements = [self._print(a) for a in expr.args]
  1734. return r' \wedge '.join(elements)
  1735. def _print_Tuple(self, expr):
  1736. return self._print_tuple(expr)
  1737. def _print_list(self, expr):
  1738. if self._settings['decimal_separator'] == 'comma':
  1739. return r"\left[ %s\right]" % \
  1740. r"; \ ".join([self._print(i) for i in expr])
  1741. elif self._settings['decimal_separator'] == 'period':
  1742. return r"\left[ %s\right]" % \
  1743. r", \ ".join([self._print(i) for i in expr])
  1744. else:
  1745. raise ValueError('Unknown Decimal Separator')
  1746. def _print_dict(self, d):
  1747. keys = sorted(d.keys(), key=default_sort_key)
  1748. items = []
  1749. for key in keys:
  1750. val = d[key]
  1751. items.append("%s : %s" % (self._print(key), self._print(val)))
  1752. return r"\left\{ %s\right\}" % r", \ ".join(items)
  1753. def _print_Dict(self, expr):
  1754. return self._print_dict(expr)
  1755. def _print_DiracDelta(self, expr, exp=None):
  1756. if len(expr.args) == 1 or expr.args[1] == 0:
  1757. tex = r"\delta\left(%s\right)" % self._print(expr.args[0])
  1758. else:
  1759. tex = r"\delta^{\left( %s \right)}\left( %s \right)" % (
  1760. self._print(expr.args[1]), self._print(expr.args[0]))
  1761. if exp:
  1762. tex = r"\left(%s\right)^{%s}" % (tex, exp)
  1763. return tex
  1764. def _print_SingularityFunction(self, expr, exp=None):
  1765. shift = self._print(expr.args[0] - expr.args[1])
  1766. power = self._print(expr.args[2])
  1767. tex = r"{\left\langle %s \right\rangle}^{%s}" % (shift, power)
  1768. if exp is not None:
  1769. tex = r"{\left({\langle %s \rangle}^{%s}\right)}^{%s}" % (shift, power, exp)
  1770. return tex
  1771. def _print_Heaviside(self, expr, exp=None):
  1772. pargs = ', '.join(self._print(arg) for arg in expr.pargs)
  1773. tex = r"\theta\left(%s\right)" % pargs
  1774. if exp:
  1775. tex = r"\left(%s\right)^{%s}" % (tex, exp)
  1776. return tex
  1777. def _print_KroneckerDelta(self, expr, exp=None):
  1778. i = self._print(expr.args[0])
  1779. j = self._print(expr.args[1])
  1780. if expr.args[0].is_Atom and expr.args[1].is_Atom:
  1781. tex = r'\delta_{%s %s}' % (i, j)
  1782. else:
  1783. tex = r'\delta_{%s, %s}' % (i, j)
  1784. if exp is not None:
  1785. tex = r'\left(%s\right)^{%s}' % (tex, exp)
  1786. return tex
  1787. def _print_LeviCivita(self, expr, exp=None):
  1788. indices = map(self._print, expr.args)
  1789. if all(x.is_Atom for x in expr.args):
  1790. tex = r'\varepsilon_{%s}' % " ".join(indices)
  1791. else:
  1792. tex = r'\varepsilon_{%s}' % ", ".join(indices)
  1793. if exp:
  1794. tex = r'\left(%s\right)^{%s}' % (tex, exp)
  1795. return tex
  1796. def _print_RandomDomain(self, d):
  1797. if hasattr(d, 'as_boolean'):
  1798. return '\\text{Domain: }' + self._print(d.as_boolean())
  1799. elif hasattr(d, 'set'):
  1800. return ('\\text{Domain: }' + self._print(d.symbols) + ' \\in ' +
  1801. self._print(d.set))
  1802. elif hasattr(d, 'symbols'):
  1803. return '\\text{Domain on }' + self._print(d.symbols)
  1804. else:
  1805. return self._print(None)
  1806. def _print_FiniteSet(self, s):
  1807. items = sorted(s.args, key=default_sort_key)
  1808. return self._print_set(items)
  1809. def _print_set(self, s):
  1810. items = sorted(s, key=default_sort_key)
  1811. if self._settings['decimal_separator'] == 'comma':
  1812. items = "; ".join(map(self._print, items))
  1813. elif self._settings['decimal_separator'] == 'period':
  1814. items = ", ".join(map(self._print, items))
  1815. else:
  1816. raise ValueError('Unknown Decimal Separator')
  1817. return r"\left\{%s\right\}" % items
  1818. _print_frozenset = _print_set
  1819. def _print_Range(self, s):
  1820. def _print_symbolic_range():
  1821. # Symbolic Range that cannot be resolved
  1822. if s.args[0] == 0:
  1823. if s.args[2] == 1:
  1824. cont = self._print(s.args[1])
  1825. else:
  1826. cont = ", ".join(self._print(arg) for arg in s.args)
  1827. else:
  1828. if s.args[2] == 1:
  1829. cont = ", ".join(self._print(arg) for arg in s.args[:2])
  1830. else:
  1831. cont = ", ".join(self._print(arg) for arg in s.args)
  1832. return(f"\\text{{Range}}\\left({cont}\\right)")
  1833. dots = object()
  1834. if s.start.is_infinite and s.stop.is_infinite:
  1835. if s.step.is_positive:
  1836. printset = dots, -1, 0, 1, dots
  1837. else:
  1838. printset = dots, 1, 0, -1, dots
  1839. elif s.start.is_infinite:
  1840. printset = dots, s[-1] - s.step, s[-1]
  1841. elif s.stop.is_infinite:
  1842. it = iter(s)
  1843. printset = next(it), next(it), dots
  1844. elif s.is_empty is not None:
  1845. if (s.size < 4) == True:
  1846. printset = tuple(s)
  1847. elif s.is_iterable:
  1848. it = iter(s)
  1849. printset = next(it), next(it), dots, s[-1]
  1850. else:
  1851. return _print_symbolic_range()
  1852. else:
  1853. return _print_symbolic_range()
  1854. return (r"\left\{" +
  1855. r", ".join(self._print(el) if el is not dots else r'\ldots' for el in printset) +
  1856. r"\right\}")
  1857. def __print_number_polynomial(self, expr, letter, exp=None):
  1858. if len(expr.args) == 2:
  1859. if exp is not None:
  1860. return r"%s_{%s}^{%s}\left(%s\right)" % (letter,
  1861. self._print(expr.args[0]), exp,
  1862. self._print(expr.args[1]))
  1863. return r"%s_{%s}\left(%s\right)" % (letter,
  1864. self._print(expr.args[0]), self._print(expr.args[1]))
  1865. tex = r"%s_{%s}" % (letter, self._print(expr.args[0]))
  1866. if exp is not None:
  1867. tex = r"%s^{%s}" % (tex, exp)
  1868. return tex
  1869. def _print_bernoulli(self, expr, exp=None):
  1870. return self.__print_number_polynomial(expr, "B", exp)
  1871. def _print_genocchi(self, expr, exp=None):
  1872. return self.__print_number_polynomial(expr, "G", exp)
  1873. def _print_bell(self, expr, exp=None):
  1874. if len(expr.args) == 3:
  1875. tex1 = r"B_{%s, %s}" % (self._print(expr.args[0]),
  1876. self._print(expr.args[1]))
  1877. tex2 = r"\left(%s\right)" % r", ".join(self._print(el) for
  1878. el in expr.args[2])
  1879. if exp is not None:
  1880. tex = r"%s^{%s}%s" % (tex1, exp, tex2)
  1881. else:
  1882. tex = tex1 + tex2
  1883. return tex
  1884. return self.__print_number_polynomial(expr, "B", exp)
  1885. def _print_fibonacci(self, expr, exp=None):
  1886. return self.__print_number_polynomial(expr, "F", exp)
  1887. def _print_lucas(self, expr, exp=None):
  1888. tex = r"L_{%s}" % self._print(expr.args[0])
  1889. if exp is not None:
  1890. tex = r"%s^{%s}" % (tex, exp)
  1891. return tex
  1892. def _print_tribonacci(self, expr, exp=None):
  1893. return self.__print_number_polynomial(expr, "T", exp)
  1894. def _print_mobius(self, expr, exp=None):
  1895. if exp is None:
  1896. return r'\mu\left(%s\right)' % self._print(expr.args[0])
  1897. return r'\mu^{%s}\left(%s\right)' % (exp, self._print(expr.args[0]))
  1898. def _print_SeqFormula(self, s):
  1899. dots = object()
  1900. if len(s.start.free_symbols) > 0 or len(s.stop.free_symbols) > 0:
  1901. return r"\left\{%s\right\}_{%s=%s}^{%s}" % (
  1902. self._print(s.formula),
  1903. self._print(s.variables[0]),
  1904. self._print(s.start),
  1905. self._print(s.stop)
  1906. )
  1907. if s.start is S.NegativeInfinity:
  1908. stop = s.stop
  1909. printset = (dots, s.coeff(stop - 3), s.coeff(stop - 2),
  1910. s.coeff(stop - 1), s.coeff(stop))
  1911. elif s.stop is S.Infinity or s.length > 4:
  1912. printset = s[:4]
  1913. printset.append(dots)
  1914. else:
  1915. printset = tuple(s)
  1916. return (r"\left[" +
  1917. r", ".join(self._print(el) if el is not dots else r'\ldots' for el in printset) +
  1918. r"\right]")
  1919. _print_SeqPer = _print_SeqFormula
  1920. _print_SeqAdd = _print_SeqFormula
  1921. _print_SeqMul = _print_SeqFormula
  1922. def _print_Interval(self, i):
  1923. if i.start == i.end:
  1924. return r"\left\{%s\right\}" % self._print(i.start)
  1925. else:
  1926. if i.left_open:
  1927. left = '('
  1928. else:
  1929. left = '['
  1930. if i.right_open:
  1931. right = ')'
  1932. else:
  1933. right = ']'
  1934. return r"\left%s%s, %s\right%s" % \
  1935. (left, self._print(i.start), self._print(i.end), right)
  1936. def _print_AccumulationBounds(self, i):
  1937. return r"\left\langle %s, %s\right\rangle" % \
  1938. (self._print(i.min), self._print(i.max))
  1939. def _print_Union(self, u):
  1940. prec = precedence_traditional(u)
  1941. args_str = [self.parenthesize(i, prec) for i in u.args]
  1942. return r" \cup ".join(args_str)
  1943. def _print_Complement(self, u):
  1944. prec = precedence_traditional(u)
  1945. args_str = [self.parenthesize(i, prec) for i in u.args]
  1946. return r" \setminus ".join(args_str)
  1947. def _print_Intersection(self, u):
  1948. prec = precedence_traditional(u)
  1949. args_str = [self.parenthesize(i, prec) for i in u.args]
  1950. return r" \cap ".join(args_str)
  1951. def _print_SymmetricDifference(self, u):
  1952. prec = precedence_traditional(u)
  1953. args_str = [self.parenthesize(i, prec) for i in u.args]
  1954. return r" \triangle ".join(args_str)
  1955. def _print_ProductSet(self, p):
  1956. prec = precedence_traditional(p)
  1957. if len(p.sets) >= 1 and not has_variety(p.sets):
  1958. return self.parenthesize(p.sets[0], prec) + "^{%d}" % len(p.sets)
  1959. return r" \times ".join(
  1960. self.parenthesize(set, prec) for set in p.sets)
  1961. def _print_EmptySet(self, e):
  1962. return r"\emptyset"
  1963. def _print_Naturals(self, n):
  1964. return r"\mathbb{N}"
  1965. def _print_Naturals0(self, n):
  1966. return r"\mathbb{N}_0"
  1967. def _print_Integers(self, i):
  1968. return r"\mathbb{Z}"
  1969. def _print_Rationals(self, i):
  1970. return r"\mathbb{Q}"
  1971. def _print_Reals(self, i):
  1972. return r"\mathbb{R}"
  1973. def _print_Complexes(self, i):
  1974. return r"\mathbb{C}"
  1975. def _print_ImageSet(self, s):
  1976. expr = s.lamda.expr
  1977. sig = s.lamda.signature
  1978. xys = ((self._print(x), self._print(y)) for x, y in zip(sig, s.base_sets))
  1979. xinys = r", ".join(r"%s \in %s" % xy for xy in xys)
  1980. return r"\left\{%s\; \middle|\; %s\right\}" % (self._print(expr), xinys)
  1981. def _print_ConditionSet(self, s):
  1982. vars_print = ', '.join([self._print(var) for var in Tuple(s.sym)])
  1983. if s.base_set is S.UniversalSet:
  1984. return r"\left\{%s\; \middle|\; %s \right\}" % \
  1985. (vars_print, self._print(s.condition))
  1986. return r"\left\{%s\; \middle|\; %s \in %s \wedge %s \right\}" % (
  1987. vars_print,
  1988. vars_print,
  1989. self._print(s.base_set),
  1990. self._print(s.condition))
  1991. def _print_PowerSet(self, expr):
  1992. arg_print = self._print(expr.args[0])
  1993. return r"\mathcal{{P}}\left({}\right)".format(arg_print)
  1994. def _print_ComplexRegion(self, s):
  1995. vars_print = ', '.join([self._print(var) for var in s.variables])
  1996. return r"\left\{%s\; \middle|\; %s \in %s \right\}" % (
  1997. self._print(s.expr),
  1998. vars_print,
  1999. self._print(s.sets))
  2000. def _print_Contains(self, e):
  2001. return r"%s \in %s" % tuple(self._print(a) for a in e.args)
  2002. def _print_FourierSeries(self, s):
  2003. if s.an.formula is S.Zero and s.bn.formula is S.Zero:
  2004. return self._print(s.a0)
  2005. return self._print_Add(s.truncate()) + r' + \ldots'
  2006. def _print_FormalPowerSeries(self, s):
  2007. return self._print_Add(s.infinite)
  2008. def _print_FiniteField(self, expr):
  2009. return r"\mathbb{F}_{%s}" % expr.mod
  2010. def _print_IntegerRing(self, expr):
  2011. return r"\mathbb{Z}"
  2012. def _print_RationalField(self, expr):
  2013. return r"\mathbb{Q}"
  2014. def _print_RealField(self, expr):
  2015. return r"\mathbb{R}"
  2016. def _print_ComplexField(self, expr):
  2017. return r"\mathbb{C}"
  2018. def _print_PolynomialRing(self, expr):
  2019. domain = self._print(expr.domain)
  2020. symbols = ", ".join(map(self._print, expr.symbols))
  2021. return r"%s\left[%s\right]" % (domain, symbols)
  2022. def _print_FractionField(self, expr):
  2023. domain = self._print(expr.domain)
  2024. symbols = ", ".join(map(self._print, expr.symbols))
  2025. return r"%s\left(%s\right)" % (domain, symbols)
  2026. def _print_PolynomialRingBase(self, expr):
  2027. domain = self._print(expr.domain)
  2028. symbols = ", ".join(map(self._print, expr.symbols))
  2029. inv = ""
  2030. if not expr.is_Poly:
  2031. inv = r"S_<^{-1}"
  2032. return r"%s%s\left[%s\right]" % (inv, domain, symbols)
  2033. def _print_Poly(self, poly):
  2034. cls = poly.__class__.__name__
  2035. terms = []
  2036. for monom, coeff in poly.terms():
  2037. s_monom = ''
  2038. for i, exp in enumerate(monom):
  2039. if exp > 0:
  2040. if exp == 1:
  2041. s_monom += self._print(poly.gens[i])
  2042. else:
  2043. s_monom += self._print(pow(poly.gens[i], exp))
  2044. if coeff.is_Add:
  2045. if s_monom:
  2046. s_coeff = r"\left(%s\right)" % self._print(coeff)
  2047. else:
  2048. s_coeff = self._print(coeff)
  2049. else:
  2050. if s_monom:
  2051. if coeff is S.One:
  2052. terms.extend(['+', s_monom])
  2053. continue
  2054. if coeff is S.NegativeOne:
  2055. terms.extend(['-', s_monom])
  2056. continue
  2057. s_coeff = self._print(coeff)
  2058. if not s_monom:
  2059. s_term = s_coeff
  2060. else:
  2061. s_term = s_coeff + " " + s_monom
  2062. if s_term.startswith('-'):
  2063. terms.extend(['-', s_term[1:]])
  2064. else:
  2065. terms.extend(['+', s_term])
  2066. if terms[0] in ('-', '+'):
  2067. modifier = terms.pop(0)
  2068. if modifier == '-':
  2069. terms[0] = '-' + terms[0]
  2070. expr = ' '.join(terms)
  2071. gens = list(map(self._print, poly.gens))
  2072. domain = "domain=%s" % self._print(poly.get_domain())
  2073. args = ", ".join([expr] + gens + [domain])
  2074. if cls in accepted_latex_functions:
  2075. tex = r"\%s {\left(%s \right)}" % (cls, args)
  2076. else:
  2077. tex = r"\operatorname{%s}{\left( %s \right)}" % (cls, args)
  2078. return tex
  2079. def _print_ComplexRootOf(self, root):
  2080. cls = root.__class__.__name__
  2081. if cls == "ComplexRootOf":
  2082. cls = "CRootOf"
  2083. expr = self._print(root.expr)
  2084. index = root.index
  2085. if cls in accepted_latex_functions:
  2086. return r"\%s {\left(%s, %d\right)}" % (cls, expr, index)
  2087. else:
  2088. return r"\operatorname{%s} {\left(%s, %d\right)}" % (cls, expr,
  2089. index)
  2090. def _print_RootSum(self, expr):
  2091. cls = expr.__class__.__name__
  2092. args = [self._print(expr.expr)]
  2093. if expr.fun is not S.IdentityFunction:
  2094. args.append(self._print(expr.fun))
  2095. if cls in accepted_latex_functions:
  2096. return r"\%s {\left(%s\right)}" % (cls, ", ".join(args))
  2097. else:
  2098. return r"\operatorname{%s} {\left(%s\right)}" % (cls,
  2099. ", ".join(args))
  2100. def _print_OrdinalOmega(self, expr):
  2101. return r"\omega"
  2102. def _print_OmegaPower(self, expr):
  2103. exp, mul = expr.args
  2104. if mul != 1:
  2105. if exp != 1:
  2106. return r"{} \omega^{{{}}}".format(mul, exp)
  2107. else:
  2108. return r"{} \omega".format(mul)
  2109. else:
  2110. if exp != 1:
  2111. return r"\omega^{{{}}}".format(exp)
  2112. else:
  2113. return r"\omega"
  2114. def _print_Ordinal(self, expr):
  2115. return " + ".join([self._print(arg) for arg in expr.args])
  2116. def _print_PolyElement(self, poly):
  2117. mul_symbol = self._settings['mul_symbol_latex']
  2118. return poly.str(self, PRECEDENCE, "{%s}^{%d}", mul_symbol)
  2119. def _print_FracElement(self, frac):
  2120. if frac.denom == 1:
  2121. return self._print(frac.numer)
  2122. else:
  2123. numer = self._print(frac.numer)
  2124. denom = self._print(frac.denom)
  2125. return r"\frac{%s}{%s}" % (numer, denom)
  2126. def _print_euler(self, expr, exp=None):
  2127. m, x = (expr.args[0], None) if len(expr.args) == 1 else expr.args
  2128. tex = r"E_{%s}" % self._print(m)
  2129. if exp is not None:
  2130. tex = r"%s^{%s}" % (tex, exp)
  2131. if x is not None:
  2132. tex = r"%s\left(%s\right)" % (tex, self._print(x))
  2133. return tex
  2134. def _print_catalan(self, expr, exp=None):
  2135. tex = r"C_{%s}" % self._print(expr.args[0])
  2136. if exp is not None:
  2137. tex = r"%s^{%s}" % (tex, exp)
  2138. return tex
  2139. def _print_UnifiedTransform(self, expr, s, inverse=False):
  2140. return r"\mathcal{{{}}}{}_{{{}}}\left[{}\right]\left({}\right)".format(s, '^{-1}' if inverse else '', self._print(expr.args[1]), self._print(expr.args[0]), self._print(expr.args[2]))
  2141. def _print_MellinTransform(self, expr):
  2142. return self._print_UnifiedTransform(expr, 'M')
  2143. def _print_InverseMellinTransform(self, expr):
  2144. return self._print_UnifiedTransform(expr, 'M', True)
  2145. def _print_LaplaceTransform(self, expr):
  2146. return self._print_UnifiedTransform(expr, 'L')
  2147. def _print_InverseLaplaceTransform(self, expr):
  2148. return self._print_UnifiedTransform(expr, 'L', True)
  2149. def _print_FourierTransform(self, expr):
  2150. return self._print_UnifiedTransform(expr, 'F')
  2151. def _print_InverseFourierTransform(self, expr):
  2152. return self._print_UnifiedTransform(expr, 'F', True)
  2153. def _print_SineTransform(self, expr):
  2154. return self._print_UnifiedTransform(expr, 'SIN')
  2155. def _print_InverseSineTransform(self, expr):
  2156. return self._print_UnifiedTransform(expr, 'SIN', True)
  2157. def _print_CosineTransform(self, expr):
  2158. return self._print_UnifiedTransform(expr, 'COS')
  2159. def _print_InverseCosineTransform(self, expr):
  2160. return self._print_UnifiedTransform(expr, 'COS', True)
  2161. def _print_DMP(self, p):
  2162. try:
  2163. if p.ring is not None:
  2164. # TODO incorporate order
  2165. return self._print(p.ring.to_sympy(p))
  2166. except SympifyError:
  2167. pass
  2168. return self._print(repr(p))
  2169. def _print_DMF(self, p):
  2170. return self._print_DMP(p)
  2171. def _print_Object(self, object):
  2172. return self._print(Symbol(object.name))
  2173. def _print_LambertW(self, expr, exp=None):
  2174. arg0 = self._print(expr.args[0])
  2175. exp = r"^{%s}" % (exp,) if exp is not None else ""
  2176. if len(expr.args) == 1:
  2177. result = r"W%s\left(%s\right)" % (exp, arg0)
  2178. else:
  2179. arg1 = self._print(expr.args[1])
  2180. result = "W{0}_{{{1}}}\\left({2}\\right)".format(exp, arg1, arg0)
  2181. return result
  2182. def _print_Expectation(self, expr):
  2183. return r"\operatorname{{E}}\left[{}\right]".format(self._print(expr.args[0]))
  2184. def _print_Variance(self, expr):
  2185. return r"\operatorname{{Var}}\left({}\right)".format(self._print(expr.args[0]))
  2186. def _print_Covariance(self, expr):
  2187. return r"\operatorname{{Cov}}\left({}\right)".format(", ".join(self._print(arg) for arg in expr.args))
  2188. def _print_Probability(self, expr):
  2189. return r"\operatorname{{P}}\left({}\right)".format(self._print(expr.args[0]))
  2190. def _print_Morphism(self, morphism):
  2191. domain = self._print(morphism.domain)
  2192. codomain = self._print(morphism.codomain)
  2193. return "%s\\rightarrow %s" % (domain, codomain)
  2194. def _print_TransferFunction(self, expr):
  2195. num, den = self._print(expr.num), self._print(expr.den)
  2196. return r"\frac{%s}{%s}" % (num, den)
  2197. def _print_Series(self, expr):
  2198. args = list(expr.args)
  2199. parens = lambda x: self.parenthesize(x, precedence_traditional(expr),
  2200. False)
  2201. return ' '.join(map(parens, args))
  2202. def _print_MIMOSeries(self, expr):
  2203. from sympy.physics.control.lti import MIMOParallel
  2204. args = list(expr.args)[::-1]
  2205. parens = lambda x: self.parenthesize(x, precedence_traditional(expr),
  2206. False) if isinstance(x, MIMOParallel) else self._print(x)
  2207. return r"\cdot".join(map(parens, args))
  2208. def _print_Parallel(self, expr):
  2209. return ' + '.join(map(self._print, expr.args))
  2210. def _print_MIMOParallel(self, expr):
  2211. return ' + '.join(map(self._print, expr.args))
  2212. def _print_Feedback(self, expr):
  2213. from sympy.physics.control import TransferFunction, Series
  2214. num, tf = expr.sys1, TransferFunction(1, 1, expr.var)
  2215. num_arg_list = list(num.args) if isinstance(num, Series) else [num]
  2216. den_arg_list = list(expr.sys2.args) if \
  2217. isinstance(expr.sys2, Series) else [expr.sys2]
  2218. den_term_1 = tf
  2219. if isinstance(num, Series) and isinstance(expr.sys2, Series):
  2220. den_term_2 = Series(*num_arg_list, *den_arg_list)
  2221. elif isinstance(num, Series) and isinstance(expr.sys2, TransferFunction):
  2222. if expr.sys2 == tf:
  2223. den_term_2 = Series(*num_arg_list)
  2224. else:
  2225. den_term_2 = tf, Series(*num_arg_list, expr.sys2)
  2226. elif isinstance(num, TransferFunction) and isinstance(expr.sys2, Series):
  2227. if num == tf:
  2228. den_term_2 = Series(*den_arg_list)
  2229. else:
  2230. den_term_2 = Series(num, *den_arg_list)
  2231. else:
  2232. if num == tf:
  2233. den_term_2 = Series(*den_arg_list)
  2234. elif expr.sys2 == tf:
  2235. den_term_2 = Series(*num_arg_list)
  2236. else:
  2237. den_term_2 = Series(*num_arg_list, *den_arg_list)
  2238. numer = self._print(num)
  2239. denom_1 = self._print(den_term_1)
  2240. denom_2 = self._print(den_term_2)
  2241. _sign = "+" if expr.sign == -1 else "-"
  2242. return r"\frac{%s}{%s %s %s}" % (numer, denom_1, _sign, denom_2)
  2243. def _print_MIMOFeedback(self, expr):
  2244. from sympy.physics.control import MIMOSeries
  2245. inv_mat = self._print(MIMOSeries(expr.sys2, expr.sys1))
  2246. sys1 = self._print(expr.sys1)
  2247. _sign = "+" if expr.sign == -1 else "-"
  2248. return r"\left(I_{\tau} %s %s\right)^{-1} \cdot %s" % (_sign, inv_mat, sys1)
  2249. def _print_TransferFunctionMatrix(self, expr):
  2250. mat = self._print(expr._expr_mat)
  2251. return r"%s_\tau" % mat
  2252. def _print_DFT(self, expr):
  2253. return r"\text{{{}}}_{{{}}}".format(expr.__class__.__name__, expr.n)
  2254. _print_IDFT = _print_DFT
  2255. def _print_NamedMorphism(self, morphism):
  2256. pretty_name = self._print(Symbol(morphism.name))
  2257. pretty_morphism = self._print_Morphism(morphism)
  2258. return "%s:%s" % (pretty_name, pretty_morphism)
  2259. def _print_IdentityMorphism(self, morphism):
  2260. from sympy.categories import NamedMorphism
  2261. return self._print_NamedMorphism(NamedMorphism(
  2262. morphism.domain, morphism.codomain, "id"))
  2263. def _print_CompositeMorphism(self, morphism):
  2264. # All components of the morphism have names and it is thus
  2265. # possible to build the name of the composite.
  2266. component_names_list = [self._print(Symbol(component.name)) for
  2267. component in morphism.components]
  2268. component_names_list.reverse()
  2269. component_names = "\\circ ".join(component_names_list) + ":"
  2270. pretty_morphism = self._print_Morphism(morphism)
  2271. return component_names + pretty_morphism
  2272. def _print_Category(self, morphism):
  2273. return r"\mathbf{{{}}}".format(self._print(Symbol(morphism.name)))
  2274. def _print_Diagram(self, diagram):
  2275. if not diagram.premises:
  2276. # This is an empty diagram.
  2277. return self._print(S.EmptySet)
  2278. latex_result = self._print(diagram.premises)
  2279. if diagram.conclusions:
  2280. latex_result += "\\Longrightarrow %s" % \
  2281. self._print(diagram.conclusions)
  2282. return latex_result
  2283. def _print_DiagramGrid(self, grid):
  2284. latex_result = "\\begin{array}{%s}\n" % ("c" * grid.width)
  2285. for i in range(grid.height):
  2286. for j in range(grid.width):
  2287. if grid[i, j]:
  2288. latex_result += latex(grid[i, j])
  2289. latex_result += " "
  2290. if j != grid.width - 1:
  2291. latex_result += "& "
  2292. if i != grid.height - 1:
  2293. latex_result += "\\\\"
  2294. latex_result += "\n"
  2295. latex_result += "\\end{array}\n"
  2296. return latex_result
  2297. def _print_FreeModule(self, M):
  2298. return '{{{}}}^{{{}}}'.format(self._print(M.ring), self._print(M.rank))
  2299. def _print_FreeModuleElement(self, m):
  2300. # Print as row vector for convenience, for now.
  2301. return r"\left[ {} \right]".format(",".join(
  2302. '{' + self._print(x) + '}' for x in m))
  2303. def _print_SubModule(self, m):
  2304. gens = [[self._print(m.ring.to_sympy(x)) for x in g] for g in m.gens]
  2305. curly = lambda o: r"{" + o + r"}"
  2306. square = lambda o: r"\left[ " + o + r" \right]"
  2307. gens_latex = ",".join(curly(square(",".join(curly(x) for x in g))) for g in gens)
  2308. return r"\left\langle {} \right\rangle".format(gens_latex)
  2309. def _print_SubQuotientModule(self, m):
  2310. gens_latex = ",".join(["{" + self._print(g) + "}" for g in m.gens])
  2311. return r"\left\langle {} \right\rangle".format(gens_latex)
  2312. def _print_ModuleImplementedIdeal(self, m):
  2313. gens = [m.ring.to_sympy(x) for [x] in m._module.gens]
  2314. gens_latex = ",".join('{' + self._print(x) + '}' for x in gens)
  2315. return r"\left\langle {} \right\rangle".format(gens_latex)
  2316. def _print_Quaternion(self, expr):
  2317. # TODO: This expression is potentially confusing,
  2318. # shall we print it as `Quaternion( ... )`?
  2319. s = [self.parenthesize(i, PRECEDENCE["Mul"], strict=True)
  2320. for i in expr.args]
  2321. a = [s[0]] + [i+" "+j for i, j in zip(s[1:], "ijk")]
  2322. return " + ".join(a)
  2323. def _print_QuotientRing(self, R):
  2324. # TODO nicer fractions for few generators...
  2325. return r"\frac{{{}}}{{{}}}".format(self._print(R.ring),
  2326. self._print(R.base_ideal))
  2327. def _print_QuotientRingElement(self, x):
  2328. x_latex = self._print(x.ring.to_sympy(x))
  2329. return r"{{{}}} + {{{}}}".format(x_latex,
  2330. self._print(x.ring.base_ideal))
  2331. def _print_QuotientModuleElement(self, m):
  2332. data = [m.module.ring.to_sympy(x) for x in m.data]
  2333. data_latex = r"\left[ {} \right]".format(",".join(
  2334. '{' + self._print(x) + '}' for x in data))
  2335. return r"{{{}}} + {{{}}}".format(data_latex,
  2336. self._print(m.module.killed_module))
  2337. def _print_QuotientModule(self, M):
  2338. # TODO nicer fractions for few generators...
  2339. return r"\frac{{{}}}{{{}}}".format(self._print(M.base),
  2340. self._print(M.killed_module))
  2341. def _print_MatrixHomomorphism(self, h):
  2342. return r"{{{}}} : {{{}}} \to {{{}}}".format(self._print(h._sympy_matrix()),
  2343. self._print(h.domain), self._print(h.codomain))
  2344. def _print_Manifold(self, manifold):
  2345. name, supers, subs = self._split_super_sub(manifold.name.name)
  2346. name = r'\text{%s}' % name
  2347. if supers:
  2348. name += "^{%s}" % " ".join(supers)
  2349. if subs:
  2350. name += "_{%s}" % " ".join(subs)
  2351. return name
  2352. def _print_Patch(self, patch):
  2353. return r'\text{%s}_{%s}' % (self._print(patch.name), self._print(patch.manifold))
  2354. def _print_CoordSystem(self, coordsys):
  2355. return r'\text{%s}^{\text{%s}}_{%s}' % (
  2356. self._print(coordsys.name), self._print(coordsys.patch.name), self._print(coordsys.manifold)
  2357. )
  2358. def _print_CovarDerivativeOp(self, cvd):
  2359. return r'\mathbb{\nabla}_{%s}' % self._print(cvd._wrt)
  2360. def _print_BaseScalarField(self, field):
  2361. string = field._coord_sys.symbols[field._index].name
  2362. return r'\mathbf{{{}}}'.format(self._print(Symbol(string)))
  2363. def _print_BaseVectorField(self, field):
  2364. string = field._coord_sys.symbols[field._index].name
  2365. return r'\partial_{{{}}}'.format(self._print(Symbol(string)))
  2366. def _print_Differential(self, diff):
  2367. field = diff._form_field
  2368. if hasattr(field, '_coord_sys'):
  2369. string = field._coord_sys.symbols[field._index].name
  2370. return r'\operatorname{{d}}{}'.format(self._print(Symbol(string)))
  2371. else:
  2372. string = self._print(field)
  2373. return r'\operatorname{{d}}\left({}\right)'.format(string)
  2374. def _print_Tr(self, p):
  2375. # TODO: Handle indices
  2376. contents = self._print(p.args[0])
  2377. return r'\operatorname{{tr}}\left({}\right)'.format(contents)
  2378. def _print_totient(self, expr, exp=None):
  2379. if exp is not None:
  2380. return r'\left(\phi\left(%s\right)\right)^{%s}' % \
  2381. (self._print(expr.args[0]), exp)
  2382. return r'\phi\left(%s\right)' % self._print(expr.args[0])
  2383. def _print_reduced_totient(self, expr, exp=None):
  2384. if exp is not None:
  2385. return r'\left(\lambda\left(%s\right)\right)^{%s}' % \
  2386. (self._print(expr.args[0]), exp)
  2387. return r'\lambda\left(%s\right)' % self._print(expr.args[0])
  2388. def _print_divisor_sigma(self, expr, exp=None):
  2389. if len(expr.args) == 2:
  2390. tex = r"_%s\left(%s\right)" % tuple(map(self._print,
  2391. (expr.args[1], expr.args[0])))
  2392. else:
  2393. tex = r"\left(%s\right)" % self._print(expr.args[0])
  2394. if exp is not None:
  2395. return r"\sigma^{%s}%s" % (exp, tex)
  2396. return r"\sigma%s" % tex
  2397. def _print_udivisor_sigma(self, expr, exp=None):
  2398. if len(expr.args) == 2:
  2399. tex = r"_%s\left(%s\right)" % tuple(map(self._print,
  2400. (expr.args[1], expr.args[0])))
  2401. else:
  2402. tex = r"\left(%s\right)" % self._print(expr.args[0])
  2403. if exp is not None:
  2404. return r"\sigma^*^{%s}%s" % (exp, tex)
  2405. return r"\sigma^*%s" % tex
  2406. def _print_primenu(self, expr, exp=None):
  2407. if exp is not None:
  2408. return r'\left(\nu\left(%s\right)\right)^{%s}' % \
  2409. (self._print(expr.args[0]), exp)
  2410. return r'\nu\left(%s\right)' % self._print(expr.args[0])
  2411. def _print_primeomega(self, expr, exp=None):
  2412. if exp is not None:
  2413. return r'\left(\Omega\left(%s\right)\right)^{%s}' % \
  2414. (self._print(expr.args[0]), exp)
  2415. return r'\Omega\left(%s\right)' % self._print(expr.args[0])
  2416. def _print_Str(self, s):
  2417. return str(s.name)
  2418. def _print_float(self, expr):
  2419. return self._print(Float(expr))
  2420. def _print_int(self, expr):
  2421. return str(expr)
  2422. def _print_mpz(self, expr):
  2423. return str(expr)
  2424. def _print_mpq(self, expr):
  2425. return str(expr)
  2426. def _print_fmpz(self, expr):
  2427. return str(expr)
  2428. def _print_fmpq(self, expr):
  2429. return str(expr)
  2430. def _print_Predicate(self, expr):
  2431. return r"\operatorname{{Q}}_{{\text{{{}}}}}".format(latex_escape(str(expr.name)))
  2432. def _print_AppliedPredicate(self, expr):
  2433. pred = expr.function
  2434. args = expr.arguments
  2435. pred_latex = self._print(pred)
  2436. args_latex = ', '.join([self._print(a) for a in args])
  2437. return '%s(%s)' % (pred_latex, args_latex)
  2438. def emptyPrinter(self, expr):
  2439. # default to just printing as monospace, like would normally be shown
  2440. s = super().emptyPrinter(expr)
  2441. return r"\mathtt{\text{%s}}" % latex_escape(s)
  2442. def translate(s: str) -> str:
  2443. r'''
  2444. Check for a modifier ending the string. If present, convert the
  2445. modifier to latex and translate the rest recursively.
  2446. Given a description of a Greek letter or other special character,
  2447. return the appropriate latex.
  2448. Let everything else pass as given.
  2449. >>> from sympy.printing.latex import translate
  2450. >>> translate('alphahatdotprime')
  2451. "{\\dot{\\hat{\\alpha}}}'"
  2452. '''
  2453. # Process the rest
  2454. tex = tex_greek_dictionary.get(s)
  2455. if tex:
  2456. return tex
  2457. elif s.lower() in greek_letters_set:
  2458. return "\\" + s.lower()
  2459. elif s in other_symbols:
  2460. return "\\" + s
  2461. else:
  2462. # Process modifiers, if any, and recurse
  2463. for key in sorted(modifier_dict.keys(), key=len, reverse=True):
  2464. if s.lower().endswith(key) and len(s) > len(key):
  2465. return modifier_dict[key](translate(s[:-len(key)]))
  2466. return s
  2467. @print_function(LatexPrinter)
  2468. def latex(expr, **settings):
  2469. r"""Convert the given expression to LaTeX string representation.
  2470. Parameters
  2471. ==========
  2472. full_prec: boolean, optional
  2473. If set to True, a floating point number is printed with full precision.
  2474. fold_frac_powers : boolean, optional
  2475. Emit ``^{p/q}`` instead of ``^{\frac{p}{q}}`` for fractional powers.
  2476. fold_func_brackets : boolean, optional
  2477. Fold function brackets where applicable.
  2478. fold_short_frac : boolean, optional
  2479. Emit ``p / q`` instead of ``\frac{p}{q}`` when the denominator is
  2480. simple enough (at most two terms and no powers). The default value is
  2481. ``True`` for inline mode, ``False`` otherwise.
  2482. inv_trig_style : string, optional
  2483. How inverse trig functions should be displayed. Can be one of
  2484. ``'abbreviated'``, ``'full'``, or ``'power'``. Defaults to
  2485. ``'abbreviated'``.
  2486. itex : boolean, optional
  2487. Specifies if itex-specific syntax is used, including emitting
  2488. ``$$...$$``.
  2489. ln_notation : boolean, optional
  2490. If set to ``True``, ``\ln`` is used instead of default ``\log``.
  2491. long_frac_ratio : float or None, optional
  2492. The allowed ratio of the width of the numerator to the width of the
  2493. denominator before the printer breaks off long fractions. If ``None``
  2494. (the default value), long fractions are not broken up.
  2495. mat_delim : string, optional
  2496. The delimiter to wrap around matrices. Can be one of ``'['``, ``'('``,
  2497. or the empty string ``''``. Defaults to ``'['``.
  2498. mat_str : string, optional
  2499. Which matrix environment string to emit. ``'smallmatrix'``,
  2500. ``'matrix'``, ``'array'``, etc. Defaults to ``'smallmatrix'`` for
  2501. inline mode, ``'matrix'`` for matrices of no more than 10 columns, and
  2502. ``'array'`` otherwise.
  2503. mode: string, optional
  2504. Specifies how the generated code will be delimited. ``mode`` can be one
  2505. of ``'plain'``, ``'inline'``, ``'equation'`` or ``'equation*'``. If
  2506. ``mode`` is set to ``'plain'``, then the resulting code will not be
  2507. delimited at all (this is the default). If ``mode`` is set to
  2508. ``'inline'`` then inline LaTeX ``$...$`` will be used. If ``mode`` is
  2509. set to ``'equation'`` or ``'equation*'``, the resulting code will be
  2510. enclosed in the ``equation`` or ``equation*`` environment (remember to
  2511. import ``amsmath`` for ``equation*``), unless the ``itex`` option is
  2512. set. In the latter case, the ``$$...$$`` syntax is used.
  2513. mul_symbol : string or None, optional
  2514. The symbol to use for multiplication. Can be one of ``None``,
  2515. ``'ldot'``, ``'dot'``, or ``'times'``.
  2516. order: string, optional
  2517. Any of the supported monomial orderings (currently ``'lex'``,
  2518. ``'grlex'``, or ``'grevlex'``), ``'old'``, and ``'none'``. This
  2519. parameter does nothing for `~.Mul` objects. Setting order to ``'old'``
  2520. uses the compatibility ordering for ``~.Add`` defined in Printer. For
  2521. very large expressions, set the ``order`` keyword to ``'none'`` if
  2522. speed is a concern.
  2523. symbol_names : dictionary of strings mapped to symbols, optional
  2524. Dictionary of symbols and the custom strings they should be emitted as.
  2525. root_notation : boolean, optional
  2526. If set to ``False``, exponents of the form 1/n are printed in fractonal
  2527. form. Default is ``True``, to print exponent in root form.
  2528. mat_symbol_style : string, optional
  2529. Can be either ``'plain'`` (default) or ``'bold'``. If set to
  2530. ``'bold'``, a `~.MatrixSymbol` A will be printed as ``\mathbf{A}``,
  2531. otherwise as ``A``.
  2532. imaginary_unit : string, optional
  2533. String to use for the imaginary unit. Defined options are ``'i'``
  2534. (default) and ``'j'``. Adding ``r`` or ``t`` in front gives ``\mathrm``
  2535. or ``\text``, so ``'ri'`` leads to ``\mathrm{i}`` which gives
  2536. `\mathrm{i}`.
  2537. gothic_re_im : boolean, optional
  2538. If set to ``True``, `\Re` and `\Im` is used for ``re`` and ``im``, respectively.
  2539. The default is ``False`` leading to `\operatorname{re}` and `\operatorname{im}`.
  2540. decimal_separator : string, optional
  2541. Specifies what separator to use to separate the whole and fractional parts of a
  2542. floating point number as in `2.5` for the default, ``period`` or `2{,}5`
  2543. when ``comma`` is specified. Lists, sets, and tuple are printed with semicolon
  2544. separating the elements when ``comma`` is chosen. For example, [1; 2; 3] when
  2545. ``comma`` is chosen and [1,2,3] for when ``period`` is chosen.
  2546. parenthesize_super : boolean, optional
  2547. If set to ``False``, superscripted expressions will not be parenthesized when
  2548. powered. Default is ``True``, which parenthesizes the expression when powered.
  2549. min: Integer or None, optional
  2550. Sets the lower bound for the exponent to print floating point numbers in
  2551. fixed-point format.
  2552. max: Integer or None, optional
  2553. Sets the upper bound for the exponent to print floating point numbers in
  2554. fixed-point format.
  2555. diff_operator: string, optional
  2556. String to use for differential operator. Default is ``'d'``, to print in italic
  2557. form. ``'rd'``, ``'td'`` are shortcuts for ``\mathrm{d}`` and ``\text{d}``.
  2558. adjoint_style: string, optional
  2559. String to use for the adjoint symbol. Defined options are ``'dagger'``
  2560. (default),``'star'``, and ``'hermitian'``.
  2561. Notes
  2562. =====
  2563. Not using a print statement for printing, results in double backslashes for
  2564. latex commands since that's the way Python escapes backslashes in strings.
  2565. >>> from sympy import latex, Rational
  2566. >>> from sympy.abc import tau
  2567. >>> latex((2*tau)**Rational(7,2))
  2568. '8 \\sqrt{2} \\tau^{\\frac{7}{2}}'
  2569. >>> print(latex((2*tau)**Rational(7,2)))
  2570. 8 \sqrt{2} \tau^{\frac{7}{2}}
  2571. Examples
  2572. ========
  2573. >>> from sympy import latex, pi, sin, asin, Integral, Matrix, Rational, log
  2574. >>> from sympy.abc import x, y, mu, r, tau
  2575. Basic usage:
  2576. >>> print(latex((2*tau)**Rational(7,2)))
  2577. 8 \sqrt{2} \tau^{\frac{7}{2}}
  2578. ``mode`` and ``itex`` options:
  2579. >>> print(latex((2*mu)**Rational(7,2), mode='plain'))
  2580. 8 \sqrt{2} \mu^{\frac{7}{2}}
  2581. >>> print(latex((2*tau)**Rational(7,2), mode='inline'))
  2582. $8 \sqrt{2} \tau^{7 / 2}$
  2583. >>> print(latex((2*mu)**Rational(7,2), mode='equation*'))
  2584. \begin{equation*}8 \sqrt{2} \mu^{\frac{7}{2}}\end{equation*}
  2585. >>> print(latex((2*mu)**Rational(7,2), mode='equation'))
  2586. \begin{equation}8 \sqrt{2} \mu^{\frac{7}{2}}\end{equation}
  2587. >>> print(latex((2*mu)**Rational(7,2), mode='equation', itex=True))
  2588. $$8 \sqrt{2} \mu^{\frac{7}{2}}$$
  2589. >>> print(latex((2*mu)**Rational(7,2), mode='plain'))
  2590. 8 \sqrt{2} \mu^{\frac{7}{2}}
  2591. >>> print(latex((2*tau)**Rational(7,2), mode='inline'))
  2592. $8 \sqrt{2} \tau^{7 / 2}$
  2593. >>> print(latex((2*mu)**Rational(7,2), mode='equation*'))
  2594. \begin{equation*}8 \sqrt{2} \mu^{\frac{7}{2}}\end{equation*}
  2595. >>> print(latex((2*mu)**Rational(7,2), mode='equation'))
  2596. \begin{equation}8 \sqrt{2} \mu^{\frac{7}{2}}\end{equation}
  2597. >>> print(latex((2*mu)**Rational(7,2), mode='equation', itex=True))
  2598. $$8 \sqrt{2} \mu^{\frac{7}{2}}$$
  2599. Fraction options:
  2600. >>> print(latex((2*tau)**Rational(7,2), fold_frac_powers=True))
  2601. 8 \sqrt{2} \tau^{7/2}
  2602. >>> print(latex((2*tau)**sin(Rational(7,2))))
  2603. \left(2 \tau\right)^{\sin{\left(\frac{7}{2} \right)}}
  2604. >>> print(latex((2*tau)**sin(Rational(7,2)), fold_func_brackets=True))
  2605. \left(2 \tau\right)^{\sin {\frac{7}{2}}}
  2606. >>> print(latex(3*x**2/y))
  2607. \frac{3 x^{2}}{y}
  2608. >>> print(latex(3*x**2/y, fold_short_frac=True))
  2609. 3 x^{2} / y
  2610. >>> print(latex(Integral(r, r)/2/pi, long_frac_ratio=2))
  2611. \frac{\int r\, dr}{2 \pi}
  2612. >>> print(latex(Integral(r, r)/2/pi, long_frac_ratio=0))
  2613. \frac{1}{2 \pi} \int r\, dr
  2614. Multiplication options:
  2615. >>> print(latex((2*tau)**sin(Rational(7,2)), mul_symbol="times"))
  2616. \left(2 \times \tau\right)^{\sin{\left(\frac{7}{2} \right)}}
  2617. Trig options:
  2618. >>> print(latex(asin(Rational(7,2))))
  2619. \operatorname{asin}{\left(\frac{7}{2} \right)}
  2620. >>> print(latex(asin(Rational(7,2)), inv_trig_style="full"))
  2621. \arcsin{\left(\frac{7}{2} \right)}
  2622. >>> print(latex(asin(Rational(7,2)), inv_trig_style="power"))
  2623. \sin^{-1}{\left(\frac{7}{2} \right)}
  2624. Matrix options:
  2625. >>> print(latex(Matrix(2, 1, [x, y])))
  2626. \left[\begin{matrix}x\\y\end{matrix}\right]
  2627. >>> print(latex(Matrix(2, 1, [x, y]), mat_str = "array"))
  2628. \left[\begin{array}{c}x\\y\end{array}\right]
  2629. >>> print(latex(Matrix(2, 1, [x, y]), mat_delim="("))
  2630. \left(\begin{matrix}x\\y\end{matrix}\right)
  2631. Custom printing of symbols:
  2632. >>> print(latex(x**2, symbol_names={x: 'x_i'}))
  2633. x_i^{2}
  2634. Logarithms:
  2635. >>> print(latex(log(10)))
  2636. \log{\left(10 \right)}
  2637. >>> print(latex(log(10), ln_notation=True))
  2638. \ln{\left(10 \right)}
  2639. ``latex()`` also supports the builtin container types :class:`list`,
  2640. :class:`tuple`, and :class:`dict`:
  2641. >>> print(latex([2/x, y], mode='inline'))
  2642. $\left[ 2 / x, \ y\right]$
  2643. Unsupported types are rendered as monospaced plaintext:
  2644. >>> print(latex(int))
  2645. \mathtt{\text{<class 'int'>}}
  2646. >>> print(latex("plain % text"))
  2647. \mathtt{\text{plain \% text}}
  2648. See :ref:`printer_method_example` for an example of how to override
  2649. this behavior for your own types by implementing ``_latex``.
  2650. .. versionchanged:: 1.7.0
  2651. Unsupported types no longer have their ``str`` representation treated as valid latex.
  2652. """
  2653. return LatexPrinter(settings).doprint(expr)
  2654. def print_latex(expr, **settings):
  2655. """Prints LaTeX representation of the given expression. Takes the same
  2656. settings as ``latex()``."""
  2657. print(latex(expr, **settings))
  2658. def multiline_latex(lhs, rhs, terms_per_line=1, environment="align*", use_dots=False, **settings):
  2659. r"""
  2660. This function generates a LaTeX equation with a multiline right-hand side
  2661. in an ``align*``, ``eqnarray`` or ``IEEEeqnarray`` environment.
  2662. Parameters
  2663. ==========
  2664. lhs : Expr
  2665. Left-hand side of equation
  2666. rhs : Expr
  2667. Right-hand side of equation
  2668. terms_per_line : integer, optional
  2669. Number of terms per line to print. Default is 1.
  2670. environment : "string", optional
  2671. Which LaTeX wnvironment to use for the output. Options are "align*"
  2672. (default), "eqnarray", and "IEEEeqnarray".
  2673. use_dots : boolean, optional
  2674. If ``True``, ``\\dots`` is added to the end of each line. Default is ``False``.
  2675. Examples
  2676. ========
  2677. >>> from sympy import multiline_latex, symbols, sin, cos, exp, log, I
  2678. >>> x, y, alpha = symbols('x y alpha')
  2679. >>> expr = sin(alpha*y) + exp(I*alpha) - cos(log(y))
  2680. >>> print(multiline_latex(x, expr))
  2681. \begin{align*}
  2682. x = & e^{i \alpha} \\
  2683. & + \sin{\left(\alpha y \right)} \\
  2684. & - \cos{\left(\log{\left(y \right)} \right)}
  2685. \end{align*}
  2686. Using at most two terms per line:
  2687. >>> print(multiline_latex(x, expr, 2))
  2688. \begin{align*}
  2689. x = & e^{i \alpha} + \sin{\left(\alpha y \right)} \\
  2690. & - \cos{\left(\log{\left(y \right)} \right)}
  2691. \end{align*}
  2692. Using ``eqnarray`` and dots:
  2693. >>> print(multiline_latex(x, expr, terms_per_line=2, environment="eqnarray", use_dots=True))
  2694. \begin{eqnarray}
  2695. x & = & e^{i \alpha} + \sin{\left(\alpha y \right)} \dots\nonumber\\
  2696. & & - \cos{\left(\log{\left(y \right)} \right)}
  2697. \end{eqnarray}
  2698. Using ``IEEEeqnarray``:
  2699. >>> print(multiline_latex(x, expr, environment="IEEEeqnarray"))
  2700. \begin{IEEEeqnarray}{rCl}
  2701. x & = & e^{i \alpha} \nonumber\\
  2702. & & + \sin{\left(\alpha y \right)} \nonumber\\
  2703. & & - \cos{\left(\log{\left(y \right)} \right)}
  2704. \end{IEEEeqnarray}
  2705. Notes
  2706. =====
  2707. All optional parameters from ``latex`` can also be used.
  2708. """
  2709. # Based on code from https://github.com/sympy/sympy/issues/3001
  2710. l = LatexPrinter(**settings)
  2711. if environment == "eqnarray":
  2712. result = r'\begin{eqnarray}' + '\n'
  2713. first_term = '& = &'
  2714. nonumber = r'\nonumber'
  2715. end_term = '\n\\end{eqnarray}'
  2716. doubleet = True
  2717. elif environment == "IEEEeqnarray":
  2718. result = r'\begin{IEEEeqnarray}{rCl}' + '\n'
  2719. first_term = '& = &'
  2720. nonumber = r'\nonumber'
  2721. end_term = '\n\\end{IEEEeqnarray}'
  2722. doubleet = True
  2723. elif environment == "align*":
  2724. result = r'\begin{align*}' + '\n'
  2725. first_term = '= &'
  2726. nonumber = ''
  2727. end_term = '\n\\end{align*}'
  2728. doubleet = False
  2729. else:
  2730. raise ValueError("Unknown environment: {}".format(environment))
  2731. dots = ''
  2732. if use_dots:
  2733. dots=r'\dots'
  2734. terms = rhs.as_ordered_terms()
  2735. n_terms = len(terms)
  2736. term_count = 1
  2737. for i in range(n_terms):
  2738. term = terms[i]
  2739. term_start = ''
  2740. term_end = ''
  2741. sign = '+'
  2742. if term_count > terms_per_line:
  2743. if doubleet:
  2744. term_start = '& & '
  2745. else:
  2746. term_start = '& '
  2747. term_count = 1
  2748. if term_count == terms_per_line:
  2749. # End of line
  2750. if i < n_terms-1:
  2751. # There are terms remaining
  2752. term_end = dots + nonumber + r'\\' + '\n'
  2753. else:
  2754. term_end = ''
  2755. if term.as_ordered_factors()[0] == -1:
  2756. term = -1*term
  2757. sign = r'-'
  2758. if i == 0: # beginning
  2759. if sign == '+':
  2760. sign = ''
  2761. result += r'{:s} {:s}{:s} {:s} {:s}'.format(l.doprint(lhs),
  2762. first_term, sign, l.doprint(term), term_end)
  2763. else:
  2764. result += r'{:s}{:s} {:s} {:s}'.format(term_start, sign,
  2765. l.doprint(term), term_end)
  2766. term_count += 1
  2767. result += end_term
  2768. return result