Universe

karnaugh-express is a Typst package for creating highly customizable Karnaugh maps.

Overview

The karnaugh function takes two necessary arguments: variables and values. The parameter terms is optional and lets you select cells in the Karnaugh map without the hassle of specifying coordinates:

import "@preview/karnaugh-express:0.1.0": *

#karnaugh(
  ("d", "c", "b", "a"),
  (1, 0, 0, 1, 1, 0, 0, 1, 1, 0, 0, 1, 1, 0, 0, 1),
  terms: ("!b, !a", "a, b")
)
A 4x4 Karnaugh map for variables d, c, b, and a. It shows blue highlights on the four corners and a green highlight on the central 2x2 square.

Placement of the Values

Values are automatically placed so that you can read them directly from a truth table. Take the following table:

a b c position
0 0 0 0
0 0 1 1
0 1 0 2
0 1 1 3
1 0 0 4
1 0 1 5
1 1 0 6
1 1 1 7 
import "@preview/karnaugh-express:0.1.0": *

#karnaugh(
  ("a", "b", "c"),
  (0, 1, 2, 3, 4, 5, 6, 7),
  arrangement-standard: 1
)
A 2x4 Karnaugh map for variables a, b, and c. Each cell contains its corresponding decimal index (0 through 7) to demonstrate how values from a truth table are mapped to the grid.

Arranging Variables on the Axis

1. Standard Arrangement

There are different ways of arranging variables on a Karnaugh map. One is the standard layout shown in the first image. karnaugh-express supports two standard layouts that can be selected with the arrangement-standard argument.

arrangement-standard: 0 is used in the first image. arrangement-standard: 1 looks like this:

import "@preview/karnaugh-express:0.1.0": *

#karnaugh(
  ("a", "b", "c", "d"),
  (1, 0, 0, 1, 1, 0, 0, 1, 1, 0, 0, 1, 1, 0, 0, 1),
  arrangement-standard: 1,
  terms: ("!b, !a", "a, b")
)
A 4x4 Karnaugh map for variables a, b, c, and d using arrangement-standard: 1. The vertical bars are now named after the first two variables and the horizontal bars are named after the last two variables.

2. Custom Arrangement

You can also specify a completely custom arrangement. Just provide an arrangement parameter as an array of two arrays. The first array contains the row axis variables, and the second array contains the column axis variables:

import "@preview/karnaugh-express:0.1.0": *

#karnaugh(
  ("a", "b", "c", "d"),
  (1, 0, 0, 1, 1, 0, 0, 1, 1, 0, 0, 1, 1, 0, 0, 1),
  arrangement: (("a",), ("b", "d", "c")),
  terms: ("!b, !a", "a, b")
)
A 2x8 Karnaugh map demonstrating a custom arrangement where variable a is on the vertical bar and b, d, c are on the horizontal bars.

Terms

To select cells in the K-map, you need to pass the terms parameter, which is an array of strings. Each element of the array represents a separate term. In the string, you need to separate each literal with a comma (,). If the variable should be 0, put an exclamation mark (!) before the variable.

Display Variables

Because the variables you pass into the karnaugh function fulfill a functional purpose (used to specify which cells should be highlighted), they cannot be passed in math mode. This is what the var-disp parameter is for. Just create a second array detailing how you want each variable to be displayed, in the exact same order as your functional variables:

import "@preview/karnaugh-express:0.1.0": *

#karnaugh(
  ("a", "b", "c", "d"),
  (),
  var-disp: ($x_1$, $x_2$, $x_3$, $x_4$)
)
The grid is arranged in the same way as the first example. However, the bars are no longer labeled a, b, c, d but instead x_1, x_2, x_3 and x_4 in math-mode.

Other Parameters

Parameter Default Type Explanation
arrangement Calculated ((string,), (string,)) Explained above
arrangement-standard 0 1 or 0 Explained above
terms ("",) (string,) Explained above
var-disp Same as variables (content,) Explained above
stroke 0.5pt length The width of all lines
grid-size 0.8cm length The size of the grid cells
draw-subscripts true bool Turns the cell index subscripts on or off
transparency 70% ratio Determines the transparency of the cell highlight colors
colors (blue, green, yellow, purple, red) (color,) The colors used for cell selection. The package loops through them.
default-fill "" string When some values aren’t provided, cells will be filled with this placeholder
value-size 1em relative length Font size of the values
subscript-size 0.6em relative length Font size of the subscripts
distance-subscript-corner 0.05 length Distance from the corner of the grid to the subscripts
distance-bar-grid 0.3 length Distance from one bar to the other
distance-bar-letter 0.1 length Distance from the letters (variables) to the bars
small-bar-len 0.1 length The length of the small lines (or half of it)
label Calculated content The “title” of the map. Use none if you want no label.
label-position (0.2, 0.2) (length, length) The position of the label relative to the upper left corner of the grid