|
|
|
|
|
<!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 `InnerSpace` trait in crate `cgmath`."><meta name="keywords" content="rust, rustlang, rust-lang, InnerSpace"><title>cgmath::prelude::InnerSpace - 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 InnerSpace</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.dot">dot</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.angle">angle</a><a href="#method.is_perpendicular">is_perpendicular</a><a href="#method.magnitude">magnitude</a><a href="#method.magnitude2">magnitude2</a><a href="#method.normalize">normalize</a><a href="#method.normalize_to">normalize_to</a><a href="#method.project_on">project_on</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: 'InnerSpace', 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#220-278' 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=''>InnerSpace</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait InnerSpace: <a class="trait" href="../../cgmath/prelude/trait.VectorSpace.html" title="trait cgmath::prelude::VectorSpace">VectorSpace</a> <span class="where fmt-newline">where<br> Self::<a class="type" href="../../cgmath/prelude/trait.VectorSpace.html#associatedtype.Scalar" title="type cgmath::prelude::VectorSpace::Scalar">Scalar</a>: <a class="trait" href="../../cgmath/trait.BaseFloat.html" title="trait cgmath::BaseFloat">BaseFloat</a>,<br> Self: <a class="trait" href="../../cgmath/prelude/trait.MetricSpace.html" title="trait cgmath::
|
|
|
|
|
|
fn <a href='#tymethod.dot' class='fnname'>dot</a>(self, other: Self) -> Self::<a class="type" href="../../cgmath/prelude/trait.VectorSpace.html#associatedtype.Scalar" title="type cgmath::prelude::VectorSpace::Scalar">Scalar</a>;
|
|
|
|
|
|
|
|
|
|
|
|
fn <a href='#method.is_perpendicular' class='fnname'>is_perpendicular</a>(self, other: Self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> { ... }
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#method.magnitude2' class='fnname'>magnitude2</a>(self) -> Self::<a class="type" href="../../cgmath/prelude/trait.VectorSpace.html#associatedtype.Scalar" title="type cgmath::prelude::VectorSpace::Scalar">Scalar</a> { ... }
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#method.magnitude' class='fnname'>magnitude</a>(self) -> Self::<a class="type" href="../../cgmath/prelude/trait.VectorSpace.html#associatedtype.Scalar" title="type cgmath::prelude::VectorSpace::Scalar">Scalar</a> { ... }
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#method.angle' class='fnname'>angle</a>(self, other: Self) -> <a class="struct" href="../../cgmath/struct.Rad.html" title="struct cgmath::Rad">Rad</a><Self::<a class="type" href="../../cgmath/prelude/trait.VectorSpace.html#associatedtype.Scalar" title="type cgmath::prelude::VectorSpace::Scalar">Scalar</a>> { ... }
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#method.normalize' class='fnname'>normalize</a>(self) -> Self { ... }
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#method.normalize_to' class='fnname'>normalize_to</a>(self, magnitude: Self::<a class="type" href="../../cgmath/prelude/trait.VectorSpace.html#associatedtype.Scalar" title="type cgmath::prelude::VectorSpace::Scalar">Scalar</a>) -> Self { ... }
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#method.project_on' class='fnname'>project_on</a>(self, other: Self) -> Self { ... }
|
|
|
|
|
|
}</pre></div><div class='docblock'><p>Vectors that also have a <a href="https://en.wikipedia.org/wiki/Dot_product">dot</a>
|
|
|
|
|
|
(or <a href="https://en.wikipedia.org/wiki/Inner_product_space">inner</a>) product.</p>
|
|
|
|
|
|
<p>The dot product allows for the definition of other useful operations, like
|
|
|
|
|
|
finding the magnitude of a vector or normalizing it.</p>
|
|
|
|
|
|
<p>Examples include vectors and quaternions.</p>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.dot' class='method'><code id='dot.v'>fn <a href='#tymethod.dot' class='fnname'>dot</a>(self, other: Self) -> Self::<a class="type" href="../../cgmath/prelude/trait.VectorSpace.html#associatedtype.Scalar" title="type cgmath::prelude::VectorSpace::Scalar">Scalar</a></code></h3><div class='docblock'><p>Vector dot (or inner) product.</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.is_perpendicular' class='method'><code id='is_perpendicular.v'>fn <a href='#method.is_perpendicular' class='fnname'>is_perpendicular</a>(self, other: Self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></h3><div class='docblock'><p>Returns <code>true</code> if the vector is perpendicular (at right angles) to the
|
|
|
|
|
|
other vector.</p>
|
|
|
|
|
|
</div><h3 id='method.magnitude2' class='method'><code id='magnitude2.v'>fn <a href='#method.magnitude2' class='fnname'>magnitude2</a>(self) -> Self::<a class="type" href="../../cgmath/prelude/trait.VectorSpace.html#associatedtype.Scalar" title="type cgmath::prelude::VectorSpace::Scalar">Scalar</a></code></h3><div class='docblock'><p>Returns the squared magnitude.</p>
|
|
|
|
|
|
<p>This does not perform an expensive square root operation like in
|
|
|
|
|
|
<code>InnerSpace::magnitude</code> method, and so can be used to compare magnitudes
|
|
|
|
|
|
more efficiently.</p>
|
|
|
|
|
|
</div><h3 id='method.magnitude' class='method'><code id='magnitude.v'>fn <a href='#method.magnitude' class='fnname'>magnitude</a>(self) -> Self::<a class="type" href="../../cgmath/prelude/trait.VectorSpace.html#associatedtype.Scalar" title="type cgmath::prelude::VectorSpace::Scalar">Scalar</a></code></h3><div class='docblock'><p>The distance from the tail to the tip of the vector.</p>
|
|
|
|
|
|
</div><h3 id='method.angle' class='method'><code id='angle.v'>fn <a href='#method.angle' class='fnname'>angle</a>(self, other: Self) -> <a class="struct" href="../../cgmath/struct.Rad.html" title="struct cgmath::Rad">Rad</a><Self::<a class="type" href="../../cgmath/prelude/trait.VectorSpace.html#associatedtype.Scalar" title="type cgmath::prelude::VectorSpace::Scalar">Scalar</a>></code></h3><div class='docblock'><p>Returns the angle between two vectors in radians.</p>
|
|
|
|
|
|
</div><h3 id='method.normalize' class='method'><code id='normalize.v'>fn <a href='#method.normalize' class='fnname'>normalize</a>(self) -> Self</code></h3><div class='docblock'><p>Returns a vector with the same direction, but with a magnitude of <code>1</code>.</p>
|
|
|
|
|
|
</div><h3 id='method.normalize_to' class='method'><code id='normalize_to.v'>fn <a href='#method.normalize_to' class='fnname'>normalize_to</a>(self, magnitude: Self::<a class="type" href="../../cgmath/prelude/trait.VectorSpace.html#associatedtype.Scalar" title="type cgmath::prelude::VectorSpace::Scalar">Scalar</a>) -> Self</code></h3><div class='docblock'><p>Returns a vector with the same direction and a given magnitude.</p>
|
|
|
|
|
|
</div><h3 id='method.project_on' class='method'><code id='project_on.v'>fn <a href='#method.project_on' class='fnname'>project_on</a>(self, other: Self) -> Self</code></h3><div class='docblock'><p>Returns the
|
|
|
|
|
|
<a href="https://en.wikipedia.org/wiki/Vector_projection">vector projection</a>
|
|
|
|
|
|
of the current inner space projected onto the supplied argument.</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-InnerSpace' class='impl'><code class='in-band'>impl<S: <a class="trait" href="../../cgmath/trait.BaseFloat.html" title="trait cgmath::BaseFloat">BaseFloat</a>> InnerSpace for <a class="struct" href="../../cgmath/struct.Quaternion.html" title="struct cgmath::Quaternion">Quaternion</a><S></code><a href='#impl-InnerSpace' class='anchor'></a><a class='srclink' href='../../src/cgmath/quaternion.rs.html#261-266' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.dot' class="method hidden"><code id='dot.v-1'>fn <a href='#method.dot' class='fnname'>dot</a>(self, other: <a class="struct" href="../../cgmath/struct.Quaternion.html" title="struct cgmath::Quaternion">Quaternion</a><S>) -> S</code><a class='srclink' href='../../src/cgmath/quaternion.rs.html#263-265' title='goto source code'>[src]</a></h4></div><h3 id='impl-InnerSpace-1' class='impl'><code class='in-band'>impl<S: <a class="trait" href="../../cgmath/trait.BaseFloat.html" title="trait cgmath::BaseFloat">BaseFloat</a>> InnerSpace for <a class="struct" href="../../cgmath/struct.Vector1.html" title="struct cgmath::Vector1">Vector1</a><S></code><a href='#impl-InnerSpace-1' class='anchor'></a><a class='srclink' href='../../src/cgmath/vector.rs.html#788-793' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.dot-1' class="method hidden"><code id='dot.v-2'>fn <a href='#method.dot-1' class='fnname'>dot</a>(self, other: <a class="struct" href="../../cgmath/struct.Vector1.html" title="struct cgmath::Vector1">Vector1</a><S>) -> S</code><a class='srclink' href='../../src/cgmath/vector.rs.html#790-792' title='goto source code'>[src]</a></h4></div><h3 id='impl-InnerSpace-2' class='impl'><code class='in-band'>impl<S: <a class="trait" href="../../cgmath/trait.BaseFloat.html" title="trait cgmath::BaseFloat">BaseFloat</a>> InnerSpace for <a class="struct" href="../../cgmath/struct.Vector2.html" title="struct cgmath::Vector2">Vector2</a><S></code><a href='#impl-InnerSpace-2' class='anchor'></a><a class='srclink' href='../../src/cgmath/vector.rs.html#795-805' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.dot-2' class="method hidden"><code id='dot.v-3'>fn <a href='#method.dot-2' class='fnname'>dot</a>(self, other: <a class="struct" href="../../cgmath/struct.Vector2.html" title="struct cgmath::Vector2">Vector2</a><S>) -> S</code><a class='srclink' href='../../src/cgmath/vector.rs.html#797-799' title='goto source code'>[src]</a></h4><h4 id='method.angle-1' class="method hidden"><code id='angle.v-1'>fn <a href='#method.angle-1' class='fnname'>angle</a>(self, other: <a class="struct" href="../../cgmath/struct.Vector2.html" title="struct cgmath::Vector2">Vector2</a><S>) -> <a class="struct" href="../../cgmath/struct.Rad.html" title="struct cgmath::Rad">Rad</a><S></code><a class='srclink' href='../../src/cgmath/vector.rs.html#802-804' title='goto source code'>[src]</a></h4></div><h3 id='impl-InnerSpace-3' class='impl'><code class='in-band'>impl<S: <a class="trait" href="../../cgmath/trait.BaseFloat.html" title="trait cgmath::BaseFloat">BaseFloat</a>> InnerSpace for <a class="struct" href="../../cgmath/struct.Vector3.html" title="struct cgmath::Vector3">Vector3</a><S></code><a href='#impl-InnerSpace-3' class='anchor'></a><a class='srclink' href='../../src/cgmath/vector.rs.html#807-817' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.dot-3' class="method hidden"><code id='dot.v-4'>fn <a href='#method.dot-3' class='fnname'>dot</a>(self, other: <a class="struct" href="../../cgmath/struct.Vector3.html" title="struct cgmath::Vector3">Vector3</a><S>) -> S</code><a class='srclink' href='../../src/cgmath/vector.rs.html#809-811' title='goto source code'>[src]</a></h4><h4 id='method.angle-2' class=
|
|
|
|
|
|
src="../../implementors/cgmath/prelude/trait.InnerSpace.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>
|
