summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/tex/latex/tikz-karnaugh/tikz-karnaugh.tex
blob: ac7b8680b64d34a5af8c42819ffff751b86a3c7c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
% This is file `tikz-karnaugh.tex',
%% Version 1.0 of 22nd December, 2017
%% 
%% Copyright (C) 2017 by Luis Paulo Laus, laus@utfpr.edu.br
%%
%% This package can be redistributed and/or modified under the terms
%% of the LaTeX Project Public License distributed from CTAN
%% archives in directory macros/latex/base/lppl.txt; either
%% version 1 of the License, or (at your option) any later version,
%% with `The Package' referring to the software `tikz-karnaugh.tex' and its
%% accompanying documentation and `The Copyright Holder' referring to the
%% person Luis Paulo Laus.
%% 
%% This software is based on Andreas W. Wieland's kvmacros.tex to whom 
%% the author wished to express his gratitude.
%% 
%% IMPORTANT NOTICE: 
%% 
%% For error reports, comments or suggestions in case of UNCHANGED 
%% versions send mail to:
%% laus@utfpr.edu.br
%% 
%%
\typeout{}
\typeout{Macros for typesetting Karnaugh maps}
\typeout{Version of 22nd December, 2017}
\typeout{by Luis Paulo Laus, laus@utfpr.edu.br}
\typeout{}
%%
%% Change History:
%% 22nd December, 2017: Original Version ported from kvmacros.tex
%%
%%
%%
%% Setting up some TikZ parameters for an Karnaugh Map
%%
\tikzset{
  karnaugh/.style={
    kmbar/.style={black,|-|,thin},
    kmbar label/.style={black},
    bar sep/.style={kmbar sep={##1}},
    bar top sep/.style={kmbar top sep={##1}},
    bar left sep/.style={kmbar left sep={##1}},
    kmindex/.style={transparent},
    karnaugh index/.style={kmindex/.style={##1}},
    kmcell/.style={black},
    kmvar/.style={black},
    kmlines/.style={thin},
    every karnaugh/.try
  }
}

\pgfkeys{/pgf/.cd,
  kmbar sep/.initial=0.2\kmunitlength,
  kmbar top sep/.initial=1\kmunitlength,
  kmbar left sep/.initial=1\kmunitlength,
}

%%
%% We need a fixed dimension for a single field in a Karnaugh map
%% and also an auxiliary dimension to place de bars.
%%
\newdimen\kmunitlength
\newdimen\kmtemplength
\kmunitlength=8mm
%%
%% First, we have to introduce some counters:
%%
%% \kmrecursiondepth is used to control the recursion of the
%% \karnaughmakemap.
%%
\newcount\kmrecursiondepth
%%
%% The \kmindexcounter is needed for the indices in the fields of the
%% diagrams. 
%%
\newcount\kmindexcounter
%% 
%% \kmxsize and \kmysize store the dimensions of an entire diagram.
%%
\newcount\kmxsize
\newcount\kmysize
%%
%% Some counters are necessary to compute the marks for the variable
%% identifiers:
%%
\newcount\kmvarno
\newcount\kmxvarno
\newcount\kmyvarno
\newcount\kmmarkstart
\newcount\kmmarklength
\newcount\kmmarknum
\newcount\kmmarkmove
\newcount\kmtemppos
%%
%% And we need a box to store the variable names:
%%
\newbox\kmbox
%%
%% Single fields in a diagram should be indexed, which makes the map easier to
%% use. This is the default. If you don't want indices, simply call
%% \kmnoindex. If you want indices back, call \kmindex:
%%
\def\kmnoindex{%
\def\kmcurrentindex{}}
%%
\def\kmindex{%
  \def\kmcurrentindex{%
    \the\kmindexcounter\global\advance\kmindexcounter by 1}%
}
%%
\kmindex
%%
%% We need a macro that computes the powers of two:
%%
\def\kmpoweroftwo#1#2{{% Computes #1=2^#2, both of which have to be counters
  \ifnum#2>0 
    \global\multiply#1 by 2 
    \advance#2 by -1
    \kmpoweroftwo{#1}{#2}
  \fi}}
%%
%% The macros \kmargumentstring, \kmgetchar and \kmgetonechar are needed to
%% process the variable-length parameters in \karnaughmap:
%%
\def\kmargumentstring#1{\gdef\kmdummystring{#1{}\noexpand\end}}
%%
\def\kmgetchar{\expandafter\kmgetonechar\kmdummystring}
%%
\def\kmgetonechar#1#2\end{{#1}\gdef\kmdummystring{#2\noexpand\end}}%
%%
%% The Macro \karnaughmakemap calls itself recursively until the parameter #1
%% equals 1, whereupon it returns a single token from the list of arguments,
%% enclosed in a \makebox plus the index (if enabled) in a smaller \makebox:
%%
\def\karnaughmakemap#1#2#3#4{{%
  \kmrecursiondepth #1\relax
  \ifnum\kmrecursiondepth>1
    \divide\kmrecursiondepth by 2
    \edef\tempx{#3}
    \edef\tempy{#4}
    \kmtemppos=\tempx\relax
    \advance\kmtemppos by \kmrecursiondepth
    \edef\tempxs{\the\kmtemppos}
    \kmtemppos=\tempy\relax
    \advance\kmtemppos by \kmrecursiondepth
    \edef\tempys{\the\kmtemppos}

    \ifcase#2
%%
%% The parameter #2 of \karnaughmakemap is needed because the inner Karnaugh
%% maps need to be mirrored. This is achieved by the following case-statement,
%% which orders the inner Karnaugh maps properly:
%%
%% Case 0: top-left Karnaugh map
      \karnaughmakemap{\kmrecursiondepth}{0}{\tempx}{\tempys}%
      \karnaughmakemap{\kmrecursiondepth}{1}{\tempxs}{\tempys}%
      \karnaughmakemap{\kmrecursiondepth}{2}{\tempx}{\tempy}%
      \karnaughmakemap{\kmrecursiondepth}{3}{\tempxs}{\tempy}%
    \or
%% Case 1: top-right Karnaugh map
      \karnaughmakemap{\kmrecursiondepth}{1}{\tempxs}{\tempys}%
      \karnaughmakemap{\kmrecursiondepth}{0}{\tempx}{\tempys}%
      \karnaughmakemap{\kmrecursiondepth}{3}{\tempxs}{\tempy}%
      \karnaughmakemap{\kmrecursiondepth}{2}{\tempx}{\tempy}%
    \or
%% Case 2: bottom-left Karnaugh map
      \karnaughmakemap{\kmrecursiondepth}{2}{\tempx}{\tempy}%
      \karnaughmakemap{\kmrecursiondepth}{3}{\tempxs}{\tempy}%
      \karnaughmakemap{\kmrecursiondepth}{0}{\tempx}{\tempys}%
      \karnaughmakemap{\kmrecursiondepth}{1}{\tempxs}{\tempys}%
    \or
%% Case 3: bottom-right Karnaugh map
      \karnaughmakemap{\kmrecursiondepth}{3}{\tempxs}{\tempy}%
      \karnaughmakemap{\kmrecursiondepth}{2}{\tempx}{\tempy}%
      \karnaughmakemap{\kmrecursiondepth}{1}{\tempxs}{\tempys}%
      \karnaughmakemap{\kmrecursiondepth}{0}{\tempx}{\tempys}%
    \fi
  \else
    \node[kmcell] at (#3\kmunitlength,#4\kmunitlength){\kmgetchar};%
    \node[kmindex,shift={(-0.3\kmunitlength,0.3\kmunitlength)}] at (#3\kmunitlength,#4\kmunitlength){\kmcurrentindex};%
  \fi}}%
%%
%% \karnaughmaketopmark typesets the variable marks of a Karnaugh map that are
%% located on top of the diagram:
%%
\def\karnaughmaketopmark{%
  \kmmarkstart=1
  \kmpoweroftwo{\kmmarkstart}{\kmxvarno} % \kmymarkstart is the start 
                                % position for the \multiput
  \kmmarklength=\kmmarkstart 
  \multiply\kmmarklength by 2 % \kmmarklength is the length of a mark
  \kmmarkmove=\kmmarkstart 
  \multiply\kmmarkmove by 4 % This is the move distance for the \multiput.
  \kmmarknum=\kmxsize
  \divide\kmmarknum by \kmmarkmove % This is the number of repetitions for
                                % the \multiput.  
    %The highest-order variable mark needs a special treatment:
  \ifnum\kmmarknum=0\kmmarknum=1\divide\kmmarklength by 2\fi 
  \advance\kmmarkmove by \kmmarkstart
  \kmtemplength=\pgfkeysvalueof{/pgf/kmbar top sep}
  \multiply \kmtemplength by \kmyvarno
  \advance \kmtemplength by \pgfkeysvalueof{/pgf/kmbar sep}
  \advance \kmtemplength by \kmysize\kmunitlength
  \ifnum\kmmarknum=1
    \draw[kmbar,xshift=\kmmarkstart\kmunitlength,yshift=\kmtemplength] (0,0) --  node[above, kmbar label]{\kmgetchar} (\kmmarklength\kmunitlength,0);
  \else
    \setbox\kmbox=\hbox{\kmgetchar}
    \foreach \x in {\kmmarkstart,\kmmarkmove,...,\kmxsize}
      \draw[kmbar,xshift=\x\kmunitlength,yshift=\kmtemplength] (0,0) --  node[above, kmbar label]{\copy\kmbox} (\kmmarklength\kmunitlength,0);
  \fi
}
%%
%% \karnaughmakeleftmark typesets the variable marks of a Karnaugh map that are
%% located on the left of the diagram:
%%
\def\karnaughmakeleftmark{%
  \kmmarkstart=1
  \kmpoweroftwo{\kmmarkstart}{\kmyvarno} % \kmmarkstart is the start 
                                % position for the \multiput
  \kmmarklength=\kmmarkstart 
  \multiply\kmmarklength by 2 % \kmmarklength is the length of a mark
  \kmmarkmove=\kmmarkstart 
  \multiply\kmmarkmove by 4 % This now is the move distance for the
                              % \multiput. 
  \kmmarknum=\kmysize
  \divide\kmmarknum by \kmmarkmove % This now is the number of 
                                % repetitions for the \multiput.  
  %The highest-order variable mark needs a special treatment:
  \ifnum\kmmarknum=0\kmmarkstart=0\kmmarknum=1\divide\kmmarklength by 2\fi 
  \advance\kmmarkmove by \kmmarkstart
  \kmtemplength=-\pgfkeysvalueof{/pgf/kmbar left sep}
  \multiply \kmtemplength by \kmyvarno
  \advance \kmtemplength by -\pgfkeysvalueof{/pgf/kmbar sep}
  \ifnum\kmmarknum=1
    \draw[kmbar,yshift=\kmmarkstart\kmunitlength,xshift=\kmtemplength] (0,0) --  node[left,kmbar label]{\kmgetchar} (0,\kmmarklength\kmunitlength);
  \else
    \setbox\kmbox=\hbox{\kmgetchar}
    \foreach \y in {\kmmarkstart,\kmmarkmove,...,\kmysize}
      \draw[kmbar,yshift=\y\kmunitlength,xshift=\kmtemplength] (0,0) --  node[left,kmbar label]{\copy\kmbox} (0,\kmmarklength\kmunitlength);
  \fi
}
%% \karnaughmakemarks calls \karnaughmaketopmark or \karnaughmakeleftmark
%% depending on whether \kmvarno is odd or even.
%%
\def\karnaughmakemarks{%
  \ifnum\kmvarno>0
    \let\next=\karnaughmakemarks
    \ifodd\kmvarno % We have to make a mark at the top
      \advance\kmxvarno by -1
      \karnaughmaketopmark
    \else % We have to make a mark at the left
      \advance\kmyvarno by -1
      \karnaughmakeleftmark
    \fi
    \advance\kmvarno by -1
  \else
    \let\next=\relax
  \fi
  \next
}
%%
%% \karnaughmap is the macro that a user calls if he wants to draw a
%% Karnaugh map:  
%%
\def\karnaughmap#1#2#3#4#5{%
%%
%% #1 is the number of variables in the Karnaugh map
%% #2 is the identifier of the function
%% #3 is the list of identifiers of those variables 
%% #4 is the list of tokens that have to be written into the map
%%
  \kmvarno=#1  % \kmvarno is the total number of variables 
  \kmyvarno=#1 % \kmyvarno is the number of variable marks at the left 
  \divide\kmyvarno by 2
  \kmxvarno=#1 % \kmxvarno is the number of variable marks on top 
  \advance\kmxvarno by -\kmyvarno
  \kmxsize=1
  \kmpoweroftwo{\kmxsize}{\kmxvarno}
  \kmysize=1
  \kmpoweroftwo{\kmysize}{\kmyvarno}
  \node[kmvar,above left] at (0,\kmysize\kmunitlength){#2};%
  \foreach \x in {0,...,\kmxsize}
      \draw[kmlines] (\x\kmunitlength,0) -- (\x\kmunitlength,\kmysize\kmunitlength);
  \foreach \y in {0,...,\kmysize}
      \draw[kmlines] (0,\y\kmunitlength) -- (\kmxsize\kmunitlength,\y\kmunitlength);
  #5
  \kmargumentstring{#3}
  \karnaughmakemarks
  \pgftransformshift{\pgfpoint{0.5\kmunitlength}{0.5\kmunitlength}}
  \kmvarno=#1  % \kmvarno is the total number of variables 
  \kmindexcounter=0
  \kmargumentstring{#4}
  \karnaughmakemap{\the\kmysize}{0}{0}{0}
  \ifodd\kmvarno
    {\divide\kmxsize by 2
    \karnaughmakemap{\the\kmysize}{1}{\the\kmxsize}{0}}
  \fi
  \pgftransformreset
}%