|
|
|
|
|
<!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="API documentation for the Rust `Array` trait in crate `cgmath`."><meta name="keywords" content="rust, rustlang, rust-lang, Array"><title>cgmath::prelude::Array - 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="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="shortcut icon" href="../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../cgmath/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Trait Array</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-types">Associated Types</a><div class="sidebar-links"><a href="#associatedtype.Element">Element</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.from_value">from_value</a><a href="#tymethod.is_finite">is_finite</a><a href="#tymethod.len">len</a><a href="#tymethod.product">product</a><a href="#tymethod.sum">sum</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.as_mut_ptr">as_mut_ptr</a><a href="#method.as_ptr">as_ptr</a><a href="#method.swap_elements">swap_elements</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../index.html'>cgmath</a>::<wbr><a href='index.html'>prelude</a></p><script>window.sidebarCurrent = {name: 'Array', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><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/cgmath/structure.rs.html#31-95' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='../index.html'>cgmath</a>::<wbr><a href='index.html'>prelude</a>::<wbr><a class="trait" href=''>Array</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait Array <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html" title="trait core::ops::index::Index">Index</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, Output = Self::<a class="type" href="../../cgmath/prelude/trait.Array.html#associatedtype.Element" title="type cgmath::prelude::Array::Element">Element</a>>,<br> &nbs
|
|
|
|
|
|
type <a href='#associatedtype.Element' class="type">Element</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a>;
|
|
|
|
|
|
fn <a href='#tymethod.len' class='fnname'>len</a>() -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>;
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.from_value' class='fnname'>from_value</a>(value: Self::<a class="type" href="../../cgmath/prelude/trait.Array.html#associatedtype.Element" title="type cgmath::prelude::Array::Element">Element</a>) -> Self;
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.sum' class='fnname'>sum</a>(self) -> Self::<a class="type" href="../../cgmath/prelude/trait.Array.html#associatedtype.Element" title="type cgmath::prelude::Array::Element">Element</a><br> <span class="where">where<br> Self::<a class="type" href="../../cgmath/prelude/trait.Array.html#associatedtype.Element" title="type cgmath::prelude::Array::Element">Element</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.Add.html" title="trait core::ops::arith::Add">Add</a><Output = Self::<a class="type" href="../../cgmath/prelude/trait.Array.html#associatedtype.Element" title="type cgmath::prelude::Array::Element">Element</a>></span>;
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.product' class='fnname'>product</a>(self) -> Self::<a class="type" href="../../cgmath/prelude/trait.Array.html#associatedtype.Element" title="type cgmath::prelude::Array::Element">Element</a><br> <span class="where">where<br> Self::<a class="type" href="../../cgmath/prelude/trait.Array.html#associatedtype.Element" title="type cgmath::prelude::Array::Element">Element</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.Mul.html" title="trait core::ops::arith::Mul">Mul</a><Output = Self::<a class="type" href="../../cgmath/prelude/trait.Array.html#associatedtype.Element" title="type cgmath::prelude::Array::Element">Element</a>></span>;
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.is_finite' class='fnname'>is_finite</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a><br> <span class="where">where<br> Self::<a class="type" href="../../cgmath/prelude/trait.Array.html#associatedtype.Element" title="type cgmath::prelude::Array::Element">Element</a>: <a class="trait" href="../../cgmath/trait.BaseFloat.html" title="trait cgmath::BaseFloat">BaseFloat</a></span>;
|
|
|
|
|
|
|
|
|
|
|
|
fn <a href='#method.as_ptr' class='fnname'>as_ptr</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const </a>Self::<a class="type" href="../../cgmath/prelude/trait.Array.html#associatedtype.Element" title="type cgmath::prelude::Array::Element">Element</a> { ... }
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#method.as_mut_ptr' class='fnname'>as_mut_ptr</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a>Self::<a class="type" href="../../cgmath/prelude/trait.Array.html#associatedtype.Element" title="type cgmath::prelude::Array::Element">Element</a> { ... }
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#method.swap_elements' class='fnname'>swap_elements</a>(&mut self, i: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, j: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) { ... }
|
|
|
|
|
|
}</pre></div><div class='docblock'><p>An array containing elements of type <code>Element</code></p>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<h2 id='associated-types' class='small-section-header'>Associated Types<a href='#associated-types' class='anchor'></a></h2><div class='methods'><h3 id='associatedtype.Element' class='method'><code id='Element.t'>type <a href='#associatedtype.Element' class="type">Element</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a></code></h3></div><span class='loading-content'>Loading content...</span>
|
|
|
|
|
|
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.len' class='method'><code id='len.v'>fn <a href='#tymethod.len' class='fnname'>len</a>() -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></h3><div class='docblock'><p>Get the number of elements in the array type</p>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
|
|
|
<span class="kw">use</span> <span class="ident">cgmath</span>::<span class="ident">prelude</span>::<span class="kw-2">*</span>;
|
|
|
|
|
|
<span class="kw">use</span> <span class="ident">cgmath</span>::<span class="ident">Vector3</span>;
|
|
|
|
|
|
|
|
|
|
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">Vector3</span>::<span class="op"><</span><span class="ident">f32</span><span class="op">></span>::<span class="ident">len</span>(), <span class="number">3</span>);</pre></div>
|
|
|
|
|
|
</div><h3 id='tymethod.from_value' class='method'><code id='from_value.v'>fn <a href='#tymethod.from_value' class='fnname'>from_value</a>(value: Self::<a class="type" href="../../cgmath/prelude/trait.Array.html#associatedtype.Element" title="type cgmath::prelude::Array::Element">Element</a>) -> Self</code></h3><div class='docblock'><p>Construct a vector from a single value, replicating it.</p>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
|
|
|
<span class="kw">use</span> <span class="ident">cgmath</span>::<span class="ident">prelude</span>::<span class="kw-2">*</span>;
|
|
|
|
|
|
<span class="kw">use</span> <span class="ident">cgmath</span>::<span class="ident">Vector3</span>;
|
|
|
|
|
|
|
|
|
|
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">Vector3</span>::<span class="ident">from_value</span>(<span class="number">1</span>),
|
|
|
|
|
|
<span class="ident">Vector3</span>::<span class="ident">new</span>(<span class="number">1</span>, <span class="number">1</span>, <span class="number">1</span>));</pre></div>
|
|
|
|
|
|
</div><h3 id='tymethod.sum' class='method'><code id='sum.v'>fn <a href='#tymethod.sum' class='fnname'>sum</a>(self) -> Self::<a class="type" href="../../cgmath/prelude/trait.Array.html#associatedtype.Element" title="type cgmath::prelude::Array::Element">Element</a> <span class="where fmt-newline">where<br> Self::<a class="type" href="../../cgmath/prelude/trait.Array.html#associatedtype.Element" title="type cgmath::prelude::Array::Element">Element</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.Add.html" title="trait core::ops::arith::Add">Add</a><Output = Self::<a class="type" href="../../cgmath/prelude/trait.Array.html#associatedtype.Element" title="type cgmath::prelude::Array::Element">Element</a>>, </span></code></h3><div class='docblock'><p>The sum of the elements of the array.</p>
|
|
|
|
|
|
</div><h3 id='tymethod.product' class='method'><code id='product.v'>fn <a href='#tymethod.product' class='fnname'>product</a>(self) -> Self::<a class="type" href="../../cgmath/prelude/trait.Array.html#associatedtype.Element" title="type cgmath::prelude::Array::Element">Element</a> <span class="where fmt-newline">where<br> Self::<a class="type" href="../../cgmath/prelude/trait.Array.html#associatedtype.Element" title="type cgmath::prelude::Array::Element">Element</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.Mul.html" title="trait core::ops::arith::Mul">Mul</a><Output = Self::<a class="type" href="../../cgmath/prelude/trait.Array.html#associatedtype.Element" title="type cgmath::prelude::Array::Element">Element</a>>, </span></code></h3><div class='docblock'><p>The product of the elements of the array.</p>
|
|
|
|
|
|
</div><h3 id='tymethod.is_finite' class='method'><code id='is_finite.v'>fn <a href='#tymethod.is_finite' class='fnname'>is_finite</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> <span class="where fmt-newline">where<br> Self::<a class="type" href="../../cgmath/prelude/trait.Array.html#associatedtype.Element" title="type cgmath::prelude::Array::Element">Element</a>: <a class="trait" href="../../cgmath/trait.BaseFloat.html" title="trait cgmath::BaseFloat">BaseFloat</a>, </span></code></h3><div class='docblock'><p>Whether all elements of the array are finite</p>
|
|
|
|
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|
|
|
|
|
<h2 id='provided-methods' class='small-section-header'>Provided methods<a href='#provided-methods' class='anchor'></a></h2><div class='methods'><h3 id='method.as_ptr' class='method'><code id='as_ptr.v'>fn <a href='#method.as_ptr' class='fnname'>as_ptr</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const </a>Self::<a class="type" href="../../cgmath/prelude/trait.Array.html#associatedtype.Element" title="type cgmath::prelude::Array::Element">Element</a></code></h3><div class='docblock'><p>Get the pointer to the first element of the array.</p>
|
|
|
|
|
|
</div><h3 id='method.as_mut_ptr' class='method'><code id='as_mut_ptr.v'>fn <a href='#method.as_mut_ptr' class='fnname'>as_mut_ptr</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a>Self::<a class="type" href="../../cgmath/prelude/trait.Array.html#associatedtype.Element" title="type cgmath::prelude::Array::Element">Element</a></code></h3><div class='docblock'><p>Get a mutable pointer to the first element of the array.</p>
|
|
|
|
|
|
</div><h3 id='method.swap_elements' class='method'><code id='swap_elements.v'>fn <a href='#method.swap_elements' class='fnname'>swap_elements</a>(&mut self, i: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, j: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>)</code></h3><div class='docblock'><p>Swap the elements at indices <code>i</code> and <code>j</code> in-place.</p>
|
|
|
|
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|
|
|
|
|
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'><h3 id='impl-Array' class='impl'><code class='in-band'>impl<S: <a class="trait" href="../../cgmath/trait.BaseNum.html" title="trait cgmath::BaseNum">BaseNum</a>> Array for <a class="struct" href="../../cgmath/struct.Point1.html" title="struct cgmath::Point1">Point1</a><S></code><a href='#impl-Array' class='anchor'></a><a class='srclink' href='../../src/cgmath/point.rs.html#99-125' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Element-1' class="type"><code id='Element.t-1'>type <a href='#associatedtype.Element-1' class="type">Element</a> = S</code></h4><h4 id='method.len' class="method hidden"><code id='len.v-1'>fn <a href='#method.len' class='fnname'>len</a>() -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class='srclink' href='../../src/cgmath/point.rs.html#103-105' title='goto source code'>[src]</a></h4><h4 id='method.from_value' class="method hidden"><code id='from_value.v-1'>fn <a href='#method.from_value' class='fnname'>from_value</a>(scalar: S) -> <a class="struct" href="../../cgmath/struct.Point1.html" title="struct cgmath::Point1">Point1</a><S></code><a class='srclink' href='../../src/cgmath/point.rs.html#108-110' title='goto source code'>[src]</a></h4><h4 id='method.sum' class="method hidden"><code id='sum.v-1'>fn <a href='#method.sum' class='fnname'>sum</a>(self) -> S <span class="where fmt-newline">where<br> S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.Add.html" title="trait core::ops::arith::Add">Add</a><Output = S>, </span></code><a class='srclink' href='../../src/cgmath/point.rs.html#113-115' title='goto source code'>[src]</a></h4><h4 id='method.product' class="method hidden"><code id='product.v-1'>fn <a href='#method.product' class='fnname'>product</a>(self) -> S <span class="where fmt-newline">where<br> S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.Mul.html" title="trait core::ops::arith::Mul">Mul</a><Output = S>, </span></code><a class='srclink' href='../../src/cgmath/point.rs.html#118-120' title='goto source code'>[src]</a></h4><h4 id='method.is_finite' class="method hidden"><code id='is_finite.v-1'>fn <a href='#method.is_finite' class='fnname'>is_finite</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> <span class="where fmt-newline">where<br> S: <a class="trait" href="../../cgmath/trait.BaseFloat.html" title="trait cgmath::BaseFloat">BaseFloat</a>, </span></code><a class='srclink' href='../../src/cgmath/point.rs.html#122-124' title='goto source code'>[src]</a></h4></div><h3 id='impl-Array-1' class='impl'><code class='in-band'>impl<S: <a class="trait" href="../../cgmath/trait.BaseNum.html" title="trait cgmath::BaseNum">BaseNum</a>> Array for <a class="struct" href="../../cgmath/struct.Point2.html" title="struct cgmath::Point2">Point2</a><S></code><a href='#impl-Array-1' class='anchor'></a><a class='srclink' href='../../src/cgmath/point.rs.html#99-125' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Element-2' class="type"><code id='Element.t-2'>type <a href='#associatedtype.Element-2' class="type">Element</a> = S</code></h4><h4 id='method.len-1' class="method hidden"><code id='len.v-2'>fn <a href='#method.len-1' class='fnname'>len</a>() -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class='srclink' href='../../src/cgmath/point.rs.html#103-105' title='goto source code'>[src]</a></h4><h4 id='method.from_value-1' class="method hidden"><code id='from_value.v-2'>fn <a href='#method.from_value-1' class='fnname'>from_value</a>(scalar: S) -> <a class="struct"
|
|
|
|
|
|
src="../../implementors/cgmath/prelude/trait.Array.js">
|
|
|
|
|
|
</script></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "cgmath";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
|
