<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Slice argument constructor."><meta name="keywords" content="rust, rustlang, rust-lang, s"><title>s in ndarray - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><script src="../crates.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc macro"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a href='../ndarray/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><h2 class="location">Other items in<br><a href="index.html">ndarray</a></h2><div id="sidebar-vars" data-name="s" data-ty="macro" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img src="../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img src="../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Macro <a href="index.html">ndarray</a>::<wbr><a class="macro" href="#">s</a><button id="copy-path" onclick="copy_path(this)" title="copy path"><img src="../clipboard.svg" width="19" height="18" alt="Copy item import" title="Copy item import to clipboard"></button></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../src/ndarray/si.rs.html#145-177" title="goto source code">[src]</a></span></h1><div class="docblock type-decl"><div class="example-wrap"><pre class="rust macro">
<span class="macro">macro_rules!</span> <span class="ident">s</span> {
(@<span class="ident">parse</span> [$(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">stack</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>] <span class="macro-nonterminal">$</span><span class="macro-nonterminal">r</span>:<span class="ident">expr</span>;<span class="macro-nonterminal">$</span><span class="macro-nonterminal">s</span>:<span class="ident">expr</span>) <span class="op">=</span><span class="op">></span> { ... };
(@<span class="ident">parse</span> [$(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">stack</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>] <span class="macro-nonterminal">$</span><span class="macro-nonterminal">r</span>:<span class="ident">expr</span>) <span class="op">=</span><span class="op">></span> { ... };
(@<span class="ident">parse</span> [$(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">stack</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>] <span class="macro-nonterminal">$</span><span class="macro-nonterminal">r</span>:<span class="ident">expr</span>;<span class="macro-nonterminal">$</span><span class="macro-nonterminal">s</span>:<span class="ident">expr</span> ,) <span class="op">=</span><span class="op">></span> { ... };
(@<span class="ident">parse</span> [$(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">stack</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>] <span class="macro-nonterminal">$</span><span class="macro-nonterminal">r</span>:<span class="ident">expr</span> ,) <span class="op">=</span><span class="op">></span> { ... };
(@<span class="ident">parse</span> [$(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">stack</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>] <span class="macro-nonterminal">$</span><span class="macro-nonterminal">r</span>:<span class="ident">expr</span>;<span class="macro-nonterminal">$</span><span class="macro-nonterminal">s</span>:<span class="ident">expr</span>, $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">t</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=</span><span class="op">></span> { ... };
(@<span class="ident">parse</span> [$(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">stack</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>] <span class="macro-nonterminal">$</span><span class="macro-nonterminal">r</span>:<span class="ident">expr</span>, $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">t</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=</span><span class="op">></span> { ... };
(@<span class="ident">step</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">r</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">s</span>:<span class="ident">expr</span>) <span class="op">=</span><span class="op">></span> { ... };
($(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">t</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=</span><span class="op">></span> { ... };
}</pre></div>
</div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Slice argument constructor.</p>
<p><code>s![]</code> takes a list of ranges, separated by comma, with optional strides
that are separated from the range by a semicolon.
It is converted into a slice argument with type <code>&[Si; N]</code>.</p>
<p>Each range uses signed indices, where a negative value is counted from
the end of the axis. Strides are also signed and may be negative, but
must not be zero.</p>
<p>The syntax is <code>s![</code> <em>[ axis-slice [, axis-slice [ , … ] ] ]</em> <code>]</code>.
Where <em>axis-slice</em> is either <em>i</em> <code>..</code> <em>j</em> or <em>i</em> <code>..</code> <em>j</em> <code>;</code> <em>step</em>,
and <em>i</em> is the start index, <em>j</em> end index and <em>step</em> the element step
size (which defaults to 1). The number of <em>axis-slice</em> must match the
number of axes in the array.</p>
<p>For example <code>s![0..4;2, 1..5]</code> is a slice of rows 0..4 with step size 2,
and columns 1..5 with default step size 1. The slice would have
shape <code>[2, 4]</code>.</p>
<p>If an array has two axes, the slice argument is passed as
type <code>&[Si; 2]</code>. The macro expansion of <code>s![a..b;c, d..e]</code>
is equivalent to <code>&[Si(a, Some(b), c), Si(d, Some(e), 1)]</code>.</p>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="attribute">#[<span class="ident">macro_use</span>]</span>
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">ndarray</span>;
<span class="kw">use</span> <span class="ident">ndarray</span>::{<span class="ident">Array2</span>, <span class="ident">ArrayView2</span>};
<span class="kw">fn</span> <span class="ident">laplacian</span>(<span class="ident">v</span>: <span class="kw-2">&</span><span class="ident">ArrayView2</span><span class="op"><</span><span class="ident">f32</span><span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="ident">Array2</span><span class="op"><</span><span class="ident">f32</span><span class="op">></span> {
<span class="op">-</span><span class="number">4.</span> <span class="op">*</span> <span class="kw-2">&</span><span class="ident">v</span>.<span class="ident">slice</span>(<span class="macro">s!</span>[<span class="number">1</span>..<span class="op">-</span><span class="number">1</span>, <span class="number">1</span>..<span class="op">-</span><span class="number">1</span>])
<span class="op">+</span> <span class="ident">v</span>.<span class="ident">slice</span>(<span class="macro">s!</span>[ ..<span class="op">-</span><span class="number">2</span>, <span class="number">1</span>..<span class="op">-</span><span class="number">1</span>])
<span class="op">+</span> <span class="ident">v</span>.<span class="ident">slice</span>(<span class="macro">s!</span>[<span class="number">1</span>..<span class="op">-</span><span class="number">1</span>, ..<span class="op">-</span><span class="number">2</span>])
<span class="op">+</span> <span class="ident">v</span>.<span class="ident">slice</span>(<span class="macro">s!</span>[<span class="number">1</span>..<span class="op">-</span><span class="number">1</span>, <span class="number">2</span>.. ])
<span class="op">+</span> <span class="ident">v</span>.<span class="ident">slice</span>(<span class="macro">s!</span>[<span class="number">2</span>.. , <span class="number">1</span>..<span class="op">-</span><span class="number">1</span>])
}</pre></div>
</div></details></section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="ndarray" data-search-index-js="../search-index.js" data-search-js="../search.js"></div><script src="../main.js"></script></body></html>