41 lines
12 KiB
HTML
41 lines
12 KiB
HTML
<!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="Defines a trait to handle Vector-like data"><title>AsVector in plotpy - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="plotpy" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></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="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../plotpy/index.html">plotpy</a><span class="version">0.5.1</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">AsVector</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#example" title="Example">Example</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.vec_at" title="vec_at">vec_at</a></li><li><a href="#tymethod.vec_size" title="vec_size">vec_size</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-AsVector%3C'a,+U%3E-for-%26%5BU%5D" title="&'a [U]">&'a [U]</a></li><li><a href="#impl-AsVector%3C'a,+U%3E-for-Vec%3CU%3E" title="Vec<U>">Vec<U></a></li><li><a href="#impl-AsVector%3C'a,+U%3E-for-%5BU;+M%5D" title="[U; M]">[U; M]</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate plotpy</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="index.html">plotpy</a></span><h1>Trait <span class="trait">AsVector</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/plotpy/as_vector.rs.html#33-39">Source</a> </span></div><pre class="rust item-decl"><code>pub trait AsVector<'a, U: 'a> {
|
|
// Required methods
|
|
fn <a href="#tymethod.vec_size" class="fn">vec_size</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.vec_at" class="fn">vec_at</a>(&self, i: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>) -> U;
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Defines a trait to handle Vector-like data</p>
|
|
<h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>plotpy::AsVector;
|
|
|
|
<span class="kw">fn </span>sum<<span class="lifetime">'a</span>, T, U>(array: <span class="kw-2">&</span><span class="lifetime">'a </span>T) -> f64
|
|
<span class="kw">where
|
|
</span>T: AsVector<<span class="lifetime">'a</span>, U>,
|
|
U: <span class="lifetime">'a </span>+ Into<f64>,
|
|
{
|
|
<span class="kw">let </span><span class="kw-2">mut </span>res = <span class="number">0.0</span>;
|
|
<span class="kw">let </span>m = array.vec_size();
|
|
<span class="kw">for </span>i <span class="kw">in </span><span class="number">0</span>..m {
|
|
res += array.vec_at(i).into();
|
|
}
|
|
res
|
|
}
|
|
|
|
<span class="comment">// heap-allocated 1D array (vector)
|
|
</span><span class="kw">let </span>x = <span class="macro">vec!</span>[<span class="number">1.0</span>, <span class="number">2.0</span>, <span class="number">3.0</span>];
|
|
<span class="macro">assert_eq!</span>(sum(<span class="kw-2">&</span>x), <span class="number">6.0</span>);
|
|
|
|
<span class="comment">// heap-allocated 1D array (slice)
|
|
</span><span class="kw">let </span>y: <span class="kw-2">&</span>[f64] = <span class="kw-2">&</span>[<span class="number">10.0</span>, <span class="number">20.0</span>, <span class="number">30.0</span>];
|
|
<span class="macro">assert_eq!</span>(sum(<span class="kw-2">&</span>y), <span class="number">60.0</span>);
|
|
|
|
<span class="comment">// stack-allocated (fixed-size) 2D array
|
|
</span><span class="kw">let </span>z = [<span class="number">100.0</span>, <span class="number">200.0</span>, <span class="number">300.0</span>];
|
|
<span class="macro">assert_eq!</span>(sum(<span class="kw-2">&</span>z), <span class="number">600.0</span>);</code></pre></div>
|
|
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.vec_size" class="method"><a class="src rightside" href="../src/plotpy/as_vector.rs.html#35">Source</a><h4 class="code-header">fn <a href="#tymethod.vec_size" class="fn">vec_size</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns the size of the vector</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.vec_at" class="method"><a class="src rightside" href="../src/plotpy/as_vector.rs.html#38">Source</a><h4 class="code-header">fn <a href="#tymethod.vec_at" class="fn">vec_at</a>(&self, i: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>) -> U</h4></section></summary><div class="docblock"><p>Returns the value at index i</p>
|
|
</div></details></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-AsVector%3C'a,+U%3E-for-%26%5BU%5D" class="impl"><a class="src rightside" href="../src/plotpy/as_vector.rs.html#55-65">Source</a><a href="#impl-AsVector%3C'a,+U%3E-for-%26%5BU%5D" class="anchor">§</a><h3 class="code-header">impl<'a, U> <a class="trait" href="trait.AsVector.html" title="trait plotpy::AsVector">AsVector</a><'a, U> for &'a <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.slice.html">[U]</a><div class="where">where
|
|
U: 'a + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a>,</div></h3></section></summary><div class="docblock"><p>Defines a heap-allocated 1D array (slice)</p>
|
|
</div><div class="impl-items"><section id="method.vec_size" class="method trait-impl"><a class="src rightside" href="../src/plotpy/as_vector.rs.html#59-61">Source</a><a href="#method.vec_size" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.vec_size" class="fn">vec_size</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a></h4></section><section id="method.vec_at" class="method trait-impl"><a class="src rightside" href="../src/plotpy/as_vector.rs.html#62-64">Source</a><a href="#method.vec_at" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.vec_at" class="fn">vec_at</a>(&self, i: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>) -> U</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-AsVector%3C'a,+U%3E-for-Vec%3CU%3E" class="impl"><a class="src rightside" href="../src/plotpy/as_vector.rs.html#42-52">Source</a><a href="#impl-AsVector%3C'a,+U%3E-for-Vec%3CU%3E" class="anchor">§</a><h3 class="code-header">impl<'a, U> <a class="trait" href="trait.AsVector.html" title="trait plotpy::AsVector">AsVector</a><'a, U> for <a class="struct" href="https://doc.rust-lang.org/1.84.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><U><div class="where">where
|
|
U: 'a + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a>,</div></h3></section></summary><div class="docblock"><p>Defines a heap-allocated 1D array (vector)</p>
|
|
</div><div class="impl-items"><section id="method.vec_size-1" class="method trait-impl"><a class="src rightside" href="../src/plotpy/as_vector.rs.html#46-48">Source</a><a href="#method.vec_size-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.vec_size" class="fn">vec_size</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a></h4></section><section id="method.vec_at-1" class="method trait-impl"><a class="src rightside" href="../src/plotpy/as_vector.rs.html#49-51">Source</a><a href="#method.vec_at-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.vec_at" class="fn">vec_at</a>(&self, i: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>) -> U</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-AsVector%3C'a,+U%3E-for-%5BU;+M%5D" class="impl"><a class="src rightside" href="../src/plotpy/as_vector.rs.html#68-78">Source</a><a href="#impl-AsVector%3C'a,+U%3E-for-%5BU;+M%5D" class="anchor">§</a><h3 class="code-header">impl<'a, U, const M: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>> <a class="trait" href="trait.AsVector.html" title="trait plotpy::AsVector">AsVector</a><'a, U> for <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.array.html">[U; M]</a><div class="where">where
|
|
U: 'a + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a>,</div></h3></section></summary><div class="docblock"><p>Defines a stack-allocated (fixed-size) 1D array</p>
|
|
</div><div class="impl-items"><section id="method.vec_size-2" class="method trait-impl"><a class="src rightside" href="../src/plotpy/as_vector.rs.html#72-74">Source</a><a href="#method.vec_size-2" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.vec_size" class="fn">vec_size</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a></h4></section><section id="method.vec_at-2" class="method trait-impl"><a class="src rightside" href="../src/plotpy/as_vector.rs.html#75-77">Source</a><a href="#method.vec_at-2" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.vec_at" class="fn">vec_at</a>(&self, i: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>) -> U</h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../trait.impl/plotpy/as_vector/trait.AsVector.js" data-ignore-extern-crates="alloc,std" async></script></section></div></main></body></html> |