mitchellhansen
/
Trac3r-rust
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'da836f318e'
${ noResults }
Trac3r-rust/doc/cgmath/prelude/trait.VectorSpace.html

59 lines
18 KiB
Raw Normal View History Unescape

add doc
5 years ago
<!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 `VectorSpace` trait in crate `cgmath`."><meta name="keywords" content="rust, rustlang, rust-lang, VectorSpace"><title>cgmath::prelude::VectorSpace - 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">&#9776;</div><a href='../../cgmath/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Trait VectorSpace</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.Scalar">Scalar</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.lerp">lerp</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: 'VectorSpace', 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'>&#x2212;</span>]</a></span><a class='srclink' href='../../src/cgmath/structure.rs.html#169-191' 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=''>VectorSpace</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait VectorSpace: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Self: <a class="trait" href="../../cgmath/prelude/trait.Zero.html" title="trait cgmath::prelude::Zero">Zero</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.Add.html" title="trait core::ops::arith::Add">Add</a>&lt;Self, Output = Self&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.Sub.html" title="trait core::ops::arith::Sub">Sub</a>&lt;Self, Output = Self&gt;,<br>&nb
type <a href='#associatedtype.Scalar' class="type">Scalar</a>: <a class="trait" href="../../cgmath/trait.BaseNum.html" title="trait cgmath::BaseNum">BaseNum</a>;
fn <a href='#method.lerp' class='fnname'>lerp</a>(self, other: Self, amount: Self::<a class="type" href="../../cgmath/prelude/trait.VectorSpace.html#associatedtype.Scalar" title="type cgmath::prelude::VectorSpace::Scalar">Scalar</a>) -&gt; Self { ... }
}</pre></div><div class='docblock'><p>Vectors that can be <a href="http://mathworld.wolfram.com/VectorAddition.html">added</a>
together and <a href="https://en.wikipedia.org/wiki/Scalar_multiplication">multiplied</a>
by scalars.</p>
<p>Examples include vectors, matrices, and quaternions.</p>
<h1 id="required-operators" class="section-header"><a href="#required-operators">Required operators</a></h1><h2 id="vector-addition" class="section-header"><a href="#vector-addition">Vector addition</a></h2>
<p>Vectors can be added, subtracted, or negated via the following traits:</p>
<ul>
<li><code>Add&lt;Output = Self&gt;</code></li>
<li><code>Sub&lt;Output = Self&gt;</code></li>
<li><code>Neg&lt;Output = Self&gt;</code></li>
</ul>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">cgmath</span>::<span class="ident">Vector3</span>;
<span class="kw">let</span> <span class="ident">velocity0</span> <span class="op">=</span> <span class="ident">Vector3</span>::<span class="ident">new</span>(<span class="number">1</span>, <span class="number">2</span>, <span class="number">0</span>);
<span class="kw">let</span> <span class="ident">velocity1</span> <span class="op">=</span> <span class="ident">Vector3</span>::<span class="ident">new</span>(<span class="number">1</span>, <span class="number">1</span>, <span class="number">0</span>);
<span class="kw">let</span> <span class="ident">total_velocity</span> <span class="op">=</span> <span class="ident">velocity0</span> <span class="op">+</span> <span class="ident">velocity1</span>;
<span class="kw">let</span> <span class="ident">velocity_diff</span> <span class="op">=</span> <span class="ident">velocity1</span> <span class="op">-</span> <span class="ident">velocity0</span>;
<span class="kw">let</span> <span class="ident">reversed_velocity0</span> <span class="op">=</span> <span class="op">-</span><span class="ident">velocity0</span>;</pre></div>
<p>Vector spaces are also required to implement the additive identity trait,
<code>Zero</code>. Adding this to another vector should have no effect:</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">Vector2</span>;
<span class="kw">let</span> <span class="ident">v</span> <span class="op">=</span> <span class="ident">Vector2</span>::<span class="ident">new</span>(<span class="number">1</span>, <span class="number">2</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">v</span> <span class="op">+</span> <span class="ident">Vector2</span>::<span class="ident">zero</span>(), <span class="ident">v</span>);</pre></div>
<h2 id="scalar-multiplication" class="section-header"><a href="#scalar-multiplication">Scalar multiplication</a></h2>
<p>Vectors can be multiplied or divided by their associated scalars via the
following traits:</p>
<ul>
<li><code>Mul&lt;Self::Scalar, Output = Self&gt;</code></li>
<li><code>Div&lt;Self::Scalar, Output = Self&gt;</code></li>
<li><code>Rem&lt;Self::Scalar, Output = Self&gt;</code></li>
</ul>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">cgmath</span>::<span class="ident">Vector2</span>;
<span class="kw">let</span> <span class="ident">translation</span> <span class="op">=</span> <span class="ident">Vector2</span>::<span class="ident">new</span>(<span class="number">3.0</span>, <span class="number">4.0</span>);
<span class="kw">let</span> <span class="ident">scale_factor</span> <span class="op">=</span> <span class="number">2.0</span>;
<span class="kw">let</span> <span class="ident">upscaled_translation</span> <span class="op">=</span> <span class="ident">translation</span> <span class="op">*</span> <span class="ident">scale_factor</span>;
<span class="kw">let</span> <span class="ident">downscaled_translation</span> <span class="op">=</span> <span class="ident">translation</span> <span class="op">/</span> <span class="ident">scale_factor</span>;</pre></div>
</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.Scalar' class='method'><code id='Scalar.t'>type <a href='#associatedtype.Scalar' class="type">Scalar</a>: <a class="trait" href="../../cgmath/trait.BaseNum.html" title="trait cgmath::BaseNum">BaseNum</a></code></h3><div class='docblock'><p>The associated scalar.</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.lerp' class='method'><code id='lerp.v'>fn <a href='#method.lerp' class='fnname'>lerp</a>(self, other: Self, amount: Self::<a class="type" href="../../cgmath/prelude/trait.VectorSpace.html#associatedtype.Scalar" title="type cgmath::prelude::VectorSpace::Scalar">Scalar</a>) -&gt; Self</code></h3><div class='docblock'><p>Returns the result of linearly interpolating the vector
towards <code>other</code> by the specified amount.</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-VectorSpace' class='impl'><code class='in-band'>impl&lt;S:&nbsp;<a class="trait" href="../../cgmath/trait.BaseFloat.html" title="trait cgmath::BaseFloat">BaseFloat</a>&gt; VectorSpace for <a class="struct" href="../../cgmath/struct.Matrix2.html" title="struct cgmath::Matrix2">Matrix2</a>&lt;S&gt;</code><a href='#impl-VectorSpace' class='anchor'></a><a class='srclink' href='../../src/cgmath/matrix.rs.html#456-458' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Scalar-1' class="type"><code id='Scalar.t-1'>type <a href='#associatedtype.Scalar-1' class="type">Scalar</a> = S</code></h4></div><h3 id='impl-VectorSpace-1' class='impl'><code class='in-band'>impl&lt;S:&nbsp;<a class="trait" href="../../cgmath/trait.BaseFloat.html" title="trait cgmath::BaseFloat">BaseFloat</a>&gt; VectorSpace for <a class="struct" href="../../cgmath/struct.Matrix3.html" title="struct cgmath::Matrix3">Matrix3</a>&lt;S&gt;</code><a href='#impl-VectorSpace-1' class='anchor'></a><a class='srclink' href='../../src/cgmath/matrix.rs.html#460-462' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Scalar-2' class="type"><code id='Scalar.t-2'>type <a href='#associatedtype.Scalar-2' class="type">Scalar</a> = S</code></h4></div><h3 id='impl-VectorSpace-2' class='impl'><code class='in-band'>impl&lt;S:&nbsp;<a class="trait" href="../../cgmath/trait.BaseFloat.html" title="trait cgmath::BaseFloat">BaseFloat</a>&gt; VectorSpace for <a class="struct" href="../../cgmath/struct.Matrix4.html" title="struct cgmath::Matrix4">Matrix4</a>&lt;S&gt;</code><a href='#impl-VectorSpace-2' class='anchor'></a><a class='srclink' href='../../src/cgmath/matrix.rs.html#464-466' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Scalar-3' class="type"><code id='Scalar.t-3'>type <a href='#associatedtype.Scalar-3' class="type">Scalar</a> = S</code></h4></div><h3 id='impl-VectorSpace-3' class='impl'><code class='in-band'>impl&lt;S:&nbsp;<a class="trait" href="../../cgmath/trait.BaseFloat.html" title="trait cgmath::BaseFloat">BaseFloat</a>&gt; VectorSpace for <a class="struct" href="../../cgmath/struct.Quaternion.html" title="struct cgmath::Quaternion">Quaternion</a>&lt;S&gt;</code><a href='#impl-VectorSpace-3' class='anchor'></a><a class='srclink' href='../../src/cgmath/quaternion.rs.html#232-234' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Scalar-4' class="type"><code id='Scalar.t-4'>type <a href='#associatedtype.Scalar-4' class="type">Scalar</a> = S</code></h4></div><h3 id='impl-VectorSpace-4' class='impl'><code class='in-band'>impl&lt;S:&nbsp;<a class="trait" href="../../cgmath/trait.BaseNum.html" title="trait cgmath::BaseNum">BaseNum</a>&gt; VectorSpace for <a class="struct" href="../../cgmath/struct.Vector1.html" title="struct cgmath::Vector1">Vector1</a>&lt;S&gt;</code><a href='#impl-VectorSpace-4' class='anchor'></a><a class='srclink' href='../../src/cgmath/vector.rs.html#199-201' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Scalar-5' class="type"><code id='Scalar.t-5'>type <a href='#associatedtype.Scalar-5' class="type">Scalar</a> = S</code></h4></div><h3 id='impl-VectorSpace-5' class='impl'><code class='in-band'>impl&lt;S:&nbsp;<a class="trait" href="../../cgmath/trait.BaseNum.html" title="trait cgmath::BaseNum">BaseNum</a>&gt; VectorSpace for <a class="struct" href="../../cgmath/struct.Vector2.html" title="struct cgmath::Vector2">Vector2</a>&lt;S&gt;</code><a href='#impl-VectorSpace-5' class='anchor'></a><a class='srclink' href='../../src/cgmath/vector.rs.html#199-201' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Scalar-6' class="type"><code id='Scalar.t-6'>type <a href='#associatedtype.Scalar-6' class="type">Scalar</a> = S</code></h4></div><h3 id='impl-VectorSpace-6' c
src="../../implementors/cgmath/prelude/trait.VectorSpace.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>&#9166;</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>