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.
150 lines
82 KiB
150 lines
82 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 `ComplexField` trait in crate `alga`."><meta name="keywords" content="rust, rustlang, rust-lang, ComplexField"><title>alga::general::ComplexField - 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='../../alga/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Trait ComplexField</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.RealField">RealField</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.abs">abs</a><a href="#tymethod.acos">acos</a><a href="#tymethod.acosh">acosh</a><a href="#tymethod.argument">argument</a><a href="#tymethod.asin">asin</a><a href="#tymethod.asinh">asinh</a><a href="#tymethod.atan">atan</a><a href="#tymethod.atanh">atanh</a><a href="#tymethod.cbrt">cbrt</a><a href="#tymethod.ceil">ceil</a><a href="#tymethod.conjugate">conjugate</a><a href="#tymethod.cos">cos</a><a href="#tymethod.cosh">cosh</a><a href="#tymethod.exp">exp</a><a href="#tymethod.exp2">exp2</a><a href="#tymethod.exp_m1">exp_m1</a><a href="#tymethod.floor">floor</a><a href="#tymethod.fract">fract</a><a href="#tymethod.from_real">from_real</a><a href="#tymethod.hypot">hypot</a><a href="#tymethod.imaginary">imaginary</a><a href="#tymethod.is_finite">is_finite</a><a href="#tymethod.ln">ln</a><a href="#tymethod.ln_1p">ln_1p</a><a href="#tymethod.log">log</a><a href="#tymethod.log10">log10</a><a href="#tymethod.log2">log2</a><a href="#tymethod.modulus">modulus</a><a href="#tymethod.modulus_squared">modulus_squared</a><a href="#tymethod.mul_add">mul_add</a><a href="#tymethod.norm1">norm1</a><a href="#tymethod.powc">powc</a><a href="#tymethod.powf">powf</a><a href="#tymethod.powi">powi</a><a href="#tymethod.real">real</a><a href="#tymethod.recip">recip</a><a href="#tymethod.round">round</a><a href="#tymethod.scale">scale</a><a href="#tymethod.sin">sin</a><a href="#tymethod.sin_cos">sin_cos</a><a href="#tymethod.sinh">sinh</a><a href="#tymethod.sqrt">sqrt</a><a href="#tymethod.tan">tan</a><a href="#tymethod.tanh">tanh</a><a href="#tymethod.trunc">trunc</a><a href="#tymethod.try_sqrt">try_sqrt</a><a href="#tymethod.unscale">unscale</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.cosc">cosc</a><a href="#method.coshc">coshc</a><a href="#method.signum">signum</a><a href="#method.sinc">sinc</a><a href="#method.sinh_cosh">sinh_cosh</a><a href="#method.sinhc">sinhc</a><a href="#method.to_exp">to_exp</a><a href="#method.to_polar">to_polar</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-ComplexField-for-Complex%3CN%3E">Complex<N></a><a href="#impl-ComplexField-for-f32">f32</a><a href="#impl-ComplexField-for-f64">f64</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../index.html'>alga</a>::<wbr><a href='index.html'>gene
|
||
|
|
type <a href='#associatedtype.RealField' class="type">RealField</a>: <a class="trait" href="../../alga/general/trait.RealField.html" title="trait alga::general::RealField">RealField</a>;
|
||
|
|
fn <a href='#tymethod.from_real' class='fnname'>from_real</a>(re: Self::<a class="type" href="../../alga/general/trait.ComplexField.html#associatedtype.RealField" title="type alga::general::ComplexField::RealField">RealField</a>) -> Self;
|
||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.real' class='fnname'>real</a>(self) -> Self::<a class="type" href="../../alga/general/trait.ComplexField.html#associatedtype.RealField" title="type alga::general::ComplexField::RealField">RealField</a>;
|
||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.imaginary' class='fnname'>imaginary</a>(self) -> Self::<a class="type" href="../../alga/general/trait.ComplexField.html#associatedtype.RealField" title="type alga::general::ComplexField::RealField">RealField</a>;
|
||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.modulus' class='fnname'>modulus</a>(self) -> Self::<a class="type" href="../../alga/general/trait.ComplexField.html#associatedtype.RealField" title="type alga::general::ComplexField::RealField">RealField</a>;
|
||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.modulus_squared' class='fnname'>modulus_squared</a>(self) -> Self::<a class="type" href="../../alga/general/trait.ComplexField.html#associatedtype.RealField" title="type alga::general::ComplexField::RealField">RealField</a>;
|
||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.argument' class='fnname'>argument</a>(self) -> Self::<a class="type" href="../../alga/general/trait.ComplexField.html#associatedtype.RealField" title="type alga::general::ComplexField::RealField">RealField</a>;
|
||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.norm1' class='fnname'>norm1</a>(self) -> Self::<a class="type" href="../../alga/general/trait.ComplexField.html#associatedtype.RealField" title="type alga::general::ComplexField::RealField">RealField</a>;
|
||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.scale' class='fnname'>scale</a>(self, factor: Self::<a class="type" href="../../alga/general/trait.ComplexField.html#associatedtype.RealField" title="type alga::general::ComplexField::RealField">RealField</a>) -> Self;
|
||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.unscale' class='fnname'>unscale</a>(self, factor: Self::<a class="type" href="../../alga/general/trait.ComplexField.html#associatedtype.RealField" title="type alga::general::ComplexField::RealField">RealField</a>) -> Self;
|
||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.floor' class='fnname'>floor</a>(self) -> Self;
|
||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.ceil' class='fnname'>ceil</a>(self) -> Self;
|
||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.round' class='fnname'>round</a>(self) -> Self;
|
||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.trunc' class='fnname'>trunc</a>(self) -> Self;
|
||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.fract' class='fnname'>fract</a>(self) -> Self;
|
||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.mul_add' class='fnname'>mul_add</a>(self, a: Self, b: Self) -> Self;
|
||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.abs' class='fnname'>abs</a>(self) -> Self::<a class="type" href="../../alga/general/trait.ComplexField.html#associatedtype.RealField" title="type alga::general::ComplexField::RealField">RealField</a>;
|
||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.hypot' class='fnname'>hypot</a>(self, other: Self) -> Self::<a class="type" href="../../alga/general/trait.ComplexField.html#associatedtype.RealField" title="type alga::general::ComplexField::RealField">RealField</a>;
|
||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.recip' class='fnname'>recip</a>(self) -> Self;
|
||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.conjugate' class='fnname'>conjugate</a>(self) -> Self;
|
||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.sin' class='fnname'>sin</a>(self) -> Self;
|
||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.cos' class='fnname'>cos</a>(self) -> Self;
|
||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.sin_cos' class='fnname'>sin_cos</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>Self, Self<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>;
|
||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.tan' class='fnname'>tan</a>(self) -> Self;
|
||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.asin' class='fnname'>asin</a>(self) -> Self;
|
||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.acos' class='fnname'>acos</a>(self) -> Self;
|
||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.atan' class='fnname'>atan</a>(self) -> Self;
|
||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.sinh' class='fnname'>sinh</a>(self) -> Self;
|
||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.cosh' class='fnname'>cosh</a>(self) -> Self;
|
||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.tanh' class='fnname'>tanh</a>(self) -> Self;
|
||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.asinh' class='fnname'>asinh</a>(self) -> Self;
|
||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.acosh' class='fnname'>acosh</a>(self) -> Self;
|
||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.atanh' class='fnname'>atanh</a>(self) -> Self;
|
||
|
|
<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>;
|
||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.log' class='fnname'>log</a>(self, base: Self::<a class="type" href="../../alga/general/trait.ComplexField.html#associatedtype.RealField" title="type alga::general::ComplexField::RealField">RealField</a>) -> Self;
|
||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.log2' class='fnname'>log2</a>(self) -> Self;
|
||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.log10' class='fnname'>log10</a>(self) -> Self;
|
||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.ln' class='fnname'>ln</a>(self) -> Self;
|
||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.ln_1p' class='fnname'>ln_1p</a>(self) -> Self;
|
||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.sqrt' class='fnname'>sqrt</a>(self) -> Self;
|
||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.try_sqrt' class='fnname'>try_sqrt</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self>;
|
||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.exp' class='fnname'>exp</a>(self) -> Self;
|
||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.exp2' class='fnname'>exp2</a>(self) -> Self;
|
||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.exp_m1' class='fnname'>exp_m1</a>(self) -> Self;
|
||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.powi' class='fnname'>powi</a>(self, n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>) -> Self;
|
||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.powf' class='fnname'>powf</a>(self, n: Self::<a class="type" href="../../alga/general/trait.ComplexField.html#associatedtype.RealField" title="type alga::general::ComplexField::RealField">RealField</a>) -> Self;
|
||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.powc' class='fnname'>powc</a>(self, n: Self) -> Self;
|
||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.cbrt' class='fnname'>cbrt</a>(self) -> Self;
|
||
|
|
|
||
|
|
fn <a href='#method.to_polar' class='fnname'>to_polar</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>Self::<a class="type" href="../../alga/general/trait.ComplexField.html#associatedtype.RealField" title="type alga::general::ComplexField::RealField">RealField</a>, Self::<a class="type" href="../../alga/general/trait.ComplexField.html#associatedtype.RealField" title="type alga::general::ComplexField::RealField">RealField</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a> { ... }
|
||
|
|
<div class='item-spacer'></div> fn <a href='#method.to_exp' class='fnname'>to_exp</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>Self::<a class="type" href="../../alga/general/trait.ComplexField.html#associatedtype.RealField" title="type alga::general::ComplexField::RealField">RealField</a>, Self<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a> { ... }
|
||
|
|
<div class='item-spacer'></div> fn <a href='#method.signum' class='fnname'>signum</a>(self) -> Self { ... }
|
||
|
|
<div class='item-spacer'></div> fn <a href='#method.sinh_cosh' class='fnname'>sinh_cosh</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>Self, Self<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a> { ... }
|
||
|
|
<div class='item-spacer'></div> fn <a href='#method.sinc' class='fnname'>sinc</a>(self) -> Self { ... }
|
||
|
|
<div class='item-spacer'></div> fn <a href='#method.sinhc' class='fnname'>sinhc</a>(self) -> Self { ... }
|
||
|
|
<div class='item-spacer'></div> fn <a href='#method.cosc' class='fnname'>cosc</a>(self) -> Self { ... }
|
||
|
|
<div class='item-spacer'></div> fn <a href='#method.coshc' class='fnname'>coshc</a>(self) -> Self { ... }
|
||
|
|
}</pre></div><div class='docblock'><p>Trait shared by all complex fields and its subfields (like real numbers).</p>
|
||
|
|
<p>Complex numbers are equipped with functions that are commonly used on complex numbers and reals.
|
||
|
|
The results of those functions only have to be approximately equal to the actual theoretical values.</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.RealField' class='method'><code id='RealField.t'>type <a href='#associatedtype.RealField' class="type">RealField</a>: <a class="trait" href="../../alga/general/trait.RealField.html" title="trait alga::general::RealField">RealField</a></code></h3><div class='docblock'><p>Type of the coefficients of a complex number.</p>
|
||
|
|
</div></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.from_real' class='method'><code id='from_real.v'>fn <a href='#tymethod.from_real' class='fnname'>from_real</a>(re: Self::<a class="type" href="../../alga/general/trait.ComplexField.html#associatedtype.RealField" title="type alga::general::ComplexField::RealField">RealField</a>) -> Self</code></h3><div class='docblock'><p>Builds a pure-real complex number from the given value.</p>
|
||
|
|
</div><h3 id='tymethod.real' class='method'><code id='real.v'>fn <a href='#tymethod.real' class='fnname'>real</a>(self) -> Self::<a class="type" href="../../alga/general/trait.ComplexField.html#associatedtype.RealField" title="type alga::general::ComplexField::RealField">RealField</a></code></h3><div class='docblock'><p>The real part of this complex number.</p>
|
||
|
|
</div><h3 id='tymethod.imaginary' class='method'><code id='imaginary.v'>fn <a href='#tymethod.imaginary' class='fnname'>imaginary</a>(self) -> Self::<a class="type" href="../../alga/general/trait.ComplexField.html#associatedtype.RealField" title="type alga::general::ComplexField::RealField">RealField</a></code></h3><div class='docblock'><p>The imaginary part of this complex number.</p>
|
||
|
|
</div><h3 id='tymethod.modulus' class='method'><code id='modulus.v'>fn <a href='#tymethod.modulus' class='fnname'>modulus</a>(self) -> Self::<a class="type" href="../../alga/general/trait.ComplexField.html#associatedtype.RealField" title="type alga::general::ComplexField::RealField">RealField</a></code></h3><div class='docblock'><p>The modulus of this complex number.</p>
|
||
|
|
</div><h3 id='tymethod.modulus_squared' class='method'><code id='modulus_squared.v'>fn <a href='#tymethod.modulus_squared' class='fnname'>modulus_squared</a>(self) -> Self::<a class="type" href="../../alga/general/trait.ComplexField.html#associatedtype.RealField" title="type alga::general::ComplexField::RealField">RealField</a></code></h3><div class='docblock'><p>The squared modulus of this complex number.</p>
|
||
|
|
</div><h3 id='tymethod.argument' class='method'><code id='argument.v'>fn <a href='#tymethod.argument' class='fnname'>argument</a>(self) -> Self::<a class="type" href="../../alga/general/trait.ComplexField.html#associatedtype.RealField" title="type alga::general::ComplexField::RealField">RealField</a></code></h3><div class='docblock'><p>The argument of this complex number.</p>
|
||
|
|
</div><h3 id='tymethod.norm1' class='method'><code id='norm1.v'>fn <a href='#tymethod.norm1' class='fnname'>norm1</a>(self) -> Self::<a class="type" href="../../alga/general/trait.ComplexField.html#associatedtype.RealField" title="type alga::general::ComplexField::RealField">RealField</a></code></h3><div class='docblock'><p>The sum of the absolute value of this complex number's real and imaginary part.</p>
|
||
|
|
</div><h3 id='tymethod.scale' class='method'><code id='scale.v'>fn <a href='#tymethod.scale' class='fnname'>scale</a>(self, factor: Self::<a class="type" href="../../alga/general/trait.ComplexField.html#associatedtype.RealField" title="type alga::general::ComplexField::RealField">RealField</a>) -> Self</code></h3><div class='docblock'><p>Multiplies this complex number by <code>factor</code>.</p>
|
||
|
|
</div><h3 id='tymethod.unscale' class='method'><code id='unscale.v'>fn <a href='#tymethod.unscale' class='fnname'>unscale</a>(self, factor: Self::<a class="type" href="../../alga/general/trait.ComplexField.html#associatedtype.RealField" title="type alga::general::ComplexField::RealField">RealField</a>) -> Self</code></h3><div class='docblock'><p>Multiplies this complex number by <code>factor</code>.</p>
|
||
|
|
</div><h3 id='tymethod.floor' class='method'><code id='floor.v'>fn <a href='#tymethod.floor' class='fnname'>floor</a>(self) -> Self</code></h3><h3 id='tymethod.ceil' class='method'><code id='ceil.v'>fn <a href='#tymethod.ceil' class='fnname'>ceil</a>(self) -> Self</code></h3><h3 id='tymethod.round' class='method'><code id='round.v'>fn <a href='#tymethod.round' class='fnname'>round</a>(self) -> Self</code></h3><h3 id='tymethod.trunc' class='method'><code id='trunc.v'>fn <a href='#tymethod.trunc' class='fnname'>trunc</a>(self) -> Self</code></h3><h3 id='tymethod.fract' class='method'><code id='fract.v'>fn <a href='#tymethod.fract' class='fnname'>fract</a>(self) -> Self</code></h3><h3 id='tymethod.mul_add' class='method'><code id='mul_add.v'>fn <a href='#tymethod.mul_add' class='fnname'>mul_add</a>(self, a: Self, b: Self) -> Self</code></h3><h3 id='tymethod.abs' class='method'><code id='abs.v'>fn <a href='#tymethod.abs' class='fnname'>abs</a>(self) -> Self::<a class="type" href="../../alga/general/trait.ComplexField.html#associatedtype.RealField" title="type alga::general::ComplexField::RealField">RealField</a></code></h3><div class='docblock'><p>The absolute value of this complex number: <code>self / self.signum()</code>.</p>
|
||
|
|
<p>This is equivalent to <code>self.modulus()</code>.</p>
|
||
|
|
</div><h3 id='tymethod.hypot' class='method'><code id='hypot.v'>fn <a href='#tymethod.hypot' class='fnname'>hypot</a>(self, other: Self) -> Self::<a class="type" href="../../alga/general/trait.ComplexField.html#associatedtype.RealField" title="type alga::general::ComplexField::RealField">RealField</a></code></h3><div class='docblock'><p>Computes (self.conjugate() * self + other.conjugate() * other).sqrt()</p>
|
||
|
|
</div><h3 id='tymethod.recip' class='method'><code id='recip.v'>fn <a href='#tymethod.recip' class='fnname'>recip</a>(self) -> Self</code></h3><h3 id='tymethod.conjugate' class='method'><code id='conjugate.v'>fn <a href='#tymethod.conjugate' class='fnname'>conjugate</a>(self) -> Self</code></h3><h3 id='tymethod.sin' class='method'><code id='sin.v'>fn <a href='#tymethod.sin' class='fnname'>sin</a>(self) -> Self</code></h3><h3 id='tymethod.cos' class='method'><code id='cos.v'>fn <a href='#tymethod.cos' class='fnname'>cos</a>(self) -> Self</code></h3><h3 id='tymethod.sin_cos' class='method'><code id='sin_cos.v'>fn <a href='#tymethod.sin_cos' class='fnname'>sin_cos</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>Self, Self<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code></h3><h3 id='tymethod.tan' class='method'><code id='tan.v'>fn <a href='#tymethod.tan' class='fnname'>tan</a>(self) -> Self</code></h3><h3 id='tymethod.asin' class='method'><code id='asin.v'>fn <a href='#tymethod.asin' class='fnname'>asin</a>(self) -> Self</code></h3><h3 id='tymethod.acos' class='method'><code id='acos.v'>fn <a href='#tymethod.acos' class='fnname'>acos</a>(self) -> Self</code></h3><h3 id='tymethod.atan' class='method'><code id='atan.v'>fn <a href='#tymethod.atan' class='fnname'>atan</a>(self) -> Self</code></h3><h3 id='tymethod.sinh' class='method'><code id='sinh.v'>fn <a href='#tymethod.sinh' class='fnname'>sinh</a>(self) -> Self</code></h3><h3 id='tymethod.cosh' class='method'><code id='cosh.v'>fn <a href='#tymethod.cosh' class='fnname'>cosh</a>(self) -> Self</code></h3><h3 id='tymethod.tanh' class='method'><code id='tanh.v'>fn <a href='#tymethod.tanh' class='fnname'>tanh</a>(self) -> Self</code></h3><h3 id='tymethod.asinh' class='method'><code id='asinh.v'>fn <a href='#tymethod.asinh' class='fnname'>asinh</a>(self) -> Self</code></h3><h3 id='tymethod.acosh' class='method'><code id='acosh.v'>fn <a href='#tymethod.acosh' class='fnname'>acosh</a>(self) -> Self</code></h3><h3 id='tymethod.atanh' class='method'><code id='atanh.v'>fn <a href='#tymethod.atanh' class='fnname'>atanh</a>(self) -> Self</code></h3><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></code></h3><h3 id='tymethod.log' class='method'><code id='log.v'>fn <a href='#tymethod.log' class='fnname'>log</a>(self, base: Self::<a class="type" href="../../alga/general/trait.ComplexField.html#associatedtype.RealField" title="type alga::general::ComplexField::RealField">RealField</a>) -> Self</code></h3><h3 id='tymethod.log2' class='method'><code id='log2.v'>fn <a href='#tymethod.log2' class='fnname'>log2</a>(self) -> Self</code></h3><h3 id='tymethod.log10' class='method'><code id='log10.v'>fn <a href='#tymethod.log10' class='fnname'>log10</a>(self) -> Self</code></h3><h3 id='tymethod.ln' class='method'><code id='ln.v'>fn <a href='#tymethod.ln' class='fnname'>ln</a>(self) -> Self</code></h3><h3 id='tymethod.ln_1p' class='method'><code id='ln_1p.v'>fn <a href='#tymethod.ln_1p' class='fnname'>ln_1p</a>(self) -> Self</code></h3><h3 id='tymethod.sqrt' class='method'><code id='sqrt.v'>fn <a href='#tymethod.sqrt' class='fnname'>sqrt</a>(self) -> Self</code></h3><h3 id='tymethod.try_sqrt' class='method'><code id='try_sqrt.v'>fn <a href='#tymethod.try_sqrt' class='fnname'>try_sqrt</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self></code></h3><h3 id='tymethod.exp' class='method'><code id='exp.v'>fn <a href='#tymethod.exp' class='fnname'>exp</a>(self) -> Self</code></h3><h3 id='tymethod.exp2' class='method'><code id='exp2.v'>fn <a href='#tymethod.exp2' class='fnname'>exp2</a>(self) -> Self</code></h3><h3 id='tymethod.exp_m1' class='
|
||
|
|
<h2 id='provided-methods' class='small-section-header'>Provided methods<a href='#provided-methods' class='anchor'></a></h2><div class='methods'><h3 id='method.to_polar' class='method'><code id='to_polar.v'>fn <a href='#method.to_polar' class='fnname'>to_polar</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>Self::<a class="type" href="../../alga/general/trait.ComplexField.html#associatedtype.RealField" title="type alga::general::ComplexField::RealField">RealField</a>, Self::<a class="type" href="../../alga/general/trait.ComplexField.html#associatedtype.RealField" title="type alga::general::ComplexField::RealField">RealField</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code></h3><div class='docblock'><p>The polar form of this complex number: (modulus, arg)</p>
|
||
|
|
</div><h3 id='method.to_exp' class='method'><code id='to_exp.v'>fn <a href='#method.to_exp' class='fnname'>to_exp</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>Self::<a class="type" href="../../alga/general/trait.ComplexField.html#associatedtype.RealField" title="type alga::general::ComplexField::RealField">RealField</a>, Self<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code></h3><div class='docblock'><p>The exponential form of this complex number: (modulus, e^{i arg})</p>
|
||
|
|
</div><h3 id='method.signum' class='method'><code id='signum.v'>fn <a href='#method.signum' class='fnname'>signum</a>(self) -> Self</code></h3><div class='docblock'><p>The exponential part of this complex number: <code>self / self.modulus()</code></p>
|
||
|
|
</div><h3 id='method.sinh_cosh' class='method'><code id='sinh_cosh.v'>fn <a href='#method.sinh_cosh' class='fnname'>sinh_cosh</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>Self, Self<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code></h3><h3 id='method.sinc' class='method'><code id='sinc.v'>fn <a href='#method.sinc' class='fnname'>sinc</a>(self) -> Self</code></h3><div class='docblock'><p>Cardinal sine</p>
|
||
|
|
</div><h3 id='method.sinhc' class='method'><code id='sinhc.v'>fn <a href='#method.sinhc' class='fnname'>sinhc</a>(self) -> Self</code></h3><h3 id='method.cosc' class='method'><code id='cosc.v'>fn <a href='#method.cosc' class='fnname'>cosc</a>(self) -> Self</code></h3><div class='docblock'><p>Cardinal cos</p>
|
||
|
|
</div><h3 id='method.coshc' class='method'><code id='coshc.v'>fn <a href='#method.coshc' class='fnname'>coshc</a>(self) -> Self</code></h3></div><span class='loading-content'>Loading content...</span>
|
||
|
|
<h2 id='foreign-impls' class='small-section-header'>Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a></h2><h3 id='impl-ComplexField-for-f32' class='impl'><code class='in-band'>impl <a class="trait" href="../../alga/general/trait.ComplexField.html" title="trait alga::general::ComplexField">ComplexField</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a></code><a href='#impl-ComplexField-for-f32' class='anchor'></a><a class='srclink' href='../../src/alga/general/complex.rs.html#192-471' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.RealField-1' class="type"><code id='RealField.t-1'>type <a href='#associatedtype.RealField' class="type">RealField</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a></code></h4><h4 id='method.from_real' class="method hidden"><code id='from_real.v-1'>fn <a href='#method.from_real' class='fnname'>from_real</a>(re: Self::<a class="type" href="../../alga/general/trait.ComplexField.html#associatedtype.RealField" title="type alga::general::ComplexField::RealField">RealField</a>) -> Self</code><a class='srclink' href='../../src/alga/general/complex.rs.html#196-198' title='goto source code'>[src]</a></h4><h4 id='method.real' class="method hidden"><code id='real.v-1'>fn <a href='#method.real' class='fnname'>real</a>(self) -> Self::<a class="type" href="../../alga/general/trait.ComplexField.html#associatedtype.RealField" title="type alga::general::ComplexField::RealField">RealField</a></code><a class='srclink' href='../../src/alga/general/complex.rs.html#201-203' title='goto source code'>[src]</a></h4><h4 id='method.imaginary' class="method hidden"><code id='imaginary.v-1'>fn <a href='#method.imaginary' class='fnname'>imaginary</a>(self) -> Self::<a class="type" href="../../alga/general/trait.ComplexField.html#associatedtype.RealField" title="type alga::general::ComplexField::RealField">RealField</a></code><a class='srclink' href='../../src/alga/general/complex.rs.html#206-208' title='goto source code'>[src]</a></h4><h4 id='method.norm1' class="method hidden"><code id='norm1.v-1'>fn <a href='#method.norm1' class='fnname'>norm1</a>(self) -> Self::<a class="type" href="../../alga/general/trait.ComplexField.html#associatedtype.RealField" title="type alga::general::ComplexField::RealField">RealField</a></code><a class='srclink' href='../../src/alga/general/complex.rs.html#211-213' title='goto source code'>[src]</a></h4><h4 id='method.modulus' class="method hidden"><code id='modulus.v-1'>fn <a href='#method.modulus' class='fnname'>modulus</a>(self) -> Self::<a class="type" href="../../alga/general/trait.ComplexField.html#associatedtype.RealField" title="type alga::general::ComplexField::RealField">RealField</a></code><a class='srclink' href='../../src/alga/general/complex.rs.html#216-218' title='goto source code'>[src]</a></h4><h4 id='method.modulus_squared' class="method hidden"><code id='modulus_squared.v-1'>fn <a href='#method.modulus_squared' class='fnname'>modulus_squared</a>(self) -> Self::<a class="type" href="../../alga/general/trait.ComplexField.html#associatedtype.RealField" title="type alga::general::ComplexField::RealField">RealField</a></code><a class='srclink' href='../../src/alga/general/complex.rs.html#221-223' title='goto source code'>[src]</a></h4><h4 id='method.argument' class="method hidden"><code id='argument.v-1'>fn <a href='#method.argument' class='fnname'>argument</a>(self) -> Self::<a class="type" href="../../alga/general/trait.ComplexField.html#associatedtype.RealField" title="type alga::general::ComplexField::RealField">RealField</a></code><a class='srclink' href='../../src/alga/general/complex.rs.html#226-232' title='goto source code'>[src]</a></h4><h4 id='method.to_exp-1' class="method hidden"><code id='to_exp.v-1'>fn <a href='#method.to_exp' class='fnname'>to_exp</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>Self, Self<a clas
|
||
|
|
</div><h4 id='method.ln-2' class="method"><code id='ln.v-3'>fn <a href='#method.ln' class='fnname'>ln</a>(self) -> Self</code><a class='srclink' href='../../src/alga/general/complex.rs.html#654-658' title='goto source code'>[src]</a></h4><div class='docblock'><p>Computes the principal value of natural logarithm of <code>self</code>.</p>
|
||
|
|
<p>This function has one branch cut:</p>
|
||
|
|
<ul>
|
||
|
|
<li><code>(-∞, 0]</code>, continuous from above.</li>
|
||
|
|
</ul>
|
||
|
|
<p>The branch satisfies <code>-π ≤ arg(ln(z)) ≤ π</code>.</p>
|
||
|
|
</div><h4 id='method.sqrt-2' class="method"><code id='sqrt.v-3'>fn <a href='#method.sqrt' class='fnname'>sqrt</a>(self) -> Self</code><a class='srclink' href='../../src/alga/general/complex.rs.html#668-673' title='goto source code'>[src]</a></h4><div class='docblock'><p>Computes the principal value of the square root of <code>self</code>.</p>
|
||
|
|
<p>This function has one branch cut:</p>
|
||
|
|
<ul>
|
||
|
|
<li><code>(-∞, 0)</code>, continuous from above.</li>
|
||
|
|
</ul>
|
||
|
|
<p>The branch satisfies <code>-π/2 ≤ arg(sqrt(z)) ≤ π/2</code>.</p>
|
||
|
|
</div><h4 id='method.try_sqrt-2' class="method hidden"><code id='try_sqrt.v-3'>fn <a href='#method.try_sqrt' class='fnname'>try_sqrt</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self></code><a class='srclink' href='../../src/alga/general/complex.rs.html#676-678' title='goto source code'>[src]</a></h4><h4 id='method.hypot-2' class="method hidden"><code id='hypot.v-3'>fn <a href='#method.hypot' class='fnname'>hypot</a>(self, b: Self) -> Self::<a class="type" href="../../alga/general/trait.ComplexField.html#associatedtype.RealField" title="type alga::general::ComplexField::RealField">RealField</a></code><a class='srclink' href='../../src/alga/general/complex.rs.html#681-683' title='goto source code'>[src]</a></h4><h4 id='method.powf-2' class="method"><code id='powf.v-3'>fn <a href='#method.powf' class='fnname'>powf</a>(self, exp: Self::<a class="type" href="../../alga/general/trait.ComplexField.html#associatedtype.RealField" title="type alga::general::ComplexField::RealField">RealField</a>) -> Self</code><a class='srclink' href='../../src/alga/general/complex.rs.html#687-692' title='goto source code'>[src]</a></h4><div class='docblock'><p>Raises <code>self</code> to a floating point power.</p>
|
||
|
|
</div><h4 id='method.log-2' class="method"><code id='log.v-3'>fn <a href='#method.log' class='fnname'>log</a>(self, base: N) -> Self</code><a class='srclink' href='../../src/alga/general/complex.rs.html#696-702' title='goto source code'>[src]</a></h4><div class='docblock'><p>Returns the logarithm of <code>self</code> with respect to an arbitrary base.</p>
|
||
|
|
</div><h4 id='method.powc-2' class="method"><code id='powc.v-3'>fn <a href='#method.powc' class='fnname'>powc</a>(self, exp: Self) -> Self</code><a class='srclink' href='../../src/alga/general/complex.rs.html#706-723' title='goto source code'>[src]</a></h4><div class='docblock'><p>Raises <code>self</code> to a complex power.</p>
|
||
|
|
</div><h4 id='method.sin-2' class="method"><code id='sin.v-3'>fn <a href='#method.sin' class='fnname'>sin</a>(self) -> Self</code><a class='srclink' href='../../src/alga/general/complex.rs.html#737-743' title='goto source code'>[src]</a></h4><div class='docblock'><p>Computes the sine of <code>self</code>.</p>
|
||
|
|
</div><h4 id='method.cos-2' class="method"><code id='cos.v-3'>fn <a href='#method.cos' class='fnname'>cos</a>(self) -> Self</code><a class='srclink' href='../../src/alga/general/complex.rs.html#747-753' title='goto source code'>[src]</a></h4><div class='docblock'><p>Computes the cosine of <code>self</code>.</p>
|
||
|
|
</div><h4 id='method.sin_cos-2' class="method hidden"><code id='sin_cos.v-3'>fn <a href='#method.sin_cos' class='fnname'>sin_cos</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>Self, Self<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code><a class='srclink' href='../../src/alga/general/complex.rs.html#756-763' title='goto source code'>[src]</a></h4><h4 id='method.tan-2' class="method"><code id='tan.v-3'>fn <a href='#method.tan' class='fnname'>tan</a>(self) -> Self</code><a class='srclink' href='../../src/alga/general/complex.rs.html#767-771' title='goto source code'>[src]</a></h4><div class='docblock'><p>Computes the tangent of <code>self</code>.</p>
|
||
|
|
</div><h4 id='method.asin-2' class="method"><code id='asin.v-3'>fn <a href='#method.asin' class='fnname'>asin</a>(self) -> Self</code><a class='srclink' href='../../src/alga/general/complex.rs.html#782-786' title='goto source code'>[src]</a></h4><div class='docblock'><p>Computes the principal value of the inverse sine of <code>self</code>.</p>
|
||
|
|
<p>This function has two branch cuts:</p>
|
||
|
|
<ul>
|
||
|
|
<li><code>(-∞, -1)</code>, continuous from above.</li>
|
||
|
|
<li><code>(1, ∞)</code>, continuous from below.</li>
|
||
|
|
</ul>
|
||
|
|
<p>The branch satisfies <code>-π/2 ≤ Re(asin(z)) ≤ π/2</code>.</p>
|
||
|
|
</div><h4 id='method.acos-2' class="method"><code id='acos.v-3'>fn <a href='#method.acos' class='fnname'>acos</a>(self) -> Self</code><a class='srclink' href='../../src/alga/general/complex.rs.html#797-801' title='goto source code'>[src]</a></h4><div class='docblock'><p>Computes the principal value of the inverse cosine of <code>self</code>.</p>
|
||
|
|
<p>This function has two branch cuts:</p>
|
||
|
|
<ul>
|
||
|
|
<li><code>(-∞, -1)</code>, continuous from above.</li>
|
||
|
|
<li><code>(1, ∞)</code>, continuous from below.</li>
|
||
|
|
</ul>
|
||
|
|
<p>The branch satisfies <code>0 ≤ Re(acos(z)) ≤ π</code>.</p>
|
||
|
|
</div><h4 id='method.atan-2' class="method"><code id='atan.v-3'>fn <a href='#method.atan' class='fnname'>atan</a>(self) -> Self</code><a class='srclink' href='../../src/alga/general/complex.rs.html#812-825' title='goto source code'>[src]</a></h4><div class='docblock'><p>Computes the principal value of the inverse tangent of <code>self</code>.</p>
|
||
|
|
<p>This function has two branch cuts:</p>
|
||
|
|
<ul>
|
||
|
|
<li><code>(-∞i, -i]</code>, continuous from the left.</li>
|
||
|
|
<li><code>[i, ∞i)</code>, continuous from the right.</li>
|
||
|
|
</ul>
|
||
|
|
<p>The branch satisfies <code>-π/2 ≤ Re(atan(z)) ≤ π/2</code>.</p>
|
||
|
|
</div><h4 id='method.sinh-2' class="method"><code id='sinh.v-3'>fn <a href='#method.sinh' class='fnname'>sinh</a>(self) -> Self</code><a class='srclink' href='../../src/alga/general/complex.rs.html#829-835' title='goto source code'>[src]</a></h4><div class='docblock'><p>Computes the hyperbolic sine of <code>self</code>.</p>
|
||
|
|
</div><h4 id='method.cosh-2' class="method"><code id='cosh.v-3'>fn <a href='#method.cosh' class='fnname'>cosh</a>(self) -> Self</code><a class='srclink' href='../../src/alga/general/complex.rs.html#839-845' title='goto source code'>[src]</a></h4><div class='docblock'><p>Computes the hyperbolic cosine of <code>self</code>.</p>
|
||
|
|
</div><h4 id='method.sinh_cosh-1' class="method hidden"><code id='sinh_cosh.v-1'>fn <a href='#method.sinh_cosh' class='fnname'>sinh_cosh</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>Self, Self<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code><a class='srclink' href='../../src/alga/general/complex.rs.html#848-855' title='goto source code'>[src]</a></h4><h4 id='method.tanh-2' class="method"><code id='tanh.v-3'>fn <a href='#method.tanh' class='fnname'>tanh</a>(self) -> Self</code><a class='srclink' href='../../src/alga/general/complex.rs.html#859-863' title='goto source code'>[src]</a></h4><div class='docblock'><p>Computes the hyperbolic tangent of <code>self</code>.</p>
|
||
|
|
</div><h4 id='method.asinh-2' class="method"><code id='asinh.v-3'>fn <a href='#method.asinh' class='fnname'>asinh</a>(self) -> Self</code><a class='srclink' href='../../src/alga/general/complex.rs.html#874-878' title='goto source code'>[src]</a></h4><div class='docblock'><p>Computes the principal value of inverse hyperbolic sine of <code>self</code>.</p>
|
||
|
|
<p>This function has two branch cuts:</p>
|
||
|
|
<ul>
|
||
|
|
<li><code>(-∞i, -i)</code>, continuous from the left.</li>
|
||
|
|
<li><code>(i, ∞i)</code>, continuous from the right.</li>
|
||
|
|
</ul>
|
||
|
|
<p>The branch satisfies <code>-π/2 ≤ Im(asinh(z)) ≤ π/2</code>.</p>
|
||
|
|
</div><h4 id='method.acosh-2' class="method"><code id='acosh.v-3'>fn <a href='#method.acosh' class='fnname'>acosh</a>(self) -> Self</code><a class='srclink' href='../../src/alga/general/complex.rs.html#888-893' title='goto source code'>[src]</a></h4><div class='docblock'><p>Computes the principal value of inverse hyperbolic cosine of <code>self</code>.</p>
|
||
|
|
<p>This function has one branch cut:</p>
|
||
|
|
<ul>
|
||
|
|
<li><code>(-∞, 1)</code>, continuous from above.</li>
|
||
|
|
</ul>
|
||
|
|
<p>The branch satisfies <code>-π ≤ Im(acosh(z)) ≤ π</code> and <code>0 ≤ Re(acosh(z)) < ∞</code>.</p>
|
||
|
|
</div><h4 id='method.atanh-2' class="method"><code id='atanh.v-3'>fn <a href='#method.atanh' class='fnname'>atanh</a>(self) -> Self</code><a class='srclink' href='../../src/alga/general/complex.rs.html#904-914' title='goto source code'>[src]</a></h4><div class='docblock'><p>Computes the principal value of inverse hyperbolic tangent of <code>self</code>.</p>
|
||
|
|
<p>This function has two branch cuts:</p>
|
||
|
|
<ul>
|
||
|
|
<li><code>(-∞, -1]</code>, continuous from above.</li>
|
||
|
|
<li><code>[1, ∞)</code>, continuous from below.</li>
|
||
|
|
</ul>
|
||
|
|
<p>The branch satisfies <code>-π/2 ≤ Im(atanh(z)) ≤ π/2</code>.</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'></div><span class='loading-content'>Loading content...</span><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
|
||
|
|
src="../../implementors/alga/general/trait.ComplexField.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 = "alga";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
|