13

Please consider the following mwe:

\documentclass[tikz, margin=3mm]{standalone}
\usetikzlibrary{matrix}

\begin{document}
\begin{tikzpicture}
\matrix (m) [matrix of math nodes,
            nodes={draw, font=\footnotesize, minimum size=1em,
                   anchor=center,inner sep=0pt},
                   column sep=-\pgflinewidth,
                   row sep=-\pgflinewidth,
                   every even column/.style={column sep=2pt},
                   every even row/.style={row sep=2pt},% doesn't insert row separation
                   inner sep=1pt,
                   left delimiter={[},right delimiter={]},
             ]
{
\alpha  & \beta   & \gamma  & \delta    \\
\alpha  & \beta   & \gamma  & \delta    \\
\alpha  & \beta   & \gamma  & \delta    \\
\alpha  & \beta   & \gamma  & \delta    \\
};
\end{tikzpicture}
\end{document}

However every even column/.style={column sep=2pt}, yields the expected result, say, introducing additional column separation after each second column, the every even row/.style={row sep=2pt}, doesn't. Did I do something wrong or this is a bug in TikZ v3.1 (I've never tested this before, so I don't know if the same thing happens in v3.0.1)?

enter image description here

edit:

The same thing happens with, for example,

row 2/.style = {row sep=2pt} 

thus it might mean that every even row/.style=... and row <row number> work fine only if one wants to change some properties of cells inside row, for example, the color of nodes borders:

every even row/.style={draw red},

