# Proper use of \mathchoice

I am trying to learn how to use \mathchoice.

Before the solution was posted for Non-invasive replacement for \fbox?, I attempted to use mathchoice to adjust the size of the parameter before measuring its height, depth and width. To simply things, I first defined:

\newcommand{\SetHeightDepthWidth}[1]{%
\settoheight{\fillbox@height}{#1}%
\settodepth{\fillbox@depth}{#1}%
\settowidth{\fillbox@width}{#1}%
}%


Then adjusted the beginning of the \fillbox macro as:

\newcommand{\fillbox}[1]{%
\ifmmode%
\mathchoice%
{\SetHeightDepthWidth{$\displaystyle#1$}}%
{\SetHeightDepthWidth{$\textstyle#1$}}%
{\SetHeightDepthWidth{$\scriptstyle#1$}}%
{\SetHeightDepthWidth{$\scriptscriptstyle#1$}}%
\else%
\SetHeightDepthWidth{#1}%
\fi%


Before these changes, the output was:

But with the above changes I get:

So, what happened? To me it appears to be some problem related to the grouping due to the extra brace groups required to pass in the four parameters to \mathchoice, but don't know how to fix it. Does \mathchoice behave differently than many of the other types of conditional macros such as \iftoggle{condition}{code if true}{code if false} from the etoolbox package?

## Code:

The new code is marked and the old code is left commented to simplify comparison.

\documentclass{article}
\usepackage{tikz}

\makeatletter
\newlength\fillbox@height%
\newlength\fillbox@depth%
\newlength\fillbox@width%
\newcommand{\SetHeightDepthWidth}[1]{%   new
\settoheight{\fillbox@height}{#1}%   new
\settodepth{\fillbox@depth}{#1}%     new
\settowidth{\fillbox@width}{#1}%     new
}%

\newcommand{\fillbox}[1]{%
\ifmmode%                                             new
\mathchoice%                                        new
{\SetHeightDepthWidth{$\displaystyle#1$}}%      new
{\SetHeightDepthWidth{$\textstyle#1$}}%         new
{\SetHeightDepthWidth{$\scriptstyle#1$}}%       new
{\SetHeightDepthWidth{$\scriptscriptstyle#1$}}% new
\else%                                                new
\SetHeightDepthWidth{#1}%                           new
\fi%                                                  new
%\ifmmode%
%  \settoheight{\fillbox@height}{$#1$}%
%  \settodepth{\fillbox@depth}{$#1$}%
%  \settowidth{\fillbox@width}{$#1$}%
%\else%
%  \settoheight{\fillbox@height}{#1}%
%  \settodepth{\fillbox@depth}{#1}%
%  \settowidth{\fillbox@width}{#1}%
%\fi%
\raisebox{-\fillbox@depth}{%
\begin{tikzpicture}[scale=1]
\pgfsetfillcolor{yellow!90!red}
\pgfsetfillopacity{0.5}
\pgfsetrectcap
\fill (0,-\fillbox@depth) rectangle (\fillbox@width,\fillbox@height);
\pgfsetfillcolor{yellow!50!black}
\pgfsetfillopacity{1}
\fill (0,-\fillbox@depth)
rectangle (\fillbox@width,-\fillbox@depth+.1pt);
\fill (0,\fillbox@height)
rectangle (\fillbox@width,\fillbox@height-.1pt);
\fill (0,-\fillbox@depth)
rectangle (.1pt,\fillbox@height);
\fill (\fillbox@width,-\fillbox@depth)
rectangle (\fillbox@width-.1pt,\fillbox@height);
\end{tikzpicture}%
\kern-\fillbox@width%
}%
#1%
}
\makeatother

\begin{document}

\vskip1em
$\fillbox{p}_{\fillbox{x}} \mathrel{\stackrel{\fillbox{_{~+}}}{\fillbox{\leftarrow}}} \fillbox{(}\fillbox{\frac{\fillbox{1}}{\fillbox{2}}}\fillbox{\cdot} \fillbox{a}_{\fillbox{x}}\fillbox{\cdot}% \fillbox{\Delta}\fillbox{t}^{\fillbox{2}}\fillbox{)} \fillbox{+} \fillbox{(}\fillbox{v}_{\fillbox{x}}\fillbox{\cdot}% \fillbox{\Delta}\fillbox{t}\fillbox{)}$\fillbox{;}\par
$\fillbox{v}_{\fillbox{x}} \mathrel{\stackrel{\fillbox{_{~+}}}{\fillbox{\leftarrow}}} \fillbox{a}_{\fillbox{x}}\fillbox{\cdot}% \fillbox{\Delta}\fillbox{t}$\fillbox{;}\par
%
%            This section is not relevant to the problem here.
%\vskip1em
%$p_x \mathrel{\stackrel{_{~+}}{\leftarrow}} % (\frac{1}{2}\cdot a_x\cdot\Delta t^2) + (v_x\cdot\Delta t)$;\par
%$v_x \mathrel{\stackrel{_{~+}}{\leftarrow}} a_x\cdot\Delta t$;\par
%
\end{document}

-
@egreg: But then if I were to change the last condition to read {\SetHeightDepthWidth{$\textstyle#1$}} then I shouldn't I get the same output as the original code? How do I use \mathchoice to make a selection then? – Peter Grill Feb 9 '12 at 17:48
You need to put the whole thing including typesetting the math and the box into the mathchoice (which I hid in amslatex \text) you can't just put the measurement in the choice. – David Carlisle Feb 9 '12 at 18:00
You can see the effect of the local setting of the lengths in your output. All the measurement in math versions are inside a group (well four groups) and discarded at end of the group, so all the lengths are zero until you get to the ; when the text mode version sets the lengths non zero but then all boxes in the second math expression use those values. Which is why only the ; is boxed in first expression and all the boxes in the second expression are the size of the ; – David Carlisle Feb 9 '12 at 18:08
@PeterGrill: I like this approach. I, too, am puzzled by why it doesn't work the way you attempted. This seems like a really good general question. – Todd Lehman Feb 10 '12 at 8:15
\mathchoice{a}{b}{c}{d} is indistinguishable from within tex from \hbox{a}\hbox{b}\hbox{c}\hbox{d} in both cases all the contents are typeset into a box 4 times, and any assignmemts happen in a local group. "Appendix G treats the 4 boxes differently when laying out the math list to make a horizontal list, but since there are no \last... operations to deconstruct the list generated in that way you can not tell that in one case teX only uses one of the boxes. – David Carlisle Feb 10 '12 at 9:31

\mathchoice acts at the end of the math list when TeX is making a horizontal list by putting the math boxes in the right places. So the "choice" happens way after you are attempting to use the lengths. (They are being set in a group and left as zero, but you can't simply make a global assignment as the timing is all wrong.)

Look at any uses of \mathchoice (or its wrapper \mathpalette) in plain or latex.ltx. The usual idiom is that you need to put the entire command including all its arguments so, using fbox for simplicity:

\def\fa#1{%
\mathchoice
{\fbox{$\displaystyle#1$}}%
{\fbox{$\textstyle#1$}}%
{\fbox{$\scriptstyle#1$}}%
{\fbox{$\scriptscriptstyle#1$}}}


would work, although usually you simplify things by defining a helper macro that takes the math style as an argument, for example in latex.ltx \smash in math mode uses this form with \mathsm@sh being a version of \smash that takes (eg) \scriptstyle as an additional argument. So something like

\def\xfb#1#2{\fbox{$#1#2$}}

\def\fb{\mathpalette\xfb}


Or you can let the AMS take care of you

\usepackage{amsmath}

\def\fc#1{\text{\fbox{$#1$}}}

-
Where would be the right place to put the \mathchoice? – Todd Lehman Feb 10 '12 at 8:21
was too long for a comment so I edited the answer. – David Carlisle Feb 10 '12 at 9:40
sorry I got the 4 branches in the \mathchoice in reverse order in my inital edit, fixed now, and extended to show \mathpalette and \text versions. – David Carlisle Feb 10 '12 at 14:53

Everything I know about \mathchoice I learned from David Carlisle's accepted answer above. He explained it wonderfully. So this answer is not an attempt to replace that answer, but to amplify it. His key phrase that triggered my light bulb was "\mathchoice{a}{b}{c}{d} is indistinguishable from within tex from \hbox{a}\hbox{b}\hbox{c}\hbox{d}" which made me understand that the macro to be typeset had to go along with the \mathchoice invocation.

Because his answer is so beautifully concise, it took a while to dawn on me how to use \mathchoice in more complicated ways. To that end, I provide the command \MS that obtains/saves the current mathstyle and executes its argument. The command \SavedMathStyle can be used in the argument to recall the math style at time of invocation.

The command \MS can be used in a nested (recursive) manner, depending on whether one wishes to reset the saved math style at some midpoint in the argument to the outer invocation. The key feature of this solution is that, within the argument, the macro \SavedMathStyle will recall the math style associated with that level of nesting invocation. To make the point even more emphatic, I create an example wherein I place material inside a box in math mode, where clearly the original math style would otherwise be lost.

\documentclass{article}
\usepackage{graphicx}
\makeatletter
\def\@mstyleD{\displaystyle}
\def\@mstyleT{\textstyle}
\def\@mstyleS{\scriptstyle}
\def\@mstyles{\scriptscriptstyle}
%
\def\SavedMathStyle{\csname @mstyle\m@switch\endcsname}
%
\newcommand\MS[1]{\mathchoice%
{\edef\m@switch{D}#1}%
{\edef\m@switch{T}#1}%
{\edef\m@switch{S}#1}%
{\edef\m@switch{s}#1}%
}
%
% A SAMPLE COMMAND
\newcommand\mycmd[2]{\SavedMathStyle#2+\fbox{$\SavedMathStyle\frac{#1}{1+#2}$}}
%
\makeatother
\begin{document}

Inline $$\MS{\mycmd{x}{z}}$$ test

displaystyle test$\MS{\mycmd{x}{z}}$

Recursive test (resetting mathstyle):$\MS{\mycmd{\MS{\mycmd{x}{z}}}{y}}$

Remaining examples keep original mathstyle throughout recursion.

Recursive test:$\MS{\mycmd{\mycmd{x}{z}}{y}}$

scriptsize test:$x_{\MS{\mycmd{\mycmd{x}{z}}{y}}}$

scriptscriptsize test:$x_{y_{\MS{\mycmd{\mycmd{x}{z}}{y}}}}$

Inline $$\MS{\mycmd{\mycmd{x}{z}}{y}}$$ test

\end{document}


As a follow up, I would like to address Peter Grill's concerns. First, I will say that I have (as of today) adopted this approach in V1.5 of the scalerel package, because using the mathstyle package was causing incompatibilities ((Nonfatal but Symptomatic) Conflict of amsmath and mathstyle Packages). In the scalerel implementation, the invoking command has been named \ThisStyle and the recall command is named \SavedStyle (so I'm sorry for the nomenclature change through the course of this question). The following example

\documentclass{article}
\usepackage{scalerel}
\begin{document}

$\ThisStyle{ \frac{x}{y}\scriptstyle \ThisStyle{\left( \frac{y}{z}\SavedStyle\frac{y}{z} \right)} \SavedStyle\frac{p}{q} }$

\end{document}


shows this result

What we see is that the outer invocation of \ThisStyle was made in \displaystyle and the inner invocation in \scriptstyle. Within the inner invocation, \SavedStyle deploys \scriptstyle and in the outer invocation, it deploys \displaystyle, even after the nested invocation in a different style.

-
I somehow feel as if this is going to have an issue with nested usage. I think that your example above works because \fbox{} created a grouping for you, and hence the redefinition of math style was kept local to that group. But I am not an expert on this subject, so perhaps there is no issue. – Peter Grill May 16 '13 at 23:09
I'll keep an eye on it, and play with it more. Thanks for the tip. And actually, my description may need to be restated. \SavedMathStyle won't use the "most recently" saved change, but the one associated with that particular level of invocation – Steven B. Segletes May 17 '13 at 9:51
@PeterGrill With 1.5 years of reflection on your comment, the only negative side effect of "nested usage" that I've found is speed. If you nest 3 \mathchoice`es, it requires 4^3 boxes to be made in the process of selecting the proper one. – Steven B. Segletes Jan 14 '15 at 11:29
{"extraction_info": {"found_math": true, "script_math_tex": 0, "script_math_asciimath": 0, "math_annotations": 0, "math_alttext": 0, "mathml": 0, "mathjax_tag": 0, "mathjax_inline_tex": 2, "mathjax_display_tex": 1, "mathjax_asciimath": 1, "img_math": 0, "codecogs_latex": 0, "wp_latex": 0, "mimetex.cgi": 0, "/images/math/codecogs": 0, "mathtex.cgi": 0, "katex": 0, "math-container": 0, "wp-katex-eq": 0, "align": 0, "equation": 0, "x-ck12": 0, "texerror": 0, "math_score": 0.8880560398101807, "perplexity": 1708.2625704655304}, "config": {"markdown_headings": true, "markdown_code": true, "boilerplate_config": {"ratio_threshold": 0.3, "absolute_threshold": 10, "end_threshold": 15, "enable": true}, "remove_buttons": true, "remove_image_figures": true, "remove_link_clusters": true, "table_config": {"min_rows": 2, "min_cols": 3, "format": "plain"}, "remove_chinese": true, "remove_edit_buttons": true, "extract_latex": true}, "warc_path": "s3://commoncrawl/crawl-data/CC-MAIN-2016-07/segments/1454701148834.81/warc/CC-MAIN-20160205193908-00048-ip-10-236-182-209.ec2.internal.warc.gz"}