{"route":"/en-US-v0.13.1/reference/math/mat/","title":"Matrix","description":"Documentation for the `mat` function.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"example","name":"Example","children":[]},{"id":"parameters","name":"Parameters","children":[{"id":"parameters-delim","name":"delim","children":[]},{"id":"parameters-align","name":"align","children":[]},{"id":"parameters-augment","name":"augment","children":[]},{"id":"parameters-gap","name":"gap","children":[]},{"id":"parameters-row-gap","name":"row-gap","children":[]},{"id":"parameters-column-gap","name":"column-gap","children":[]},{"id":"parameters-rows","name":"rows","children":[]}]}],"body":{"kind":"func","content":{"path":["math"],"name":"mat","title":"Matrix","keywords":[],"oneliner":"A matrix.","element":true,"contextual":false,"deprecation":null,"details":"

A matrix.

\n

The elements of a row should be separated by commas, while the rows\nthemselves should be separated by semicolons. The semicolon syntax merges\npreceding arguments separated by commas into an array. You can also use this\nspecial syntax of math function calls to define custom functions that take\n2D data.

\n

Content in cells can be aligned with the align\nparameter, or content in cells that are in the same row can be aligned with\nthe & symbol.

\n

Example

\n
$ mat(\n  1, 2, ..., 10;\n  2, 2, ..., 10;\n  dots.v, dots.v, dots.down, dots.v;\n  10, 10, ..., 10;\n) $\n
\"Preview\"
","example":null,"self":false,"params":[{"name":"delim","details":"

The delimiter to use.

\n

Can be a single character specifying the left delimiter, in which case\nthe right delimiter is inferred. Otherwise, can be an array containing a\nleft and a right delimiter.

","example":"
#set math.mat(delim: "[")\n$ mat(1, 2; 3, 4) $\n
\"Preview\"
","types":["none","str","array","symbol"],"strings":[],"default":"("(", ")")","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"align","details":"

The horizontal alignment that each cell should have.

","example":"
#set math.mat(align: right)\n$ mat(-1, 1, 1; 1, -1, 1; 1, 1, -1) $\n
\"Preview\"
","types":["alignment"],"strings":[],"default":"center","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"augment","details":"

Draws augmentation lines in a matrix.

\n","example":"
$ mat(1, 0, 1; 0, 1, 2; augment: #2) $\n// Equivalent to:\n$ mat(1, 0, 1; 0, 1, 2; augment: #(-1)) $\n
\"Preview\"
$ mat(0, 0, 0; 1, 1, 1; augment: #(hline: 1, stroke: 2pt + green)) $\n
\"Preview\"
","types":["none","int","dictionary"],"strings":[],"default":"none","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"gap","details":"

The gap between rows and columns.

\n

This is a shorthand to set row-gap and column-gap to the same value.

","example":"
#set math.mat(gap: 1em)\n$ mat(1, 2; 3, 4) $\n
\"Preview\"
","types":["relative"],"strings":[],"default":"0% + 0pt","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"row-gap","details":"

The gap between rows.

","example":"
#set math.mat(row-gap: 1em)\n$ mat(1, 2; 3, 4) $\n
\"Preview\"
","types":["relative"],"strings":[],"default":"0% + 0.2em","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"column-gap","details":"

The gap between columns.

","example":"
#set math.mat(column-gap: 1em)\n$ mat(1, 2; 3, 4) $\n
\"Preview\"
","types":["relative"],"strings":[],"default":"0% + 0.5em","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"rows","details":"

An array of arrays with the rows of the matrix.

","example":"
#let data = ((1, 2, 3), (4, 5, 6))\n#let matrix = math.mat(..data)\n$ v := matrix $\n
\"Preview\"
","types":["array"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":true,"settable":false}],"returns":["content"],"scope":[]}}}