{"route":"/en-US-v0.13.1/reference/math/vec/","title":"Vector","description":"Documentation for the `vec` 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-gap","name":"gap","children":[]},{"id":"parameters-children","name":"children","children":[]}]}],"body":{"kind":"func","content":{"path":["math"],"name":"vec","title":"Vector","keywords":[],"oneliner":"A column vector.","element":true,"contextual":false,"deprecation":null,"details":"<p>A column vector.</p>\n<p>Content in the vector's elements can be aligned with the\n<a href=\"/en-US-v0.13.1/reference/math/vec/#parameters-align\"><code>align</code></a> parameter, or the <code>&amp;</code> symbol.</p>\n<h2 id=\"example\">Example</h2>\n<div class=\"previewed-code\"><pre><code><span class=\"typ-math-delim\">$</span> <span class=\"typ-func\">vec</span><span class=\"typ-punct\">(</span>a<span class=\"typ-punct\">,</span> b<span class=\"typ-punct\">,</span> c<span class=\"typ-punct\">)</span> <span class=\"typ-pol\">dot</span> <span class=\"typ-func\">vec</span><span class=\"typ-punct\">(</span>1<span class=\"typ-punct\">,</span> 2<span class=\"typ-punct\">,</span> 3<span class=\"typ-punct\">)</span>\n    = a + 2b + 3c <span class=\"typ-math-delim\">$</span>\n</code></pre><div class=\"preview\"><img src=\"/en-US-v0.13.1/assets/2e7466d3a94b320803f1f09065d03ae9.png\" alt=\"Preview\"></div></div>","example":null,"self":false,"params":[{"name":"delim","details":"<p>The delimiter to use.</p>\n<p>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.</p>","example":"<div class=\"previewed-code\"><pre><code><span class=\"typ-key\">#</span><span class=\"typ-key\">set</span> math<span class=\"typ-punct\">.</span><span class=\"typ-func\">vec</span><span class=\"typ-punct\">(</span>delim<span class=\"typ-punct\">:</span> <span class=\"typ-str\">&quot;[&quot;</span><span class=\"typ-punct\">)</span>\n<span class=\"typ-math-delim\">$</span> <span class=\"typ-func\">vec</span><span class=\"typ-punct\">(</span>1<span class=\"typ-punct\">,</span> 2<span class=\"typ-punct\">)</span> <span class=\"typ-math-delim\">$</span>\n</code></pre><div class=\"preview\"><img src=\"/en-US-v0.13.1/assets/e4b15927d776e5b9635c5a7a90044772.png\" alt=\"Preview\"></div></div>","types":["none","str","array","symbol"],"strings":[],"default":"<code><span class=\"typ-punct\">(</span><span class=\"typ-str\">&quot;(&quot;</span><span class=\"typ-punct\">,</span> <span class=\"typ-str\">&quot;)&quot;</span><span class=\"typ-punct\">)</span></code>","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"align","details":"<p>The horizontal alignment that each element should have.</p>","example":"<div class=\"previewed-code\"><pre><code><span class=\"typ-key\">#</span><span class=\"typ-key\">set</span> math<span class=\"typ-punct\">.</span><span class=\"typ-func\">vec</span><span class=\"typ-punct\">(</span>align<span class=\"typ-punct\">:</span> right<span class=\"typ-punct\">)</span>\n<span class=\"typ-math-delim\">$</span> <span class=\"typ-func\">vec</span><span class=\"typ-punct\">(</span><span class=\"typ-escape\">-</span>1<span class=\"typ-punct\">,</span> 1<span class=\"typ-punct\">,</span> <span class=\"typ-escape\">-</span>1<span class=\"typ-punct\">)</span> <span class=\"typ-math-delim\">$</span>\n</code></pre><div class=\"preview\"><img src=\"/en-US-v0.13.1/assets/66d1e5a7d638cc4b73e7761d7f9ba72c.png\" alt=\"Preview\"></div></div>","types":["alignment"],"strings":[],"default":"<code>center</code>","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"gap","details":"<p>The gap between elements.</p>","example":"<div class=\"previewed-code\"><pre><code><span class=\"typ-key\">#</span><span class=\"typ-key\">set</span> math<span class=\"typ-punct\">.</span><span class=\"typ-func\">vec</span><span class=\"typ-punct\">(</span>gap<span class=\"typ-punct\">:</span> <span class=\"typ-num\">1em</span><span class=\"typ-punct\">)</span>\n<span class=\"typ-math-delim\">$</span> <span class=\"typ-func\">vec</span><span class=\"typ-punct\">(</span>1<span class=\"typ-punct\">,</span> 2<span class=\"typ-punct\">)</span> <span class=\"typ-math-delim\">$</span>\n</code></pre><div class=\"preview\"><img src=\"/en-US-v0.13.1/assets/ba22b66d050a8c8cdc3b7206a7b4593f.png\" alt=\"Preview\"></div></div>","types":["relative"],"strings":[],"default":"<code><span class=\"typ-num\">0%</span> <span class=\"typ-op\">+</span> <span class=\"typ-num\">0.2em</span></code>","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"children","details":"<p>The elements of the vector.</p>","example":null,"types":["content"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":true,"settable":false}],"returns":["content"],"scope":[]}}}