<!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="dynamic-dimensional"><meta name="keywords" content="rust, rustlang, rust-lang, IxDyn"><title>IxDyn 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 type"><!--[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><h2 class="location">Type Definition IxDyn</h2><div class="sidebar-elems"><div class="block items"><h3 class="sidebar-title"><a href="#implementations">Methods</a></h3><div class="sidebar-links"><a href="#method.zeros">zeros</a></div><h3 class="sidebar-title"><a href="#trait-implementations">Trait Implementations</a></h3><div class="sidebar-links"><a href="#impl-Dimension">Dimension</a><a href="#impl-NdIndex%3CDim%3CIxDynImpl%3E%3E">NdIndex<Dim<IxDynImpl>></a></div></div><h2 class="location">Other items in<br><a href="index.html">ndarray</a></h2><div id="sidebar-vars" data-name="IxDyn" data-ty="type" 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">Type Definition <a href="index.html">ndarray</a>::<wbr><a class="type" href="#">IxDyn</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/aliases.rs.html#96" title="goto source code">[src]</a></span></h1><pre class="rust typedef">type IxDyn = <a class="struct" href="struct.Dim.html" title="struct ndarray::Dim">Dim</a><<a class="struct" href="struct.IxDynImpl.html" title="struct ndarray::IxDynImpl">IxDynImpl</a>>;</pre><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>dynamic-dimensional</p>
<p>You can use the <code>IxDyn</code> function to create a dimension for an array with
dynamic number of dimensions. (<code>Vec<usize></code> and <code>&[usize]</code> also implement
<code>IntoDimension</code> to produce <code>IxDyn</code>).</p>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">ndarray::ArrayD</span>;
<span class="kw">use</span> <span class="ident">ndarray::IxDyn</span>;
<span class="comment">// Create a 5 × 6 × 3 × 4 array using the dynamic dimension type</span>
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">a</span> <span class="op">=</span> <span class="ident">ArrayD</span>::<span class="op"><</span><span class="ident">f64</span><span class="op">></span><span class="ident">::zeros</span>(<span class="ident">IxDyn</span>(<span class="kw-2">&</span>[<span class="number">5</span>, <span class="number">6</span>, <span class="number">3</span>, <span class="number">4</span>]));
<span class="comment">// Create a 1 × 3 × 4 array using the dynamic dimension type</span>
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">b</span> <span class="op">=</span> <span class="ident">ArrayD</span>::<span class="op"><</span><span class="ident">f64</span><span class="op">></span><span class="ident">::zeros</span>(<span class="ident">IxDyn</span>(<span class="kw-2">&</span>[<span class="number">1</span>, <span class="number">3</span>, <span class="number">4</span>]));
<span class="comment">// We can use broadcasting to add arrays of compatible shapes together:</span>
<span class="ident">a</span> <span class="op">+</span><span class="op">=</span> <span class="kw-2">&</span><span class="ident">b</span>;
<span class="comment">// We can index into a, b using fixed size arrays:</span>
<span class="ident">a</span>[[<span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>]] <span class="op">=</span> <span class="number">0.</span>;
<span class="ident">b</span>[[<span class="number">0</span>, <span class="number">2</span>, <span class="number">3</span>]] <span class="op">=</span> <span class="ident">a</span>[[<span class="number">0</span>, <span class="number">0</span>, <span class="number">2</span>, <span class="number">3</span>]];
<span class="comment">// Note: indexing will panic at runtime if the number of indices given does</span>
<span class="comment">// not match the array.</span>
<span class="comment">// We can keep them in the same vector because both the arrays have</span>
<span class="comment">// the same type `Array<f64, IxDyn>` a.k.a `ArrayD<f64>`:</span>
<span class="kw">let</span> <span class="ident">arrays</span> <span class="op">=</span> <span class="macro">vec!</span>[<span class="ident">a</span>, <span class="ident">b</span>];</pre></div>
</div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl" class="impl has-srclink"><h3 class="code-header in-band">impl <a class="type" href="type.IxDyn.html" title="type ndarray::IxDyn">IxDyn</a></h3><a href="#impl" class="anchor"></a><a class="srclink" href="../src/ndarray/dimension/dynindeximpl.rs.html#232-243" title="goto source code">[src]</a></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.zeros" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.zeros" class="fnname">zeros</a>(n: <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.usize.html">usize</a>) -> <a class="type" href="type.IxDyn.html" title="type ndarray::IxDyn">IxDyn</a></h4><a href="#method.zeros" class="anchor"></a><a class="srclink" href="../src/ndarray/dimension/dynindeximpl.rs.html#235-242" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Create a new dimension value with <code>n</code> axes, all zeros</p>
</div></details></div></details><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-Dimension" class="impl has-srclink"><h3 class="code-header in-band">impl <a class="trait" href="trait.Dimension.html" title="trait ndarray::Dimension">Dimension</a> for <a class="type" href="type.IxDyn.html" title="type ndarray::IxDyn">IxDyn</a></h3><a href="#impl-Dimension" class="anchor"></a><a class="srclink" href="../src/ndarray/dimension/dimension_trait.rs.html#832-873" title="goto source code">[src]</a></div></summary><div class="docblock"><p>IxDyn is a “dynamic” index, pretty hard to use when indexing,
and memory wasteful, but it allows an arbitrary and dynamic number of axes.</p>
</div><div class="impl-items"><details class="rustdoc-toggle" open><summary><div id="associatedtype.SliceArg" class="type trait-impl has-srclink"><h4 class="code-header">type <a href="trait.Dimension.html#associatedtype.SliceArg" class="type">SliceArg</a> = <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.slice.html">[</a><a class="struct" href="struct.Si.html" title="struct ndarray::Si">Si</a><a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.slice.html">]</a></h4><a href="#associatedtype.SliceArg" class="anchor"></a></div></summary><div class='docblock'><p><code>SliceArg</code> is the type which is used to specify slicing for this
dimension. <a href="trait.Dimension.html#associatedtype.SliceArg">Read more</a></p>
</div></details><details class="rustdoc-toggle" open><summary><div id="associatedtype.Pattern" class="type trait-impl has-srclink"><h4 class="code-header">type <a href="trait.Dimension.html#associatedtype.Pattern" class="type">Pattern</a> = Self</h4><a href="#associatedtype.Pattern" class="anchor"></a></div></summary><div class='docblock'><p>Pattern matching friendly form of the dimension value. <a href="trait.Dimension.html#associatedtype.Pattern">Read more</a></p>
</div></details><details class="rustdoc-toggle" open><summary><div id="associatedtype.Smaller" class="type trait-impl has-srclink"><h4 class="code-header">type <a href="trait.Dimension.html#associatedtype.Smaller" class="type">Smaller</a> = Self</h4><a href="#associatedtype.Smaller" class="anchor"></a></div></summary><div class='docblock'><p>Next smaller dimension (if applicable)</p>
</div></details><details class="rustdoc-toggle" open><summary><div id="associatedtype.Larger" class="type trait-impl has-srclink"><h4 class="code-header">type <a href="trait.Dimension.html#associatedtype.Larger" class="type">Larger</a> = Self</h4><a href="#associatedtype.Larger" class="anchor"></a></div></summary><div class='docblock'><p>Next larger dimension</p>
</div></details><div id="method.ndim" class="method trait-impl has-srclink"><h4 class="code-header">fn <a href="trait.Dimension.html#tymethod.ndim" class="fnname">ndim</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.usize.html">usize</a></h4><a href="#method.ndim" class="anchor"></a><a class="srclink" href="../src/ndarray/dimension/dimension_trait.rs.html#839" title="goto source code">[src]</a></div><div id="method.slice" class="method trait-impl has-srclink"><h4 class="code-header">fn <a href="trait.Dimension.html#tymethod.slice" class="fnname">slice</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.slice.html">&[</a><a class="type" href="type.Ix.html" title="type ndarray::Ix">Ix</a><a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.slice.html">]</a></h4><a href="#method.slice" class="anchor"></a><a class="srclink" href="../src/ndarray/dimension/dimension_trait.rs.html#841" title="goto source code">[src]</a></div><div id="method.slice_mut" class="method trait-impl has-srclink"><h4 class="code-header">fn <a href="trait.Dimension.html#tymethod.slice_mut" class="fnname">slice_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.slice.html">&mut [</a><a class="type" href="type.Ix.html" title="type ndarray::Ix">Ix</a><a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.slice.html">]</a></h4><a href="#method.slice_mut" class="anchor"></a><a class="srclink" href="../src/ndarray/dimension/dimension_trait.rs.html#843" title="goto source code">[src]</a></div><details class="rustdoc-toggle method-toggle" open><summary><div id="method.into_pattern" class="method trait-impl has-srclink"><h4 class="code-header">fn <a href="trait.Dimension.html#tymethod.into_pattern" class="fnname">into_pattern</a>(self) -> Self::<a class="type" href="trait.Dimension.html#associatedtype.Pattern" title="type ndarray::Dimension::Pattern">Pattern</a></h4><a href="#method.into_pattern" class="anchor"></a><a class="srclink" href="../src/ndarray/dimension/dimension_trait.rs.html#845-847" title="goto source code">[src]</a></div></summary><div class='docblock'><p>Convert the dimension into a pattern matching friendly value.</p>
</div></details><div id="method.zero_index" class="method trait-impl has-srclink"><h4 class="code-header">fn <a href="trait.Dimension.html#method.zero_index" class="fnname">zero_index</a>(&self) -> Self</h4><a href="#method.zero_index" class="anchor"></a><a class="srclink" href="../src/ndarray/dimension/dimension_trait.rs.html#850-852" title="goto source code">[src]</a></div><div id="method.insert_axis" class="method trait-impl has-srclink"><h4 class="code-header">fn <a href="trait.Dimension.html#tymethod.insert_axis" class="fnname">insert_axis</a>(&self, axis: <a class="struct" href="struct.Axis.html" title="struct ndarray::Axis">Axis</a>) -> Self::<a class="type" href="trait.Dimension.html#associatedtype.Larger" title="type ndarray::Dimension::Larger">Larger</a></h4><a href="#method.insert_axis" class="anchor"></a><a class="srclink" href="../src/ndarray/dimension/dimension_trait.rs.html#855-858" title="goto source code">[src]</a></div><div id="method.try_remove_axis" class="method trait-impl has-srclink"><h4 class="code-header">fn <a href="trait.Dimension.html#tymethod.try_remove_axis" class="fnname">try_remove_axis</a>(&self, axis: <a class="struct" href="struct.Axis.html" title="struct ndarray::Axis">Axis</a>) -> Self::<a class="type" href="trait.Dimension.html#associatedtype.Smaller" title="type ndarray::Dimension::Smaller">Smaller</a></h4><a href="#method.try_remove_axis" class="anchor"></a><a class="srclink" href="../src/ndarray/dimension/dimension_trait.rs.html#861-867" title="goto source code">[src]</a></div><div id="method.from_dimension" class="method trait-impl has-srclink"><h4 class="code-header">fn <a href="trait.Dimension.html#method.from_dimension" class="fnname">from_dimension</a><D2: <a class="trait" href="trait.Dimension.html" title="trait ndarray::Dimension">Dimension</a>>(d: <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.reference.html">&</a>D2) -> <a class="enum" href="https://doc.rust-lang.org/1.54.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self></h4><a href="#method.from_dimension" class="anchor"></a><a class="srclink" href="../src/ndarray/dimension/dimension_trait.rs.html#869-871" title="goto source code">[src]</a></div><details class="rustdoc-toggle method-toggle" open><summary><div id="method.size" class="method trait-impl has-srclink"><h4 class="code-header">fn <a href="trait.Dimension.html#method.size" class="fnname">size</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.usize.html">usize</a></h4><a href="#method.size" class="anchor"></a><a class="srclink" href="../src/ndarray/dimension/dimension_trait.rs.html#77-79" title="goto source code">[src]</a></div></summary><div class='docblock'><p>Compute the size of the dimension (number of elements)</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.size_checked" class="method trait-impl has-srclink"><h4 class="code-header">fn <a href="trait.Dimension.html#method.size_checked" class="fnname">size_checked</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.54.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.usize.html">usize</a>></h4><a href="#method.size_checked" class="anchor"></a><a class="srclink" href="../src/ndarray/dimension/dimension_trait.rs.html#82-84" title="goto source code">[src]</a></div></summary><div class='docblock'><p>Compute the size while checking for overflow.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.as_array_view" class="method trait-impl has-srclink"><h4 class="code-header">fn <a href="trait.Dimension.html#method.as_array_view" class="fnname">as_array_view</a>(&self) -> <a class="type" href="type.ArrayView1.html" title="type ndarray::ArrayView1">ArrayView1</a><'_, <a class="type" href="type.Ix.html" title="type ndarray::Ix">Ix</a>></h4><a href="#method.as_array_view" class="anchor"></a><a class="srclink" href="../src/ndarray/dimension/dimension_trait.rs.html#93-95" title="goto source code">[src]</a></div></summary><div class='docblock'><p>Borrow as a read-only array view.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.as_array_view_mut" class="method trait-impl has-srclink"><h4 class="code-header">fn <a href="trait.Dimension.html#method.as_array_view_mut" class="fnname">as_array_view_mut</a>(&mut self) -> <a class="type" href="type.ArrayViewMut1.html" title="type ndarray::ArrayViewMut1">ArrayViewMut1</a><'_, <a class="type" href="type.Ix.html" title="type ndarray::Ix">Ix</a>></h4><a href="#method.as_array_view_mut" class="anchor"></a><a class="srclink" href="../src/ndarray/dimension/dimension_trait.rs.html#98-100" title="goto source code">[src]</a></div></summary><div class='docblock'><p>Borrow as a read-write array view.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.into_dyn" class="method trait-impl has-srclink"><h4 class="code-header">fn <a href="trait.Dimension.html#method.into_dyn" class="fnname">into_dyn</a>(self) -> <a class="type" href="type.IxDyn.html" title="type ndarray::IxDyn">IxDyn</a></h4><a href="#method.into_dyn" class="anchor"></a><a class="srclink" href="../src/ndarray/dimension/dimension_trait.rs.html#375-377" title="goto source code">[src]</a></div></summary><div class='docblock'><p>Convert the dimensional into a dynamic dimensional (IxDyn).</p>
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.__private__" class="tymethod trait-impl has-srclink"><h4 class="code-header">fn <a href="trait.Dimension.html#tymethod.__private__" class="fnname">__private__</a>(&self) -> PrivateMarker</h4><a href="#tymethod.__private__" class="anchor"></a><a class="srclink" href="../src/ndarray/dimension/dimension_trait.rs.html#398" title="goto source code">[src]</a></div></summary><div class='docblock'><p>This trait is private to implement; this method exists to make it
impossible to implement outside the crate. <a href="trait.Dimension.html#tymethod.__private__">Read more</a></p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-NdIndex%3CDim%3CIxDynImpl%3E%3E" class="impl has-srclink"><h3 class="code-header in-band">impl<'a> <a class="trait" href="trait.NdIndex.html" title="trait ndarray::NdIndex">NdIndex</a><<a class="struct" href="struct.Dim.html" title="struct ndarray::Dim">Dim</a><<a class="struct" href="struct.IxDynImpl.html" title="struct ndarray::IxDynImpl">IxDynImpl</a>>> for &'a <a class="type" href="type.IxDyn.html" title="type ndarray::IxDyn">IxDyn</a></h3><a href="#impl-NdIndex%3CDim%3CIxDynImpl%3E%3E" class="anchor"></a><a class="srclink" href="../src/ndarray/dimension/ndindex.rs.html#206-213" title="goto source code">[src]</a></div></summary><div class="impl-items"><div id="method.index_checked" class="method trait-impl has-srclink"><h4 class="code-header">fn <a href="trait.NdIndex.html#tymethod.index_checked" class="fnname">index_checked</a>(&self, dim: &<a class="type" href="type.IxDyn.html" title="type ndarray::IxDyn">IxDyn</a>, strides: &<a class="type" href="type.IxDyn.html" title="type ndarray::IxDyn">IxDyn</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.54.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.isize.html">isize</a>></h4><a href="#method.index_checked" class="anchor"></a><a class="srclink" href="../src/ndarray/dimension/ndindex.rs.html#207-209" title="goto source code">[src]</a></div><div id="method.index_unchecked" class="method trait-impl has-srclink"><h4 class="code-header">fn <a href="trait.NdIndex.html#tymethod.index_unchecked" class="fnname">index_unchecked</a>(&self, strides: &<a class="type" href="type.IxDyn.html" title="type ndarray::IxDyn">IxDyn</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.isize.html">isize</a></h4><a href="#method.index_unchecked" class="anchor"></a><a class="srclink" href="../src/ndarray/dimension/ndindex.rs.html#210-212" title="goto source code">[src]</a></div></div></details></div></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>