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.
142 lines
10 KiB
142 lines
10 KiB
<!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 `Complex` trait in crate `complex`.">
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, Complex">
|
|
|
|
<title>complex::Complex - Rust</title>
|
|
|
|
<link rel="stylesheet" type="text/css" href="../main.css">
|
|
|
|
|
|
|
|
</head>
|
|
<body class="rustdoc">
|
|
<!--[if lte IE 8]>
|
|
<div class="warning">
|
|
This old browser is unsupported and will most likely display funky
|
|
things.
|
|
</div>
|
|
<![endif]-->
|
|
|
|
|
|
|
|
<section class="sidebar">
|
|
|
|
<p class='location'><a href='index.html'>complex</a></p><script>window.sidebarCurrent = {name: 'Complex', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script>
|
|
</section>
|
|
|
|
<nav class="sub">
|
|
<form class="search-form js-only">
|
|
<div class="search-container">
|
|
<input class="search-input" name="search"
|
|
autocomplete="off"
|
|
placeholder="Click or press 'S' to search, '?' for more options..."
|
|
type="search">
|
|
</div>
|
|
</form>
|
|
</nav>
|
|
|
|
<section id='main' class="content trait">
|
|
<h1 class='fqn'><span class='in-band'>Trait <a href='index.html'>complex</a>::<wbr><a class='trait' href=''>Complex</a></span><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 id='src-34' class='srclink' href='../src/complex/lib.rs.html#22-61' title='goto source code'>[src]</a></span></h1>
|
|
<pre class='rust trait'>pub trait Complex: <a class='trait' href='../complex/trait.Number.html' title='complex::Number'>Number</a> {
|
|
type Real: <a class='trait' href='../complex/trait.Real.html' title='complex::Real'>Real</a>;
|
|
fn <a href='#tymethod.new' class='fnname'>new</a>(Self::<a class='trait' href='../complex/trait.Complex.html' title='complex::Complex'>Real</a>, Self::<a class='trait' href='../complex/trait.Complex.html' title='complex::Complex'>Real</a>) -> Self;
|
|
fn <a href='#tymethod.from_polar' class='fnname'>from_polar</a>(Self::<a class='trait' href='../complex/trait.Complex.html' title='complex::Complex'>Real</a>, Self::<a class='trait' href='../complex/trait.Complex.html' title='complex::Complex'>Real</a>) -> Self;
|
|
fn <a href='#tymethod.re' class='fnname'>re</a>(&self) -> Self::<a class='trait' href='../complex/trait.Complex.html' title='complex::Complex'>Real</a>;
|
|
fn <a href='#tymethod.re_mut' class='fnname'>re_mut</a>(&mut self) -> &mut Self::<a class='trait' href='../complex/trait.Complex.html' title='complex::Complex'>Real</a>;
|
|
fn <a href='#tymethod.im' class='fnname'>im</a>(&self) -> Self::<a class='trait' href='../complex/trait.Complex.html' title='complex::Complex'>Real</a>;
|
|
fn <a href='#tymethod.im_mut' class='fnname'>im_mut</a>(&mut self) -> &mut Self::<a class='trait' href='../complex/trait.Complex.html' title='complex::Complex'>Real</a>;
|
|
fn <a href='#tymethod.abs' class='fnname'>abs</a>(&self) -> Self::<a class='trait' href='../complex/trait.Complex.html' title='complex::Complex'>Real</a>;
|
|
fn <a href='#tymethod.arg' class='fnname'>arg</a>(&self) -> Self::<a class='trait' href='../complex/trait.Complex.html' title='complex::Complex'>Real</a>;
|
|
|
|
fn <a href='#method.to_polar' class='fnname'>to_polar</a>(&self) -> <a href='http://doc.rust-lang.org/nightly/std/primitive.tuple.html'>(Self::<a class='trait' href='../complex/trait.Complex.html' title='complex::Complex'>Real</a>, Self::<a class='trait' href='../complex/trait.Complex.html' title='complex::Complex'>Real</a>)</a> { ... }
|
|
fn <a href='#method.conj' class='fnname'>conj</a>(&self) -> Self { ... }
|
|
}</pre><div class='docblock'><p>A complex number.</p>
|
|
</div>
|
|
<h2 id='associated-types'>Associated Types</h2>
|
|
<div class='methods'>
|
|
<h3 id='associatedtype.Real' class='method stab '><code>type Real: <a class='trait' href='../complex/trait.Real.html' title='complex::Real'>Real</a></code></h3><div class='docblock'><p>A real number.</p>
|
|
</div></div>
|
|
<h2 id='required-methods'>Required Methods</h2>
|
|
<div class='methods'>
|
|
<h3 id='tymethod.new' class='method stab '><code>fn <a href='#tymethod.new' class='fnname'>new</a>(Self::<a class='trait' href='../complex/trait.Complex.html' title='complex::Complex'>Real</a>, Self::<a class='trait' href='../complex/trait.Complex.html' title='complex::Complex'>Real</a>) -> Self</code></h3><div class='docblock'><p>Create a complex number from a real and an imaginary part.</p>
|
|
</div><h3 id='tymethod.from_polar' class='method stab '><code>fn <a href='#tymethod.from_polar' class='fnname'>from_polar</a>(Self::<a class='trait' href='../complex/trait.Complex.html' title='complex::Complex'>Real</a>, Self::<a class='trait' href='../complex/trait.Complex.html' title='complex::Complex'>Real</a>) -> Self</code></h3><div class='docblock'><p>Create a complex number from a modulus and an argument.</p>
|
|
</div><h3 id='tymethod.re' class='method stab '><code>fn <a href='#tymethod.re' class='fnname'>re</a>(&self) -> Self::<a class='trait' href='../complex/trait.Complex.html' title='complex::Complex'>Real</a></code></h3><div class='docblock'><p>Return the real part.</p>
|
|
</div><h3 id='tymethod.re_mut' class='method stab '><code>fn <a href='#tymethod.re_mut' class='fnname'>re_mut</a>(&mut self) -> &mut Self::<a class='trait' href='../complex/trait.Complex.html' title='complex::Complex'>Real</a></code></h3><div class='docblock'><p>Return the real part as a mutable reference.</p>
|
|
</div><h3 id='tymethod.im' class='method stab '><code>fn <a href='#tymethod.im' class='fnname'>im</a>(&self) -> Self::<a class='trait' href='../complex/trait.Complex.html' title='complex::Complex'>Real</a></code></h3><div class='docblock'><p>Return the imaginary part.</p>
|
|
</div><h3 id='tymethod.im_mut' class='method stab '><code>fn <a href='#tymethod.im_mut' class='fnname'>im_mut</a>(&mut self) -> &mut Self::<a class='trait' href='../complex/trait.Complex.html' title='complex::Complex'>Real</a></code></h3><div class='docblock'><p>Return the imaginary part as a mutable reference.</p>
|
|
</div><h3 id='tymethod.abs' class='method stab '><code>fn <a href='#tymethod.abs' class='fnname'>abs</a>(&self) -> Self::<a class='trait' href='../complex/trait.Complex.html' title='complex::Complex'>Real</a></code></h3><div class='docblock'><p>Compute the modulus.</p>
|
|
</div><h3 id='tymethod.arg' class='method stab '><code>fn <a href='#tymethod.arg' class='fnname'>arg</a>(&self) -> Self::<a class='trait' href='../complex/trait.Complex.html' title='complex::Complex'>Real</a></code></h3><div class='docblock'><p>Compute the argument.</p>
|
|
</div></div>
|
|
<h2 id='provided-methods'>Provided Methods</h2>
|
|
<div class='methods'>
|
|
<h3 id='method.to_polar' class='method stab '><code>fn <a href='#method.to_polar' class='fnname'>to_polar</a>(&self) -> <a href='http://doc.rust-lang.org/nightly/std/primitive.tuple.html'>(Self::<a class='trait' href='../complex/trait.Complex.html' title='complex::Complex'>Real</a>, Self::<a class='trait' href='../complex/trait.Complex.html' title='complex::Complex'>Real</a>)</a></code></h3><div class='docblock'><p>Compute the modulus and the argument.</p>
|
|
</div><h3 id='method.conj' class='method stab '><code>fn <a href='#method.conj' class='fnname'>conj</a>(&self) -> Self</code></h3><div class='docblock'><p>Compute the complex conjugate.</p>
|
|
</div></div>
|
|
<h2 id='implementors'>Implementors</h2>
|
|
<ul class='item-list' id='implementors-list'>
|
|
<li><code>impl <a class='trait' href='../complex/trait.Complex.html' title='complex::Complex'>Complex</a> for <a class='struct' href='../complex/struct.c32.html' title='complex::c32'>c32</a></code></li>
|
|
<li><code>impl <a class='trait' href='../complex/trait.Complex.html' title='complex::Complex'>Complex</a> for <a class='struct' href='../complex/struct.c64.html' title='complex::c64'>c64</a></code></li>
|
|
</ul><script type="text/javascript" async
|
|
src="../implementors/complex/trait.Complex.js">
|
|
</script></section>
|
|
<section id='search' class="content hidden"></section>
|
|
|
|
<section class="footer"></section>
|
|
|
|
<div id="help" class="hidden">
|
|
<div class="shortcuts">
|
|
<h1>Keyboard shortcuts</h1>
|
|
<dl>
|
|
<dt>?</dt>
|
|
<dd>Show this help dialog</dd>
|
|
<dt>S</dt>
|
|
<dd>Focus the search field</dd>
|
|
<dt>⇤</dt>
|
|
<dd>Move up in search results</dd>
|
|
<dt>⇥</dt>
|
|
<dd>Move down in search results</dd>
|
|
<dt>⏎</dt>
|
|
<dd>Go to active search result</dd>
|
|
</dl>
|
|
</div>
|
|
<div class="infos">
|
|
<h1>Search tricks</h1>
|
|
<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>typedef</code> (or
|
|
<code>tdef</code>).
|
|
</p>
|
|
<p>
|
|
Search functions by type signature (e.g.
|
|
<code>vec -> usize</code>)
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<script>
|
|
window.rootPath = "../";
|
|
window.currentCrate = "complex";
|
|
window.playgroundUrl = "";
|
|
</script>
|
|
<script src="../jquery.js"></script>
|
|
<script src="../main.js"></script>
|
|
|
|
<script async src="../search-index.js"></script>
|
|
</body>
|
|
</html>
|