bash-hackers-wiki/syntax/ccmd/classic_for/index.html

88 lines
60 KiB
HTML
Raw Permalink Normal View History

<!doctype html><html lang=en class=no-js> <head><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1"><link href=https://flokoe.github.io/bash-hackers-wiki/syntax/ccmd/classic_for/ rel=canonical><link href=../case/ rel=prev><link href=../conditional_expression/ rel=next><link rel=icon href=../../../assets/images/favicon.png><meta name=generator content="mkdocs-1.6.1, mkdocs-material-9.5.44"><title>The classic for-loop - The Bash Hackers Wiki</title><link rel=stylesheet href=../../../assets/stylesheets/main.0253249f.min.css><link rel=stylesheet href=../../../assets/stylesheets/palette.06af60db.min.css><link rel=preconnect href=https://fonts.gstatic.com crossorigin><link rel=stylesheet href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback"><style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style><script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script></head> <body dir=ltr data-md-color-scheme=default data-md-color-primary=indigo data-md-color-accent=indigo> <input class=md-toggle data-md-toggle=drawer type=checkbox id=__drawer autocomplete=off> <input class=md-toggle data-md-toggle=search type=checkbox id=__search autocomplete=off> <label class=md-overlay for=__drawer></label> <div data-md-component=skip> <a href=#the-classic-for-loop class=md-skip> Skip to content </a> </div> <div data-md-component=announce> </div> <header class=md-header data-md-component=header> <nav class="md-header__inner md-grid" aria-label=Header> <a href=../../.. title="The Bash Hackers Wiki" class="md-header__button md-logo" aria-label="The Bash Hackers Wiki" data-md-component=logo> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg> </a> <label class="md-header__button md-icon" for=__drawer> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg> </label> <div class=md-header__title data-md-component=header-title> <div class=md-header__ellipsis> <div class=md-header__topic> <span class=md-ellipsis> The Bash Hackers Wiki </span> </div> <div class=md-header__topic data-md-component=header-topic> <span class=md-ellipsis> The classic for-loop </span> </div> </div> </div> <form class=md-header__option data-md-component=palette> <input class=md-option data-md-color-media data-md-color-scheme=default data-md-color-primary=indigo data-md-color-accent=indigo aria-label="Switch to dark mode" type=radio name=__palette id=__palette_0> <label class="md-header__button md-icon" title="Switch to dark mode" for=__palette_1 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg> </label> <input class=md-option data-md-color-media data-md-color-scheme=slate data-md-color-primary=indigo data-md-color-accent=indigo aria-label="Switch to light mode" type=radio name=__palette id=__palette_1> <label class="md-header__button md-icon" title="Switch to light mode" for=__palette_0 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg> </label> </form> <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var
&lt;LIST&gt;
done
for &lt;NAME&gt; in &lt;WORDS&gt;; do
&lt;LIST&gt;
done
</code></pre></div> <p>alternative, historical and undocumented syntax <sup id=fnref:1><a class=footnote-ref href=#fn:1>1</a></sup></p> <div class=highlight><pre><span></span><code>for &lt;NAME&gt;; {
&lt;LIST&gt;
}
for &lt;NAME&gt; in &lt;WORDS&gt;; {
&lt;LIST&gt;
}
</code></pre></div> <h2 id=description>Description<a class=headerlink href=#description title="Permanent link">&para;</a></h2> <p>For every word in <code>&lt;WORDS&gt;</code>, one iteration of the loop is performed and the variable <code>&lt;NAME&gt;</code> is set to the current word. If no "<code>in &lt;WORDS&gt;</code>" is present to give an own word-list, then the positional parameters (<code>"$@"</code>) are used (the arguments to the script or function). In this case (and only in this case), the semicolon between the variable name and the <code>do</code> is optional.</p> <p>If you use the loop-variable inside the for-loop and it can contain spaces, you need to quote it, since normal word-splitting procedures apply.</p> <p>:!: Like all loops (both <code>for</code>-loops, <code>while</code> and <code>until</code>), this loop can be</p> <ul> <li>terminated (broken) by the <code>break</code> command, optionally as <code>break N</code> to break <code>N</code> levels of nested loops</li> <li>forced to immediately do the next iteration using the <code>continue</code> command, optionally as <code>continue N</code> analog to <code>break N</code></li> </ul> <p>Bash knows an alternative syntax for the <code>for</code> loop, enclosing the loop body in <code>{...}</code> instead of <code>do ... done</code>:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=k>for</span><span class=w> </span>x<span class=w> </span><span class=k>in</span><span class=w> </span><span class=m>1</span><span class=w> </span><span class=m>2</span><span class=w> </span><span class=m>3</span>
<a id=__codelineno-0-2 name=__codelineno-0-2 href=#__codelineno-0-2></a><span class=o>{</span>
<a id=__codelineno-0-3 name=__codelineno-0-3 href=#__codelineno-0-3></a><span class=w> </span><span class=nb>echo</span><span class=w> </span><span class=nv>$x</span>
<a id=__codelineno-0-4 name=__codelineno-0-4 href=#__codelineno-0-4></a><span class=o>}</span>
</code></pre></div> <p>This syntax is <strong>not documented</strong> and should not be used. I found the parser definitions for it in 1.x code, and in modern 4.x code. My guess is that it's there for compatiblity reasons. This syntax is not specified by POSIX&reg;.</p> <h3 id=return-status>Return status<a class=headerlink href=#return-status title="Permanent link">&para;</a></h3> <p>The return status is the one of the last command executed in <code>&lt;LIST&gt;</code> or <code>0</code> (<code>TRUE</code>), if the item list <code>&lt;WORDS&gt;</code> evaluates to nothing (i.e.: "is empty"!).</p> <h2 id=examples>Examples<a class=headerlink href=#examples title="Permanent link">&para;</a></h2> <h3 id=iterate-over-array-elements>Iterate over array elements<a class=headerlink href=#iterate-over-array-elements title="Permanent link">&para;</a></h3> <p>With some array syntax (see <a href=../../arrays/ >arrays</a>) you can easily "feed" the for-loop to iterate over all elements in an array (by mass-expanding all elements):</p> <div class=highlight><pre><span></span><code><a id=__codelineno-1-1 name=__codelineno-1-1 href=#__codelineno-1-1></a><span class=k>for</span><span class=w> </span>element<span class=w> </span><span class=k>in</span><span class=w> </span><span class=s2>&quot;</span><span class=si>${</span><span class=nv>myarray</span><span class=p>[@]</span><span class=si>}</span><span class=s2>&quot;</span><span class=p>;</span><span class=w> </span><span class=k>do</span>
<a id=__codelineno-1-2 name=__codelineno-1-2 href=#__codelineno-1-2></a><span class=w> </span><span class=nb>echo</span><span class=w> </span><span class=s2>&quot;Element: </span><span class=nv>$element</span><span class=s2>&quot;</span>
<a id=__codelineno-1-3 name=__codelineno-1-3 href=#__codelineno-1-3></a><span class=k>done</span>
</code></pre></div> <p>Another way is to mass-expand all used indexes and access the array by index:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-2-1 name=__codelineno-2-1 href=#__codelineno-2-1></a><span class=k>for</span><span class=w> </span>index<span class=w> </span><span class=k>in</span><span class=w> </span><span class=s2>&quot;</span><span class=si>${</span><span class=p>!myarray[@]</span><span class=si>}</span><span class=s2>&quot;</span><span class=p>;</span><span class=w> </span><span class=k>do</span>
<a id=__codelineno-2-2 name=__codelineno-2-2 href=#__codelineno-2-2></a><span class=w> </span><span class=nb>echo</span><span class=w> </span><span class=s2>&quot;Element[</span><span class=nv>$index</span><span class=s2>]: </span><span class=si>${</span><span class=nv>myarray</span><span class=p>[</span><span class=nv>$index</span><span class=p>]</span><span class=si>}</span><span class=s2>&quot;</span>
<a id=__codelineno-2-3 name=__codelineno-2-3 href=#__codelineno-2-3></a><span class=k>done</span>
</code></pre></div> <h3 id=list-positional-parameters>List positional parameters<a class=headerlink href=#list-positional-parameters title="Permanent link">&para;</a></h3> <p>You can use this <a href=../../basicgrammar/#shell_function_definitions>function</a> to test how arguments to a command will be interpreted and parsed, and finally used:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-3-1 name=__codelineno-3-1 href=#__codelineno-3-1></a>argtest<span class=o>()</span><span class=w> </span><span class=o>{</span>
<a id=__codelineno-3-2 name=__codelineno-3-2 href=#__codelineno-3-2></a><span class=w> </span><span class=nv>n</span><span class=o>=</span><span class=m>1</span>
<a id=__codelineno-3-3 name=__codelineno-3-3 href=#__codelineno-3-3></a><span class=w> </span><span class=k>for</span><span class=w> </span>arg<span class=p>;</span><span class=w> </span><span class=k>do</span>
<a id=__codelineno-3-4 name=__codelineno-3-4 href=#__codelineno-3-4></a><span class=w> </span><span class=nb>echo</span><span class=w> </span><span class=s2>&quot;Argument </span><span class=k>$((</span><span class=nv>n</span><span class=o>++</span><span class=k>))</span><span class=s2>: \&quot;</span><span class=nv>$arg</span><span class=s2>\&quot;&quot;</span>
<a id=__codelineno-3-5 name=__codelineno-3-5 href=#__codelineno-3-5></a><span class=w> </span><span class=k>done</span>
<a id=__codelineno-3-6 name=__codelineno-3-6 href=#__codelineno-3-6></a><span class=o>}</span>
</code></pre></div> <h3 id=loop-through-a-directory>Loop through a directory<a class=headerlink href=#loop-through-a-directory title="Permanent link">&para;</a></h3> <p>Since pathname expansion will expand all filenames to separate words, regardless of spaces, you can use the for-loop to iterate through filenames in a directory:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-4-1 name=__codelineno-4-1 href=#__codelineno-4-1></a><span class=k>for</span><span class=w> </span>fn<span class=w> </span><span class=k>in</span><span class=w> </span>*<span class=p>;</span><span class=w> </span><span class=k>do</span>
<a id=__codelineno-4-2 name=__codelineno-4-2 href=#__codelineno-4-2></a><span class=w> </span><span class=k>if</span><span class=w> </span><span class=o>[</span><span class=w> </span>-h<span class=w> </span><span class=s2>&quot;</span><span class=nv>$fn</span><span class=s2>&quot;</span><span class=w> </span><span class=o>]</span><span class=p>;</span><span class=w> </span><span class=k>then</span>
<a id=__codelineno-4-3 name=__codelineno-4-3 href=#__codelineno-4-3></a><span class=w> </span><span class=nb>echo</span><span class=w> </span>-n<span class=w> </span><span class=s2>&quot;Symlink: &quot;</span>
<a id=__codelineno-4-4 name=__codelineno-4-4 href=#__codelineno-4-4></a><span class=w> </span><span class=k>elif</span><span class=w> </span><span class=o>[</span><span class=w> </span>-d<span class=w> </span><span class=s2>&quot;</span><span class=nv>$fn</span><span class=s2>&quot;</span><span class=w> </span><span class=o>]</span><span class=p>;</span><span class=w> </span><span class=k>then</span>
<a id=__codelineno-4-5 name=__codelineno-4-5 href=#__codelineno-4-5></a><span class=w> </span><span class=nb>echo</span><span class=w> </span>-n<span class=w> </span><span class=s2>&quot;Dir: &quot;</span>
<a id=__codelineno-4-6 name=__codelineno-4-6 href=#__codelineno-4-6></a><span class=w> </span><span class=k>elif</span><span class=w> </span><span class=o>[</span><span class=w> </span>-f<span class=w> </span><span class=s2>&quot;</span><span class=nv>$fn</span><span class=s2>&quot;</span><span class=w> </span><span class=o>]</span><span class=p>;</span><span class=w> </span><span class=k>then</span>
<a id=__codelineno-4-7 name=__codelineno-4-7 href=#__codelineno-4-7></a><span class=w> </span><span class=nb>echo</span><span class=w> </span>-n<span class=w> </span><span class=s2>&quot;File: &quot;</span>
<a id=__codelineno-4-8 name=__codelineno-4-8 href=#__codelineno-4-8></a><span class=w> </span><span class=k>else</span>
<a id=__codelineno-4-9 name=__codelineno-4-9 href=#__codelineno-4-9></a><span class=w> </span><span class=nb>echo</span><span class=w> </span>-n<span class=w> </span><span class=s2>&quot;Unknown: &quot;</span>
<a id=__codelineno-4-10 name=__codelineno-4-10 href=#__codelineno-4-10></a><span class=w> </span><span class=k>fi</span>
<a id=__codelineno-4-11 name=__codelineno-4-11 href=#__codelineno-4-11></a><span class=w> </span><span class=nb>echo</span><span class=w> </span><span class=s2>&quot;</span><span class=nv>$fn</span><span class=s2>&quot;</span>
<a id=__codelineno-4-12 name=__codelineno-4-12 href=#__codelineno-4-12></a><span class=k>done</span>
</code></pre></div> <p>Stupid example, I know ;-)</p> <h3 id=loop-over-lines-of-output>Loop over lines of output<a class=headerlink href=#loop-over-lines-of-output title="Permanent link">&para;</a></h3> <p>To be complete: You can change the internal field separator (IFS) to a newline and thus make a for-loop iterating over lines instead of words:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-5-1 name=__codelineno-5-1 href=#__codelineno-5-1></a><span class=nv>IFS</span><span class=o>=</span><span class=s1>$&#39;\n&#39;</span>
<a id=__codelineno-5-2 name=__codelineno-5-2 href=#__codelineno-5-2></a><span class=k>for</span><span class=w> </span>f<span class=w> </span><span class=k>in</span><span class=w> </span><span class=k>$(</span>ls<span class=k>)</span><span class=p>;</span><span class=w> </span><span class=k>do</span>
<a id=__codelineno-5-3 name=__codelineno-5-3 href=#__codelineno-5-3></a><span class=w> </span><span class=nb>echo</span><span class=w> </span><span class=nv>$f</span>
<a id=__codelineno-5-4 name=__codelineno-5-4 href=#__codelineno-5-4></a><span class=k>done</span>
</code></pre></div> <p>This is just an example. In <em>general</em></p> <ul> <li>it's not a good idea to parse <code>ls(1)</code> output</li> <li>the <a href=../while_loop/ >while loop</a> (using the <code>read</code> command) is a better joice to iterate over lines</li> </ul> <h3 id=nested-for-loops>Nested for-loops<a class=headerlink href=#nested-for-loops title="Permanent link">&para;</a></h3> <p>It's of course possible to use another for-loop as <code>&lt;LIST&gt;</code>. Here, counting from 0 to 99 in a weird way:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-6-1 name=__codelineno-6-1 href=#__codelineno-6-1></a><span class=k>for</span><span class=w> </span>x<span class=w> </span><span class=k>in</span><span class=w> </span><span class=m>0</span><span class=w> </span><span class=m>1</span><span class=w> </span><span class=m>2</span><span class=w> </span><span class=m>3</span><span class=w> </span><span class=m>4</span><span class=w> </span><span class=m>5</span><span class=w> </span><span class=m>6</span><span class=w> </span><span class=m>7</span><span class=w> </span><span class=m>8</span><span class=w> </span><span class=m>9</span><span class=p>;</span><span class=w> </span><span class=k>do</span>
<a id=__codelineno-6-2 name=__codelineno-6-2 href=#__codelineno-6-2></a><span class=w> </span><span class=k>for</span><span class=w> </span>y<span class=w> </span><span class=k>in</span><span class=w> </span><span class=m>0</span><span class=w> </span><span class=m>1</span><span class=w> </span><span class=m>2</span><span class=w> </span><span class=m>3</span><span class=w> </span><span class=m>4</span><span class=w> </span><span class=m>5</span><span class=w> </span><span class=m>6</span><span class=w> </span><span class=m>7</span><span class=w> </span><span class=m>8</span><span class=w> </span><span class=m>9</span><span class=p>;</span><span class=w> </span><span class=k>do</span>
<a id=__codelineno-6-3 name=__codelineno-6-3 href=#__codelineno-6-3></a><span class=w> </span><span class=nb>echo</span><span class=w> </span><span class=nv>$x$y</span>
<a id=__codelineno-6-4 name=__codelineno-6-4 href=#__codelineno-6-4></a><span class=w> </span><span class=k>done</span>
<a id=__codelineno-6-5 name=__codelineno-6-5 href=#__codelineno-6-5></a><span class=k>done</span>
</code></pre></div> <h3 id=loop-over-a-number-range>Loop over a number range<a class=headerlink href=#loop-over-a-number-range title="Permanent link">&para;</a></h3> <p>Beginning in Bash 4, you can also use "sequence expression" form of <a href=../../expansion/brace/ >brace expansion</a> syntax when looping over numbers, and this form does not create leading zeroes unless you ask for them:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-7-1 name=__codelineno-7-1 href=#__codelineno-7-1></a><span class=c1># 100 numbers, no leading zeroes</span>
<a id=__codelineno-7-2 name=__codelineno-7-2 href=#__codelineno-7-2></a><span class=k>for</span><span class=w> </span>x<span class=w> </span><span class=k>in</span><span class=w> </span><span class=o>{</span><span class=m>0</span>..99<span class=o>}</span><span class=p>;</span><span class=w> </span><span class=k>do</span>
<a id=__codelineno-7-3 name=__codelineno-7-3 href=#__codelineno-7-3></a><span class=w> </span><span class=nb>echo</span><span class=w> </span><span class=nv>$x</span>
<a id=__codelineno-7-4 name=__codelineno-7-4 href=#__codelineno-7-4></a><span class=k>done</span>
</code></pre></div> <div class=highlight><pre><span></span><code><a id=__codelineno-8-1 name=__codelineno-8-1 href=#__codelineno-8-1></a><span class=c1># Every other number, width 3</span>
<a id=__codelineno-8-2 name=__codelineno-8-2 href=#__codelineno-8-2></a><span class=k>for</span><span class=w> </span>x<span class=w> </span><span class=k>in</span><span class=w> </span><span class=o>{</span><span class=m>000</span>..99..2<span class=o>}</span><span class=p>;</span><span class=w> </span><span class=k>do</span>
<a id=__codelineno-8-3 name=__codelineno-8-3 href=#__codelineno-8-3></a><span class=w> </span><span class=nb>echo</span><span class=w> </span><span class=nv>$x</span>
<a id=__codelineno-8-4 name=__codelineno-8-4 href=#__codelineno-8-4></a><span class=k>done</span>
</code></pre></div> <p>WARNING: the entire list is created before looping starts. If your list is huge this may be an issue, but no more so than for a glob that expands to a huge list.</p> <h2 id=portability-considerations>Portability considerations<a class=headerlink href=#portability-considerations title="Permanent link">&para;</a></h2> <h2 id=see-also>See also<a class=headerlink href=#see-also title="Permanent link">&para;</a></h2> <ul> <li><a href=../c_for/ >c_for</a></li> </ul> <div class=footnote> <hr> <ol> <li id=fn:1> <p><a href=http://pubs.opengroup.org/onlinepubs/9699919799/xrat/V4_xcu_chap02.html#tag_23_02_09_12>http://pubs.opengroup.org/onlinepubs/9699919799/xrat/V4_xcu_chap02.html#tag_23_02_09_12</a>&#160;<a class=footnote-backref href=#fnref:1 title="Jump back to footnote 1 in the text">&#8617;</a></p> </li> </ol> </div> <aside class=md-source-file> <span class=md-source-file__fact> <span class=md-icon title="Last update"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg> </span> <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">November 13, 2024</span> </span> <span class=md-source-file__fact> <span class=md-icon title=Created> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M14.47 15.08 11 13V7h1.5v5.25l3.08 1.83c-.41.28-.79.62-1.11 1m-1.39 4.84c-.36.05-.71.08-1.08.08-4.42 0-8-3.58-8-8s3.58-8 8-8 8 3.58 8 8c0 .37-.03.72-.08 1.08.69.1 1.33.32 1.92.64.1-.56.16-1.13.16-1.72 0-5.5-4.5-10-10-10S2 6.5 2 12s4.47 10 10 10c.59 0 1.16-.06 1.72-.16-.32-.59-.54-1.23-.64-1.92M18 15v3h-3v2h3v3h2v-3h3v-2h-3v-3z"/></svg> </span> <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">November 13, 2024</span> </span> </aside> <h2 id=__comments>Comments</h2> <script src=https://giscus.app/client.js data-repo=flokoe/bash-hackers-wiki data-repo-id=R_kgDOJ3Nr6Q data-category="Giscus Page Comments" data-category-id=DIC_kwDOJ3Nr6c4CXq9t data-mapping=pathname data-strict=1 data-reactions-enabled=1 data-emit-metadata=0 data-input-position=top data-theme=preferred_color_scheme data-lang=en data-loading=lazy crossorigin=anonymous async>
</script> <script>
var giscus = document.querySelector("script[src*=giscus]")
/* Set palette on initial load */
var palette = __md_get("__palette")
if (palette && typeof palette.color === "object") {
var theme = palette.color.scheme === "slate" ? "dark" : "light"
giscus.setAttribute("data-theme", theme)
}
/* Register event handlers after documented loaded */
document.addEventListener("DOMContentLoaded", function() {
var ref = document.querySelector("[data-md-component=palette]")
ref.addEventListener("change", function() {
var palette = __md_get("__palette")
if (palette && typeof palette.color === "object") {
var theme = palette.color.scheme === "slate" ? "dark" : "light"
/* Instruct Giscus to change theme */
var frame = document.querySelector(".giscus-frame")
frame.contentWindow.postMessage(
{ giscus: { setConfig: { theme } } },
"https://giscus.app"
)
}
})
})
</script> </article> </div> <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script> </div> <button type=button class="md-top md-icon" data-md-component=top hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg> Back to top </button> </main> <footer class=md-footer> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class=md-copyright> Made with <a href=https://squidfunk.github.io/mkdocs-material/ target=_blank rel=noopener> Material for MkDocs </a> </div> </div> </div> </footer> </div> <div class=md-dialog data-md-component=dialog> <div class="md-dialog__inner md-typeset"></div> </div> <script id=__config type=application/json>{"base": "../../..", "features": ["navigation.instant", "navigation.tracking", "navigation.tabs", "navigation.sections", "navigation.top", "content.action.view", "content.action.edit", "search.suggest", "search.highlight", "content.code.copy"], "search": "../../../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script> <script src=../../../assets/javascripts/bundle.83f73b43.min.js></script> </body> </html>