but not if one aims to change row separation (see @AndréC's comment below). However it is interesting, that this is possible to do in every column sep ...

Of course, the (temporary) workaround terminates each second row of the matrix with for example [2pt], but this is annoying when the matrix is huge like here.

Zarko
  • 296,517
  • If you write every even row/.style={blue} it works. Then ... – AndréC Jan 13 '19 at 14:03
  • @AndréC, it cover each second row with blue color. i expected that after each even row will be row separation 2pt as it is at columns. – Zarko Jan 13 '19 at 14:11
  • Yes, I know, my example suggests that the error may not be in the style, but in another place. Otherwise, the style would not work for the blue color either. – AndréC Jan 13 '19 at 14:12
  • 1
    The row sep option does not work with keys either row <number>, row <column number> column <column number>, every odd row – AndréC Jan 13 '19 at 16:07
  • Not related to the question: you initialized inner sep twice, the first time with 0pt and the second time with 1pt. – AndréC Jan 13 '19 at 18:09
  • 1
    @AndréC, ones for nodes, ones for matrix as whole. but might be wrong. – Zarko Jan 13 '19 at 18:18
  • Okay, so inner sep=0pt has no effect because of minimum size=1em – AndréC Jan 13 '19 at 19:55
  • @AndréC, i'm afraid that i don't understand you. make some experiments with different size of the inner sep (in nodes style definition and out of it) and add option draw after matrix of math nodes. you will see differences. – Zarko Jan 13 '19 at 21:59
  • @AndréC: the problem appears to have been fixed as a direct consequence of your bug report. Perhaps you or Henri Menke should post an answer? – Circumscribe Jan 22 '19 at 20:40
  • @Circumscribe I think Henry Menke should do it, since he is the author of the correction. – AndréC Jan 22 '19 at 21:02
  • @Circumscribe I just updated MikTeX and installed the new pgf 3.1.1, the bug is still there. Is this also the case for you? – AndréC Feb 05 '19 at 18:15
  • Yeah, It looks like this change wasn't included 3.1.1. It does work if I put this version of pgfmodulematrix.code.tex in the same directory as the .tex file. – Circumscribe Feb 05 '19 at 19:22
  • @AndréC: (Oops, I forgot to tag you. So here's another comment…) I'm not actually sure if this was ever really a bug. The documentation says "tikz/every even column: This style is used for every cell in an even column.", and it is implemented exactly like the column <m> row <n> key. It just happens to be the case that setting column sep for a cell on the first row works. It is still a useful feature though. – Circumscribe Feb 05 '19 at 19:32
  • @Circumscribe We're discussing it with Phelype Oleinik on the chat room. https://chat.stackexchange.com/transcript/message/48883061#48883061 – AndréC Feb 05 '19 at 19:36

4 Answers4

9

The issue is with scopes. In order to make sure that the style code for the current row only applies to the current row, the style code is executed inside of a scope that is local to the current row. This scope is closed prior to ending the row and adding the row separation, so the value is reverted before it is applied. The solution is to make the change to the row sep global. The key row sep stores the value in \pgfmatrixrowsep so we globally define this to be the updated value. Because this change is global, it applies to all rows going forward, so we need an every odd row key setting the row sep to zero to switch it back.

\documentclass[tikz, margin=3mm]{standalone}
\usetikzlibrary{matrix}

\begin{document}
\begin{tikzpicture}
\matrix (m) [matrix of math nodes,
            nodes={draw, font=\footnotesize, minimum size=1em,
                   anchor=center,inner sep=0pt},
                   column sep=-\pgflinewidth,
                   every even column/.style={column sep=2pt},
                   every even row/.style={/utils/exec=\gdef\pgfmatrixrowsep{2pt}},
                   every odd row/.style={/utils/exec=\gdef\pgfmatrixrowsep{-\pgflinewidth}},
                   inner sep=1pt,
                   left delimiter={[},right delimiter={]},
             ]
{
\alpha  & \beta   & \gamma  & \delta    \\
\alpha  & \beta   & \gamma  & \delta    \\
\alpha  & \beta   & \gamma  & \delta    \\
\alpha  & \beta   & \gamma  & \delta    \\
};
\end{tikzpicture}
\end{document} 

enter image description here

Zarko
  • 296,517
Hood Chatham
  • 5,467
  • thank you for explanation. are this means, that column as treated differently (not in column scope). i expected, that rows and columns should have the same approach in executing code (this can be concluded from description of these options in manual). – Zarko Jan 13 '19 at 18:28
  • 1
    i took liberty and add picture and slightly change code. thank you again (+1 at writing the first comment :-), for accepting i will wait a while) – Zarko Jan 13 '19 at 18:36
  • In the code the matrices are processed rows first and then columns. Because of this, the way the style code for a row is executed once at the beginning of the row and goes out of scope at the end of the row. The style code for a column is executed many times, once for each cell in the column. I suspect the asymmetry has something to do with this, but I don't feel like reading the code carefully enough to track down the particulars. – Hood Chatham Jan 13 '19 at 18:39
  • Anyways, the point is that the symmetry between rows and columns is an abstraction that the authors of tikz tried to create for the sake of user sanity, but it isn't perfect. – Hood Chatham Jan 13 '19 at 18:40
  • 1
    This is a nice analysis, +1 for that. Note, however, that you set these values globally, so every subsequent matrix will have it. Note also that the matrix library has means of "smuggling" values out of the group, which avoids making them global. Why this has not been used for every row I do not know. –  Jan 13 '19 at 19:16
  • 2
    I just noticed the following comment in pgfmodulematrix.code.tex (line 109): "Between rows, an extra space given by the macro \pgfmatrixrowsep is added. You can also change this value for each row by using a \gdef." So it appears that this is the intended method. It might be wise to save the original value of \pgfmatrixrowsep before the matrix and to restore it afterwards though, in light of @marmot's comment. – Circumscribe Jan 22 '19 at 09:44
7

This is more an extended comment than an answer. The comment concerns Hood Chathams proposal to make the dimensions global. Here is what happens:

\documentclass[tikz, margin=3mm]{standalone}
\usetikzlibrary{matrix}

\begin{document}
\begin{tikzpicture}
\matrix (m) [matrix of math nodes,
            nodes={draw, font=\footnotesize, minimum size=1em,
                   anchor=center,inner sep=0pt},
                   inner sep=1pt,
                   left delimiter={[},right delimiter={]},
             ]
{
\alpha  & \beta   & \gamma  & \delta    \\
\alpha  & \beta   & \gamma  & \delta    \\
\alpha  & \beta   & \gamma  & \delta    \\
\alpha  & \beta   & \gamma  & \delta    \\
};
\end{tikzpicture}

\begin{tikzpicture}
\matrix (m) [matrix of math nodes,
            nodes={draw, font=\footnotesize, minimum size=1em,
                   anchor=center,inner sep=0pt},
                   column sep=-\pgflinewidth,
                   every even column/.style={column sep=2pt},
                   every even row/.style={/utils/exec=\gdef\pgfmatrixrowsep{2pt}},
                   every odd row/.style={/utils/exec=\gdef\pgfmatrixrowsep{-\pgflinewidth}},
                   inner sep=1pt,
                   left delimiter={[},right delimiter={]},
             ]
{
\alpha  & \beta   & \gamma  & \delta    \\
\alpha  & \beta   & \gamma  & \delta    \\
\alpha  & \beta   & \gamma  & \delta    \\
\alpha  & \beta   & \gamma  & \delta    \\
};
\end{tikzpicture}

\begin{tikzpicture}
\matrix (m) [matrix of math nodes,
            nodes={draw, font=\footnotesize, minimum size=1em,
                   anchor=center,inner sep=0pt},
                   inner sep=1pt,
                   left delimiter={[},right delimiter={]},
             ]
{
\alpha  & \beta   & \gamma  & \delta    \\
\alpha  & \beta   & \gamma  & \delta    \\
\alpha  & \beta   & \gamma  & \delta    \\
\alpha  & \beta   & \gamma  & \delta    \\
};
\end{tikzpicture}

\end{document} 

enter image description here

Let me, however, stress that I really like the answer by Hood Chatham as a whole as it has a very nice explanation for why this happens. I just want add a word of caution.

Here is another proposal.

\documentclass[tikz, margin=3mm]{standalone}
\usetikzlibrary{matrix}
\begin{document}
\begin{tikzpicture}
\matrix (m) [matrix of math nodes,
            nodes={draw, font=\footnotesize, minimum size=1em,
                   anchor=center,inner sep=0pt},
                   column sep=-\pgflinewidth,
                   row sep=\ifodd\pgfmatrixcurrentrow%
                   -\pgflinewidth%
                   \else%
                   2pt%
                   \fi,
                   every even column/.style={column sep=2pt},
                   left delimiter={[},right delimiter={]},
             ]
{
\alpha  & \beta   & \gamma  & \delta    \\
\alpha  & \beta   & \gamma  & \delta    \\
\alpha  & \beta   & \gamma  & \delta    \\
\alpha  & \beta   & \gamma  & \delta    \\
};
\end{tikzpicture}
\end{document}

enter image description here

It does produce the desired output. However, it also produces warnings of the type \end occurred when \ifx on line 21 was incomplete. So I am definitely not claiming this proposal is better than Hood Chathams suggestion.

Of course, a very pragmatic solution would be to use

\documentclass[tikz, margin=3mm]{standalone}
\usetikzlibrary{matrix}

\begin{document}
\begin{tikzpicture}
\matrix (m) [matrix of math nodes,
            nodes={draw, font=\footnotesize, minimum size=1em,
                   anchor=center,inner sep=0pt},
                   column sep=-\pgflinewidth,
                   row sep=-\pgflinewidth,
                   every even column/.style={column sep=2pt},
                   inner sep=1pt,
                   left delimiter={[},right delimiter={]},
             ]
{
\alpha  & \beta   & \gamma  & \delta    \\
\alpha  & \beta   & \gamma  & \delta    \\[2pt]
\alpha  & \beta   & \gamma  & \delta    \\
\alpha  & \beta   & \gamma  & \delta    \\
};
\end{tikzpicture}
\end{document}
  • 1
    thank you for "extended comment (+1). it helps to understanding whats all is behind of using row styles. – Zarko Jan 13 '19 at 20:27
5

Remark: This problem appears to have been fixed, so your MWE should work in some future version of the matrix library.


I just wanted to briefly mention another way in which the same result could be accomplished, so you may also consider this an extended comment.

The values of row sep and column sep are actually passed into the pgf math engine when they're used, so you can assign a value that depends on the current row/column number. The following should produce the desired output:

\documentclass[tikz, margin=3mm]{standalone}
\usetikzlibrary{matrix}

\begin{document}
\begin{tikzpicture}
\matrix (m) [matrix of math nodes,
            nodes={draw, font=\footnotesize, minimum size=1em,
                   anchor=center,inner sep=0pt},
                   row sep=iseven(\pgfmatrixcurrentrow)?2pt:-\pgflinewidth,
                   column sep=iseven(\pgfmatrixcurrentcolumn)?2pt:-\pgflinewidth,
                   inner sep=1pt,
                   left delimiter={[},right delimiter={]},
             ]
{
\alpha  & \beta   & \gamma  & \delta    \\
\alpha  & \beta   & \gamma  & \delta    \\
\alpha  & \beta   & \gamma  & \delta    \\
\alpha  & \beta   & \gamma  & \delta    \\
};
\end{tikzpicture}
\end{document}

output

In case you're not familiar with it, the notation <condition>?<true branch>:<false branch> means that if <condition> is true (non-zero,actually) the <true branch> is used and that the <false branch> is used otherwise. The functions iseven and isodd (and also isprime, wow) are documented in the pgf manual (in §99.3 on p1004 in the version for TikZ 3.1).

There is actually one rather annoying limitation to this, which is due the fact that the argument of row sep is actually stripped of three pairs of braces ({…}) and then split at comma's before the math engine gets to see it (each comma-separated term is applied separately). This means that you can't use functions whose syntax includes a comma unless you wrap the entire value in at least four sets of braces ({{{{…}}}}, more is also okay), like this:

\documentclass[tikz, margin=3mm]{standalone}
\usetikzlibrary{matrix}

\begin{document}
\begin{tikzpicture}
\matrix (m) [matrix of math nodes,
            nodes={draw, font=\footnotesize, minimum size=1em,
                   anchor=center,inner sep=0pt},
                   row sep={{{{Mod(\pgfmatrixcurrentrow,3)?-\pgflinewidth:2pt}}}},
                   column sep={{{{Mod(\pgfmatrixcurrentcolumn,3)?-\pgflinewidth:2pt}}}},
                   inner sep=1pt,
                   left delimiter={[},right delimiter={]},
             ]
{
\alpha  & \beta   & \gamma  & \delta & \epsilon & \zeta & \eta   \\
\alpha  & \beta   & \gamma  & \delta & \epsilon & \zeta & \eta   \\
\alpha  & \beta   & \gamma  & \delta & \epsilon & \zeta & \eta   \\
\alpha  & \beta   & \gamma  & \delta & \epsilon & \zeta & \eta   \\
\alpha  & \beta   & \gamma  & \delta & \epsilon & \zeta & \eta   \\
\alpha  & \beta   & \gamma  & \delta & \epsilon & \zeta & \eta   \\
\alpha  & \beta   & \gamma  & \delta & \epsilon & \zeta & \eta   \\
};
\end{tikzpicture}
\end{document}

output

Circumscribe
  • 10,856
  • Thank you for sharing news about matrix report. Now we should wait for official version of the matrix library. So far i'm not able to test your solution since my MikTeX Console is down, consequently I can't update my MikTeX installation :-(. so temporary only +1, for more after my test of your solution. – Zarko Jan 22 '19 at 21:04
4

This is from a bug in the matrix library. The bug was reported in issue #504 in the PGF bug tracker.

The problem is the scope where \pgfmatrixrowsep is set (the value you pass to row sep) ends before that value is actually used.

Henri Menke submitted a fix to this issue which will be in the next release of PGF.

Meanwhile, the following patch will work:

\makeatletter
\def\pgfmatrixendrow{%
  \let\pgf@matrix@signal@cell@end=\pgf@matrix@signal@cell@end
  \pgf@matrix@last@cell@in@rowtrue%
  \xdef\pgf@matrix@rowsep{\pgfmatrixrowsep}% <-- Define \pgf@matrix@rowsep globally
  &% <-- Scope ends here
  \pgf@matrix@correct@calltrue%
  \global\pgf@matrix@fixedfalse%
  \pgf@y=0pt%
  % The previous version used \pgfmatrixrowsep, which was reset at the &
  % \pgf@matrix@addtolength\pgf@y{\pgfmatrixrowsep}
  \pgf@matrix@addtolength\pgf@y{\pgf@matrix@rowsep}% <-- Now use the global def
  \pgfutil@ifnextchar[{\pgfmatrixendrow@skip}{\pgf@matrix@finish@line}%
}%
\makeatother

MWE:

\documentclass[tikz, margin=3mm]{standalone}
\usetikzlibrary{matrix}

\makeatletter
\def\pgfmatrixendrow{%
  \let\pgf@matrix@signal@cell@end=\pgf@matrix@signal@cell@end
  \pgf@matrix@last@cell@in@rowtrue%
  \xdef\pgf@matrix@rowsep{\pgfmatrixrowsep}%
  &\pgf@matrix@correct@calltrue%
  \global\pgf@matrix@fixedfalse%
  \pgf@y=0pt%
  \pgf@matrix@addtolength\pgf@y{\pgf@matrix@rowsep}%
  \pgfutil@ifnextchar[{\pgfmatrixendrow@skip}{\pgf@matrix@finish@line}%
}%
\makeatother

\begin{document}
\begin{tikzpicture}
\matrix (m) [matrix of math nodes,
            nodes={draw, font=\footnotesize, minimum size=1em,
                   anchor=center,inner sep=0pt},
                   column sep=-\pgflinewidth,
                   row sep=-\pgflinewidth,
                   every even column/.style={column sep=2pt},
                   every even row/.style={row sep=2pt},% doesn't insert row separation
                   inner sep=1pt,
                   left delimiter={[},right delimiter={]},
             ]
{
\alpha  & \beta   & \gamma  & \delta    \\
\alpha  & \beta   & \gamma  & \delta    \\
\alpha  & \beta   & \gamma  & \delta    \\
\alpha  & \beta   & \gamma  & \delta    \\
};
\end{tikzpicture}
\end{document}