Use \tcode for indexed type placeholders (also in math mode) #1274

jensmaurer · 2016-12-19T23:16:12Z

The canonical way to format an indexed type placeholder is now $\mcode{T}_i$. This works inside an outside a \tcode area.

Fixes #1139.

jensmaurer · 2016-12-19T23:20:09Z

"diffpdf" is mostly silent on this change, except that Ti -> $T_i$ changes are detected.

godbyk · 2016-12-20T00:10:49Z

source/macros.tex

@@ -156,6 +156,7 @@

 % Code and definitions embedded in text.
 \newcommand{\tcode}[1]{\CodeStylex{#1}}
+\newcommand{\mcode}[1]{\text{\tcode{#1}}}   % \tcode in math mode


The \text command works in non-math mode as well. You could simply adjust the definition of \tcode:

\newcommand{\tcode}[1]{\text{\CodeStylex{#1}}}

and it would work just fine in both math mode and text mode.

The only potential downside to using \text in text mode, it becomes the equivalent to \mbox. The contents of \mbox won't be split across lines. If that's a problem, we can further adjust the definition to work around this:

\newcommand{\tcode}[1]{% \ifmmode\text{\CodeStylex{#1}}\else\CodeStylex{#1}\fi }

The benefit to this approach is that it reduces the cognitive load on the author. The author can use a single macro instead of having to decide between two different macros depending on the mode they're in.

Thanks for the information.

@tkoeppe: Ok to redefine \tcode to the second form (allowing line breaks)? (In non-math-mode, we definitely want linebreaks inside \tcode.)

We actually have existing evidence that \tcode works in math mode as-is; see e.g. algorithms.tex:3665:

\bigoh{N\log(N)} comparisons, where $N = \tcode{last - first}$.

\tcode is defined as \CodeStylex, which is defined as \texttt. Maybe that does work in math mode after all.

So, we could simply use \tcode instead of \mcode everywhere, knowing (through this issue) that we can differentiate between math mode and non-math-mode with \ifmmode, as shown above, should the need ever arise. That seems the simplest solution to me.

@jensmaurer: I agree. If \tcode already works out of the box, we should just use that, never mind the name. So for example we can say $\tcode{T}_i$ rather that \tcode{T}$_i$.

@jensmaurer A tangent to nitpick the example you raised. I would write it as $N = \tcode{last} - \tcode{first}$ instead of $N = \tcode{last - first}$ so that the minus sign gets rendered as a minus sign instead of a code-style hyphen.

On a more general note, I'm happy to help with any LaTeX code or questions.

@godbyk: I don't think that's correct. There is no mathematical concept of subtracting iterators. However, we do have magic library wording that gives the (code) minus-expression meaning with the library (even if it's not defined for the actual iterator type!).

@tkoeppe Okay, your argument has swayed me. :-)

godbyk · 2016-12-20T00:13:31Z

source/templates.tex

 \end{indented}
 and
 \tcode{P}
 is a type
 \begin{indented}
-$\mathit{cv}_{2,0}$ ``pointer to $\ldots$'' $\mathit{cv}_{2,n-1}$ ``pointer to''
-$\mathit{cv}_{2,n}$ \tcode{T2},
+$\text{\cv{}}_{2,0}$ ``pointer to $\ldots$'' $\text{\cv{}}_{2,n-1}$ ``pointer to''


I don't see any benefit to typing \cv{} instead of \cv.

Partially addresses cplusplus#1139.

jensmaurer · 2016-12-20T20:33:59Z

Updated; now using \tcode everywhere.

tkoeppe · 2016-12-20T20:40:28Z

source/conversions.tex

@@ -280,16 +280,16 @@
 % NB: forbid line break between 'where' and 'cv'
 % to stop superscript j from running into
 % descender of p on the previous line.
-where~$cv_i^j$ denotes the cv-qualifiers in the cv-qualification signature of $T_j$:%
+where~$\text{\cv}_i^j$ denotes the cv-qualifiers in the cv-qualification signature of $\mcode{T}_j$:%


This commit uses \mcode which doesn't exist. do you want to retain the three separate commits? If yes, then please rearrange this so that each commit is correct on its own. Alternatively, we can squash all the commits.

Uh, sorry, I must have missed that one \mcode. Probably a rebase confusion.

And similar for Ui, Vi, and TiD; the latter becoming $\tcode{TD}_i$. Partially addresses cplusplus#1139.

jensmaurer · 2016-12-20T20:57:15Z

Each of the three patches should now be LaTeX-valid, with no traces of \mcode left.

tkoeppe · 2016-12-20T21:01:30Z

I may be missing something, but what's the change of the "cv"s about? Is that in line with what we do elsewhere? Is it related to formatting indexed types?

jensmaurer · 2016-12-20T21:10:51Z

For "cv", we use \cv and/or \cv{} elsewhere. Except that we haven't updated the uses inside math mode, yet, which this patch does. It's unrelated to indexed types except that both use math mode, and it's a fairly small drive-by fix here.

tkoeppe · 2016-12-20T23:12:12Z

source/utilities.tex

-of \tcode{reference_wrapper}, then \tcode{Vi} is \tcode{Ui::type\&},
-otherwise \tcode{Vi} is \tcode{Ui}.
+where \tcode{V1} and \tcode{V2} are determined as follows: Let $\tcode{U}_i$ be
+\tcode{decay_t<$\tcode{T}_i$>} for each $\tcode{T}_i$. If $\tcode{U}_i$ is a specialization


I'm not sure about this change. I have considered this section myself, and I deliberately didn't want to call the same type both T1 and T_1. We should consistently stick with one name (which is T1 in this case). It's OK to define new types U_i as the elements of a pack, say, but unless you say "Let T_1 be T1 and T_2 be T2", I'm concerned that this is making things less clear.

tkoeppe · 2016-12-20T23:17:13Z

source/utilities.tex

-\item \tcode{Ti} is the $i^{th}$ type in the template parameter pack \tcode{BoundArgs},
-\item \tcode{TiD} is the type \tcode{decay_t<Ti>},
+\item $\tcode{T}_i$ is the $i^{th}$ type in the template parameter pack \tcode{BoundArgs},
+\item $\tcode{TD}_i$ is the type \tcode{decay_t<$\tcode{T}_i$>},
 \item \tcode{ti} is the $i^{th}$ argument in the function parameter pack \tcode{bound_args},


I think here we would also like \tcode{t}_i for the arguments.

I'm beginning to think that this changeset is getting too large. I had already been considering each of these passages individually, and each of them requires more care and finetuning that this blanket search-and-replace approach, I think. My recommendation would be to separate the strictly non-observable changes (\tcode{T}$_i$ to $\tcode{T}_i$ ) from the rest, and revise each section separately for the more invasive changes. For example, #1251 is such a revision of one particular section.

jensmaurer · 2016-12-21T18:12:08Z

Ok, let's close this pull request then. I'll submit a fresh one that only does the non-observable changes, in particular:

\tcode{T}$_i$ to $\tcode{T}_i$
$T_i$ to $\tcode{T}_i$
The rest can then be done manually section-by-section.

jensmaurer force-pushed the b10 branch from 5dfb118 to d3e0069 Compare December 19, 2016 23:17

godbyk reviewed Dec 20, 2016

View reviewed changes

[utilities] Use $\tcode{T}_i$ for indexed types.

3b3e8e3

Partially addresses cplusplus#1139.

jensmaurer force-pushed the b10 branch from d3e0069 to a31f5cd Compare December 20, 2016 20:32

jensmaurer changed the title ~~Introduce \mcode macro and apply it for indexed type placeholders~~ Use \tcode for indexed type placeholders (also in math mode) Dec 20, 2016

tkoeppe reviewed Dec 20, 2016

View reviewed changes

jensmaurer added 2 commits December 20, 2016 21:55

Use \text{\cv}} in math mode, not \mathit.

a925ccb

Replace Ti with $\tcode{T}_i$ for proper indexes.

73d0d81

And similar for Ui, Vi, and TiD; the latter becoming $\tcode{TD}_i$. Partially addresses cplusplus#1139.

jensmaurer force-pushed the b10 branch from a31f5cd to 73d0d81 Compare December 20, 2016 20:55

tkoeppe reviewed Dec 20, 2016

View reviewed changes

jensmaurer closed this Dec 21, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use \tcode for indexed type placeholders (also in math mode) #1274

Use \tcode for indexed type placeholders (also in math mode) #1274

jensmaurer commented Dec 19, 2016

jensmaurer commented Dec 19, 2016

godbyk Dec 20, 2016

jensmaurer Dec 20, 2016

jensmaurer Dec 20, 2016 •

edited

tkoeppe Dec 20, 2016

godbyk Dec 20, 2016

tkoeppe Dec 20, 2016 •

edited

godbyk Dec 20, 2016

godbyk Dec 20, 2016

jensmaurer Dec 20, 2016

jensmaurer commented Dec 20, 2016

tkoeppe Dec 20, 2016

jensmaurer Dec 20, 2016

jensmaurer commented Dec 20, 2016

tkoeppe commented Dec 20, 2016

jensmaurer commented Dec 20, 2016

tkoeppe Dec 20, 2016

tkoeppe Dec 20, 2016

jensmaurer commented Dec 21, 2016

Use \tcode for indexed type placeholders (also in math mode) #1274

Use \tcode for indexed type placeholders (also in math mode) #1274

Conversation

jensmaurer commented Dec 19, 2016

jensmaurer commented Dec 19, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jensmaurer Dec 20, 2016 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tkoeppe Dec 20, 2016 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jensmaurer commented Dec 20, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jensmaurer commented Dec 20, 2016

tkoeppe commented Dec 20, 2016

jensmaurer commented Dec 20, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jensmaurer commented Dec 21, 2016

jensmaurer Dec 20, 2016 •

edited

tkoeppe Dec 20, 2016 •

edited