<!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="A trait for `Shape` and `D where D: Dimension` that allows customizing the memory layout (strides) of an array shape."><meta name="keywords" content="rust, rustlang, rust-lang, ShapeBuilder"><title>ShapeBuilder 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 trait"><!--[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">Trait ShapeBuilder</h2><div class="sidebar-elems"><div class="block items"><h3 class="sidebar-title"><a href="#associated-types">Associated Types</a></h3><div class="sidebar-links"><a href="#associatedtype.Dim">Dim</a><a href="#associatedtype.Strides">Strides</a></div><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><div class="sidebar-links"><a href="#tymethod.f">f</a><a href="#tymethod.into_shape">into_shape</a><a href="#tymethod.set_f">set_f</a><a href="#tymethod.strides">strides</a></div><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div><h2 class="location">Other items in<br><a href="index.html">ndarray</a></h2><div id="sidebar-vars" data-name="ShapeBuilder" data-ty="trait" 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">Trait <a href="index.html">ndarray</a>::<wbr><a class="trait" href="#">ShapeBuilder</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/shape_builder.rs.html#11-19" title="goto source code">[src]</a></span></h1><div class="docblock type-decl"><pre class="rust trait">pub trait ShapeBuilder {
type <a href="#associatedtype.Dim" class="type">Dim</a>: <a class="trait" href="trait.Dimension.html" title="trait ndarray::Dimension">Dimension</a>;
type <a href="#associatedtype.Strides" class="type">Strides</a>;
fn <a href="#tymethod.into_shape" class="fnname">into_shape</a>(self) -> <a class="struct" href="struct.Shape.html" title="struct ndarray::Shape">Shape</a><Self::<a class="type" href="trait.ShapeBuilder.html#associatedtype.Dim" title="type ndarray::ShapeBuilder::Dim">Dim</a>>;
<div class="item-spacer"></div> fn <a href="#tymethod.f" class="fnname">f</a>(self) -> <a class="struct" href="struct.Shape.html" title="struct ndarray::Shape">Shape</a><Self::<a class="type" href="trait.ShapeBuilder.html#associatedtype.Dim" title="type ndarray::ShapeBuilder::Dim">Dim</a>>;
<div class="item-spacer"></div> fn <a href="#tymethod.set_f" class="fnname">set_f</a>(self, is_f: <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.bool.html">bool</a>) -> <a class="struct" href="struct.Shape.html" title="struct ndarray::Shape">Shape</a><Self::<a class="type" href="trait.ShapeBuilder.html#associatedtype.Dim" title="type ndarray::ShapeBuilder::Dim">Dim</a>>;
<div class="item-spacer"></div> fn <a href="#tymethod.strides" class="fnname">strides</a>(self, strides: Self::<a class="type" href="trait.ShapeBuilder.html#associatedtype.Strides" title="type ndarray::ShapeBuilder::Strides">Strides</a>) -> <a class="struct" href="struct.StrideShape.html" title="struct ndarray::StrideShape">StrideShape</a><Self::<a class="type" href="trait.ShapeBuilder.html#associatedtype.Dim" title="type ndarray::ShapeBuilder::Dim">Dim</a>>;
}</pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A trait for <code>Shape</code> and <code>D where D: Dimension</code> that allows
customizing the memory layout (strides) of an array shape.</p>
<p>This trait is used together with array constructor methods like
<code>Array::from_shape_vec</code>.</p>
</div></details><h2 id="associated-types" class="small-section-header">Associated Types<a href="#associated-types" class="anchor"></a></h2><div class="methods"><div id="associatedtype.Dim" class="method has-srclink"><h4 class="code-header">type <a href="#associatedtype.Dim" class="type">Dim</a>: <a class="trait" href="trait.Dimension.html" title="trait ndarray::Dimension">Dimension</a></h4><a class="srclink" href="../src/ndarray/shape_builder.rs.html#12" title="goto source code">[src]</a></div><div id="associatedtype.Strides" class="method has-srclink"><h4 class="code-header">type <a href="#associatedtype.Strides" class="type">Strides</a></h4><a class="srclink" href="../src/ndarray/shape_builder.rs.html#13" title="goto source code">[src]</a></div></div><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><div id="tymethod.into_shape" class="method has-srclink"><h4 class="code-header">fn <a href="#tymethod.into_shape" class="fnname">into_shape</a>(self) -> <a class="struct" href="struct.Shape.html" title="struct ndarray::Shape">Shape</a><Self::<a class="type" href="trait.ShapeBuilder.html#associatedtype.Dim" title="type ndarray::ShapeBuilder::Dim">Dim</a>></h4><a class="srclink" href="../src/ndarray/shape_builder.rs.html#15" title="goto source code">[src]</a></div><div id="tymethod.f" class="method has-srclink"><h4 class="code-header">fn <a href="#tymethod.f" class="fnname">f</a>(self) -> <a class="struct" href="struct.Shape.html" title="struct ndarray::Shape">Shape</a><Self::<a class="type" href="trait.ShapeBuilder.html#associatedtype.Dim" title="type ndarray::ShapeBuilder::Dim">Dim</a>></h4><a class="srclink" href="../src/ndarray/shape_builder.rs.html#16" title="goto source code">[src]</a></div><div id="tymethod.set_f" class="method has-srclink"><h4 class="code-header">fn <a href="#tymethod.set_f" class="fnname">set_f</a>(self, is_f: <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.bool.html">bool</a>) -> <a class="struct" href="struct.Shape.html" title="struct ndarray::Shape">Shape</a><Self::<a class="type" href="trait.ShapeBuilder.html#associatedtype.Dim" title="type ndarray::ShapeBuilder::Dim">Dim</a>></h4><a class="srclink" href="../src/ndarray/shape_builder.rs.html#17" title="goto source code">[src]</a></div><div id="tymethod.strides" class="method has-srclink"><h4 class="code-header">fn <a href="#tymethod.strides" class="fnname">strides</a>(self, strides: Self::<a class="type" href="trait.ShapeBuilder.html#associatedtype.Strides" title="type ndarray::ShapeBuilder::Strides">Strides</a>) -> <a class="struct" href="struct.StrideShape.html" title="struct ndarray::StrideShape">StrideShape</a><Self::<a class="type" href="trait.ShapeBuilder.html#associatedtype.Dim" title="type ndarray::ShapeBuilder::Dim">Dim</a>></h4><a class="srclink" href="../src/ndarray/shape_builder.rs.html#18" title="goto source code">[src]</a></div></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-ShapeBuilder" class="impl has-srclink"><h3 class="code-header in-band">impl<D> <a class="trait" href="trait.ShapeBuilder.html" title="trait ndarray::ShapeBuilder">ShapeBuilder</a> for <a class="struct" href="struct.Shape.html" title="struct ndarray::Shape">Shape</a><D> <span class="where fmt-newline">where<br> D: <a class="trait" href="trait.Dimension.html" title="trait ndarray::Dimension">Dimension</a>, </span></h3><a href="#impl-ShapeBuilder" class="anchor"></a><a class="srclink" href="../src/ndarray/shape_builder.rs.html#82-100" title="goto source code">[src]</a></div></summary><div class="impl-items"><div id="associatedtype.Dim-1" class="type trait-impl has-srclink"><h4 class="code-header">type <a href="#associatedtype.Dim" class="type">Dim</a> = D</h4><a href="#associatedtype.Dim-1" class="anchor"></a></div><div id="associatedtype.Strides-1" class="type trait-impl has-srclink"><h4 class="code-header">type <a href="#associatedtype.Strides" class="type">Strides</a> = D</h4><a href="#associatedtype.Strides-1" class="anchor"></a></div><div id="method.into_shape" class="method trait-impl has-srclink"><h4 class="code-header">fn <a href="#tymethod.into_shape" class="fnname">into_shape</a>(self) -> <a class="struct" href="struct.Shape.html" title="struct ndarray::Shape">Shape</a><D></h4><a href="#method.into_shape" class="anchor"></a><a class="srclink" href="../src/ndarray/shape_builder.rs.html#87" title="goto source code">[src]</a></div><div id="method.f" class="method trait-impl has-srclink"><h4 class="code-header">fn <a href="#tymethod.f" class="fnname">f</a>(self) -> Self</h4><a href="#method.f" class="anchor"></a><a class="srclink" href="../src/ndarray/shape_builder.rs.html#88" title="goto source code">[src]</a></div><div id="method.set_f" class="method trait-impl has-srclink"><h4 class="code-header">fn <a href="#tymethod.set_f" class="fnname">set_f</a>(self, is_f: <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.bool.html">bool</a>) -> Self</h4><a href="#method.set_f" class="anchor"></a><a class="srclink" href="../src/ndarray/shape_builder.rs.html#89-92" title="goto source code">[src]</a></div><div id="method.strides" class="method trait-impl has-srclink"><h4 class="code-header">fn <a href="#tymethod.strides" class="fnname">strides</a>(self, st: D) -> <a class="struct" href="struct.StrideShape.html" title="struct ndarray::StrideShape">StrideShape</a><D></h4><a href="#method.strides" class="anchor"></a><a class="srclink" href="../src/ndarray/shape_builder.rs.html#93-99" title="goto source code">[src]</a></div></div></details><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-ShapeBuilder-1" class="impl has-srclink"><h3 class="code-header in-band">impl<T> <a class="trait" href="trait.ShapeBuilder.html" title="trait ndarray::ShapeBuilder">ShapeBuilder</a> for T <span class="where fmt-newline">where<br> T: <a class="trait" href="trait.IntoDimension.html" title="trait ndarray::IntoDimension">IntoDimension</a>, </span></h3><a href="#impl-ShapeBuilder-1" class="anchor"></a><a class="srclink" href="../src/ndarray/shape_builder.rs.html#62-80" title="goto source code">[src]</a></div></summary><div class="impl-items"><div id="associatedtype.Dim-2" class="type trait-impl has-srclink"><h4 class="code-header">type <a href="#associatedtype.Dim" class="type">Dim</a> = T::<a class="type" href="trait.IntoDimension.html#associatedtype.Dim" title="type ndarray::IntoDimension::Dim">Dim</a></h4><a href="#associatedtype.Dim-2" class="anchor"></a></div><div id="associatedtype.Strides-2" class="type trait-impl has-srclink"><h4 class="code-header">type <a href="#associatedtype.Strides" class="type">Strides</a> = T</h4><a href="#associatedtype.Strides-2" class="anchor"></a></div><div id="method.into_shape-1" class="method trait-impl has-srclink"><h4 class="code-header">fn <a href="#tymethod.into_shape" class="fnname">into_shape</a>(self) -> <a class="struct" href="struct.Shape.html" title="struct ndarray::Shape">Shape</a><Self::<a class="type" href="trait.ShapeBuilder.html#associatedtype.Dim" title="type ndarray::ShapeBuilder::Dim">Dim</a>></h4><a href="#method.into_shape-1" class="anchor"></a><a class="srclink" href="../src/ndarray/shape_builder.rs.html#67-72" title="goto source code">[src]</a></div><div id="method.f-1" class="method trait-impl has-srclink"><h4 class="code-header">fn <a href="#tymethod.f" class="fnname">f</a>(self) -> <a class="struct" href="struct.Shape.html" title="struct ndarray::Shape">Shape</a><Self::<a class="type" href="trait.ShapeBuilder.html#associatedtype.Dim" title="type ndarray::ShapeBuilder::Dim">Dim</a>></h4><a href="#method.f-1" class="anchor"></a><a class="srclink" href="../src/ndarray/shape_builder.rs.html#73" title="goto source code">[src]</a></div><div id="method.set_f-1" class="method trait-impl has-srclink"><h4 class="code-header">fn <a href="#tymethod.set_f" class="fnname">set_f</a>(self, is_f: <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.bool.html">bool</a>) -> <a class="struct" href="struct.Shape.html" title="struct ndarray::Shape">Shape</a><Self::<a class="type" href="trait.ShapeBuilder.html#associatedtype.Dim" title="type ndarray::ShapeBuilder::Dim">Dim</a>></h4><a href="#method.set_f-1" class="anchor"></a><a class="srclink" href="../src/ndarray/shape_builder.rs.html#74-76" title="goto source code">[src]</a></div><div id="method.strides-1" class="method trait-impl has-srclink"><h4 class="code-header">fn <a href="#tymethod.strides" class="fnname">strides</a>(self, st: T) -> <a class="struct" href="struct.StrideShape.html" title="struct ndarray::StrideShape">StrideShape</a><Self::<a class="type" href="trait.ShapeBuilder.html#associatedtype.Dim" title="type ndarray::ShapeBuilder::Dim">Dim</a>></h4><a href="#method.strides-1" class="anchor"></a><a class="srclink" href="../src/ndarray/shape_builder.rs.html#77-79" title="goto source code">[src]</a></div></div></details></div><script type="text/javascript" src="../implementors/ndarray/trait.ShapeBuilder.js" async></script></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>