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.
Trac3r-rust/doc/nalgebra/fn.magnitude_squared.html

17 lines
5.4 KiB

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 `magnitude_squared` fn in crate `nalgebra`."><meta name="keywords" content="rust, rustlang, rust-lang, magnitude_squared"><title>nalgebra::magnitude_squared - 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="http://nalgebra.org/img/favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc fn"><!--[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='../nalgebra/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><p class='location'><a href='index.html'>nalgebra</a></p><script>window.sidebarCurrent = {name: 'magnitude_squared', ty: 'fn', 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/nalgebra/lib.rs.html#551-553' title='goto source code'>[src]</a></span><span class='in-band'>Function <a href='index.html'>nalgebra</a>::<wbr><a class="fn" href=''>magnitude_squared</a></span></h1><pre class='rust fn'>pub fn magnitude_squared&lt;V:&nbsp;<a class="trait" href="../alga/linear/vector/trait.NormedSpace.html" title="trait alga::linear::vector::NormedSpace">NormedSpace</a>&gt;(v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>V) -&gt; V::<a class="type" href="../alga/linear/vector/trait.NormedSpace.html#associatedtype.RealField" title="type alga::linear::vector::NormedSpace::RealField">RealField</a></pre><div class='stability'><div class='stab deprecated'>Deprecated: <p>use <code>Matrix::magnitude_squared</code> or <code>Quaternion::magnitude_squared</code> instead</p>
</div></div><div class='docblock'><p>A synonym for <a href="fn.norm_squared.html"><code>norm_squared</code></a>,
aka length squared.</p>
<h1 id="see-also" class="section-header"><a href="#see-also">See also:</a></h1>
<ul>
<li><a href="fn.magnitude.html"><code>magnitude</code></a></li>
<li><a href="fn.norm.html"><code>norm</code></a></li>
<li><a href="fn.norm_squared.html"><code>norm_squared</code></a></li>
</ul>
<h1 id="deprecated" class="section-header"><a href="#deprecated">Deprecated</a></h1>
<p>Use these methods instead:</p>
<ul>
<li>[Matrix::magnitude_squared]</li>
<li>[Quaternion::magnitude_squared]</li>
</ul>
<p>Or, use <a href="https://docs.rs/alga/0.7.2/alga/linear/trait.NormedSpace.html#tymethod.norm_squared">NormedSpace::norm_squared</a>.</p>
</div></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 = "nalgebra";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>