kscience/kmath
9
0
Fork 1
Code Issues Pull Requests 6 Packages Projects Releases 16 Wiki Activity
gh-pages
kmath/kmath-complex/space.kscience.kmath.complex/index.html

368 lines
50 KiB
HTML
Raw Permalink Blame History

<!doctype html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>space.kscience.kmath.complex</title>
<link href="../../images/logo-icon.svg" rel="icon" type="image/svg"><script>var pathToRoot = "../../";</script> <script>const storage = localStorage.getItem("dokka-dark-mode")
if (storage == null) {
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
if (osDarkSchemePreferred === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
} else {
const savedDarkMode = JSON.parse(storage)
if(savedDarkMode === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
}
</script>
<script type="text/javascript" src="../../scripts/sourceset_dependencies.js" async></script>
<link href="../../styles/style.css" rel="Stylesheet">
<link href="../../styles/jetbrains-mono.css" rel="Stylesheet">
<link href="../../styles/main.css" rel="Stylesheet">
<link href="../../styles/prism.css" rel="Stylesheet">
<link href="../../styles/logo-styles.css" rel="Stylesheet">
<script type="text/javascript" src="../../scripts/clipboard.js" async></script>
<script type="text/javascript" src="../../scripts/navigation-loader.js" async></script>
<script type="text/javascript" src="../../scripts/platform-content-handler.js" async></script>
<script type="text/javascript" src="../../scripts/main.js" defer></script>
<script type="text/javascript" src="../../scripts/prism.js" async></script>
<script type="text/javascript" src="../../scripts/symbol-parameters-wrapper_deferred.js" defer></script></head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../index.html">
<span>kmath</span> </a> </div>
<div>0.3.1-dev-RC
</div>
<div class="pull-right d-flex">
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector common-like" data-active="" data-filter=":kmath-complex:dokkaHtmlPartial/commonMain">common</button>
</div>
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></div>
</div>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="package" id="content" pageids="kmath-complex::space.kscience.kmath.complex////PointingToDeclaration//-1704498033">
<div class="breadcrumbs"><a href="../index.html">kmath-complex</a><span class="delimiter">/</span><span class="current">space.kscience.kmath.complex</span></div>
<div class="cover ">
<h1 class="cover"><span><span>Package-level</span></span> <span><span>declarations</span></span></h1>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="TYPE">Types</button><button class="section-tab" data-togglable="FUNCTION,EXTENSION_FUNCTION">Functions</button><button class="section-tab" data-togglable="PROPERTY,EXTENSION_PROPERTY">Properties</button></div>
<div class="tabs-section-body">
<div data-togglable="TYPE">
<h2 class="">Types</h2>
<div class="table"><a data-name="-552440632%2FClasslikes%2F-1704498033" anchor-label="Complex" id="-552440632%2FClasslikes%2F-1704498033" data-filterable-set=":kmath-complex:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-complex:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-complex:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-complex/index.html"><span><span>Complex</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-552440632%2FClasslikes%2F-1704498033"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-complex:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">data </span><span class="token keyword">class </span><a href="-complex/index.html">Complex</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>re<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>im<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Represents <code class="lang-kotlin">double</code>-based complex number.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="345431648%2FClasslikes%2F-1704498033" anchor-label="ComplexField" id="345431648%2FClasslikes%2F-1704498033" data-filterable-set=":kmath-complex:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-complex:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-complex:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-complex-field/index.html"><span>Complex</span><wbr><span><span>Field</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="345431648%2FClasslikes%2F-1704498033"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-complex:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">object </span><a href="-complex-field/index.html">ComplexField</a> : <a href="../../kmath-core/space.kscience.kmath.operations/-extended-field/index.html">ExtendedField</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-complex/index.html">Complex</a><span class="token operator">&gt; </span>, <a href="../../kmath-core/space.kscience.kmath.operations/-norm/index.html">Norm</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-complex/index.html">Complex</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="-complex/index.html">Complex</a><span class="token operator">&gt; </span>, <a href="../../kmath-core/space.kscience.kmath.operations/-numbers-add-ops/index.html">NumbersAddOps</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-complex/index.html">Complex</a><span class="token operator">&gt; </span>, <a href="../../kmath-core/space.kscience.kmath.operations/-scale-operations/index.html">ScaleOperations</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-complex/index.html">Complex</a><span class="token operator">&gt; </span></div><div class="brief "><p class="paragraph">A field of <a href="-complex/index.html">Complex</a>.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="268615082%2FClasslikes%2F-1704498033" anchor-label="ComplexFieldND" id="268615082%2FClasslikes%2F-1704498033" data-filterable-set=":kmath-complex:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-complex:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-complex:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-complex-field-n-d/index.html"><span>Complex</span><wbr><span>Field</span><wbr><span><span>ND</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="268615082%2FClasslikes%2F-1704498033"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-complex:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">class </span><a href="-complex-field-n-d/index.html">ComplexFieldND</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>shape<span class="token operator">: </span><a href="../../kmath-core/space.kscience.kmath.nd/-shape-n-d/index.html">ShapeND</a></span></span><span class="token punctuation">)</span> : <a href="-complex-field-ops-n-d/index.html">ComplexFieldOpsND</a>, <a href="../../kmath-core/space.kscience.kmath.nd/-field-n-d/index.html">FieldND</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-complex/index.html">Complex</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="-complex-field/index.html">ComplexField</a><span class="token operator">&gt; </span>, <a href="../../kmath-core/space.kscience.kmath.operations/-numbers-add-ops/index.html">NumbersAddOps</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../../kmath-core/space.kscience.kmath.nd/-structure-n-d/index.html">StructureND</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-complex/index.html">Complex</a><span class="token operator">&gt;</span><span class="token operator">&gt; </span></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-392757094%2FClasslikes%2F-1704498033" anchor-label="ComplexFieldOpsND" id="-392757094%2FClasslikes%2F-1704498033" data-filterable-set=":kmath-complex:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-complex:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-complex:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-complex-field-ops-n-d/index.html"><span>Complex</span><wbr><span>Field</span><wbr><span>Ops</span><wbr><span><span>ND</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-392757094%2FClasslikes%2F-1704498033"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-complex:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">sealed </span><span class="token keyword">class </span><a href="-complex-field-ops-n-d/index.html">ComplexFieldOpsND</a> : <a href="../../kmath-core/space.kscience.kmath.nd/-buffered-field-ops-n-d/index.html">BufferedFieldOpsND</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-complex/index.html">Complex</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="-complex-field/index.html">ComplexField</a><span class="token operator">&gt; </span>, <a href="../../kmath-core/space.kscience.kmath.operations/-scale-operations/index.html">ScaleOperations</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../../kmath-core/space.kscience.kmath.nd/-structure-n-d/index.html">StructureND</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-complex/index.html">Complex</a><span class="token operator">&gt;</span><span class="token operator">&gt; </span>, <a href="../../kmath-core/space.kscience.kmath.operations/-extended-field-ops/index.html">ExtendedFieldOps</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../../kmath-core/space.kscience.kmath.nd/-structure-n-d/index.html">StructureND</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-complex/index.html">Complex</a><span class="token operator">&gt;</span><span class="token operator">&gt; </span>, <a href="../../kmath-core/space.kscience.kmath.operations/-power-operations/index.html">PowerOperations</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../../kmath-core/space.kscience.kmath.nd/-structure-n-d/index.html">StructureND</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-complex/index.html">Complex</a><span class="token operator">&gt;</span><span class="token operator">&gt; </span></div><div class="brief "><p class="paragraph">An optimized nd-field for complex numbers</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="735099436%2FClasslikes%2F-1704498033" anchor-label="Quaternion" id="735099436%2FClasslikes%2F-1704498033" data-filterable-set=":kmath-complex:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-complex:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-complex:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-quaternion/index.html"><span><span>Quaternion</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="735099436%2FClasslikes%2F-1704498033"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-complex:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">class </span><a href="-quaternion/index.html">Quaternion</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>w<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>x<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>y<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>z<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a></span></span><span class="token punctuation">)</span> : <a href="../../kmath-core/space.kscience.kmath.structures/-buffer/index.html">Buffer</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a><span class="token operator">&gt; </span></div><div class="brief "><p class="paragraph">Represents <code class="lang-kotlin">double</code>-based quaternion.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="509955964%2FClasslikes%2F-1704498033" anchor-label="QuaternionField" id="509955964%2FClasslikes%2F-1704498033" data-filterable-set=":kmath-complex:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-complex:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-complex:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-quaternion-field/index.html"><span>Quaternion</span><wbr><span><span>Field</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="509955964%2FClasslikes%2F-1704498033"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-complex:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">object </span><a href="-quaternion-field/index.html">QuaternionField</a> : <a href="../../kmath-core/space.kscience.kmath.operations/-field/index.html">Field</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-quaternion/index.html">Quaternion</a><span class="token operator">&gt; </span>, <a href="../../kmath-core/space.kscience.kmath.operations/-norm/index.html">Norm</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-quaternion/index.html">Quaternion</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a><span class="token operator">&gt; </span>, <a href="../../kmath-core/space.kscience.kmath.operations/-power-operations/index.html">PowerOperations</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-quaternion/index.html">Quaternion</a><span class="token operator">&gt; </span>, <a href="../../kmath-core/space.kscience.kmath.operations/-exponential-operations/index.html">ExponentialOperations</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-quaternion/index.html">Quaternion</a><span class="token operator">&gt; </span>, <a href="../../kmath-core/space.kscience.kmath.operations/-numbers-add-ops/index.html">NumbersAddOps</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-quaternion/index.html">Quaternion</a><span class="token operator">&gt; </span>, <a href="../../kmath-core/space.kscience.kmath.operations/-scale-operations/index.html">ScaleOperations</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-quaternion/index.html">Quaternion</a><span class="token operator">&gt; </span></div><div class="brief "><p class="paragraph">A field of <a href="-quaternion/index.html">Quaternion</a>.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div data-togglable="FUNCTION">
<h2 class="">Functions</h2>
<div class="table"><a data-name="-417922280%2FFunctions%2F-1704498033" anchor-label="complex" id="-417922280%2FFunctions%2F-1704498033" data-filterable-set=":kmath-complex:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":kmath-complex:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-complex:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="complex.html"><span><span>complex</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-417922280%2FFunctions%2F-1704498033"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-complex:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><a href="../../kmath-core/space.kscience.kmath.structures/-buffer/-companion/index.html">Buffer.Companion</a><span class="token punctuation">.</span><a href="complex.html"><span class="token function">complex</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">size<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token punctuation">, </span></span><span class="parameter ">init<span class="token operator">: </span><span class="token punctuation">(</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="-complex/index.html">Complex</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../kmath-core/space.kscience.kmath.structures/-buffer/index.html">Buffer</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-complex/index.html">Complex</a><span class="token operator">&gt;</span></div><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><a href="../../kmath-core/space.kscience.kmath.structures/-mutable-buffer/-companion/index.html">MutableBuffer.Companion</a><span class="token punctuation">.</span><a href="complex.html"><span class="token function">complex</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">size<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token punctuation">, </span></span><span class="parameter ">init<span class="token operator">: </span><span class="token punctuation">(</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="-complex/index.html">Complex</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../kmath-core/space.kscience.kmath.structures/-mutable-buffer/index.html">MutableBuffer</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-complex/index.html">Complex</a><span class="token operator">&gt;</span></div><div class="brief "><p class="paragraph">Creates a new buffer of complex numbers with the specified <a href="complex.html">size</a>, where each element is calculated by calling the specified <a href="complex.html">init</a> function.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="761980754%2FFunctions%2F-1704498033" anchor-label="ndAlgebra" id="761980754%2FFunctions%2F-1704498033" data-filterable-set=":kmath-complex:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":kmath-complex:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-complex:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="nd-algebra.html"><span>nd</span><wbr><span><span>Algebra</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="761980754%2FFunctions%2F-1704498033"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-complex:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="-complex-field/index.html">ComplexField</a><span class="token punctuation">.</span><a href="nd-algebra.html"><span class="token function">ndAlgebra</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">vararg </span>shape<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-complex-field-n-d/index.html">ComplexFieldND</a></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="732817474%2FFunctions%2F-1704498033" anchor-label="normalized" id="732817474%2FFunctions%2F-1704498033" data-filterable-set=":kmath-complex:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":kmath-complex:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-complex:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="normalized.html"><span><span>normalized</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="732817474%2FFunctions%2F-1704498033"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-complex:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="-quaternion/index.html">Quaternion</a><span class="token punctuation">.</span><a href="normalized.html"><span class="token function">normalized</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-quaternion/index.html">Quaternion</a></div><div class="brief "><p class="paragraph">Produce a normalized version of this quaternion</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="553046108%2FFunctions%2F-1704498033" anchor-label="Quaternion" id="553046108%2FFunctions%2F-1704498033" data-filterable-set=":kmath-complex:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-complex:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-complex:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-quaternion.html"><span><span>Quaternion</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="553046108%2FFunctions%2F-1704498033"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-complex:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="-quaternion.html"><span class="token function">Quaternion</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">w<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.html">Number</a><span class="token punctuation">, </span></span><span class="parameter ">x<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.html">Number</a><span class="token operator"> = </span><span class="token constant">0.0</span><span class="token punctuation">, </span></span><span class="parameter ">y<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.html">Number</a><span class="token operator"> = </span><span class="token constant">0.0</span><span class="token punctuation">, </span></span><span class="parameter ">z<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.html">Number</a><span class="token operator"> = </span><span class="token constant">0.0</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-quaternion/index.html">Quaternion</a></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="936717124%2FFunctions%2F-1704498033" anchor-label="quaternion" id="936717124%2FFunctions%2F-1704498033" data-filterable-set=":kmath-complex:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":kmath-complex:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-complex:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="quaternion.html"><span><span>quaternion</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="936717124%2FFunctions%2F-1704498033"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-complex:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><a href="../../kmath-core/space.kscience.kmath.structures/-buffer/-companion/index.html">Buffer.Companion</a><span class="token punctuation">.</span><a href="quaternion.html"><span class="token function">quaternion</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">size<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token punctuation">, </span></span><span class="parameter ">init<span class="token operator">: </span><span class="token punctuation">(</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="-quaternion/index.html">Quaternion</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../kmath-core/space.kscience.kmath.structures/-buffer/index.html">Buffer</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-quaternion/index.html">Quaternion</a><span class="token operator">&gt;</span></div><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><a href="../../kmath-core/space.kscience.kmath.structures/-mutable-buffer/-companion/index.html">MutableBuffer.Companion</a><span class="token punctuation">.</span><a href="quaternion.html"><span class="token function">quaternion</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">size<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token punctuation">, </span></span><span class="parameter ">init<span class="token operator">: </span><span class="token punctuation">(</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="-quaternion/index.html">Quaternion</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../kmath-core/space.kscience.kmath.structures/-mutable-buffer/index.html">MutableBuffer</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-quaternion/index.html">Quaternion</a><span class="token operator">&gt;</span></div><div class="brief "><p class="paragraph">Creates a new buffer of quaternions with the specified <a href="quaternion.html">size</a>, where each element is calculated by calling the specified <a href="quaternion.html">init</a> function.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1024800318%2FFunctions%2F-1704498033" anchor-label="toComplex" id="-1024800318%2FFunctions%2F-1704498033" data-filterable-set=":kmath-complex:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":kmath-complex:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-complex:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="to-complex.html"><span>to</span><wbr><span><span>Complex</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1024800318%2FFunctions%2F-1704498033"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-complex:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.html">Number</a><span class="token punctuation">.</span><a href="to-complex.html"><span class="token function">toComplex</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-complex/index.html">Complex</a></div><div class="brief "><p class="paragraph">Creates a complex number with real part equal to this real.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="973370541%2FFunctions%2F-1704498033" anchor-label="withNdAlgebra" id="973370541%2FFunctions%2F-1704498033" data-filterable-set=":kmath-complex:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":kmath-complex:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-complex:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="with-nd-algebra.html"><span>with</span><wbr><span>Nd</span><wbr><span><span>Algebra</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="973370541%2FFunctions%2F-1704498033"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-complex:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="with-nd-algebra.html">R</a><span class="token operator">&gt; </span><a href="-complex-field/index.html">ComplexField</a><span class="token punctuation">.</span><a href="with-nd-algebra.html"><span class="token function">withNdAlgebra</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">vararg </span>shape<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token punctuation">, </span></span><span class="parameter ">action<span class="token operator">: </span><span class="token keyword"></span><a href="-complex-field-n-d/index.html">ComplexFieldND</a><span class="token punctuation">.</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="with-nd-algebra.html">R</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="with-nd-algebra.html">R</a></div><div class="brief "><p class="paragraph">Produce a context for n-dimensional operations inside this real field</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div data-togglable="EXTENSION_PROPERTY">
<h2 class="">Properties</h2>
<div class="table"><a data-name="1910719973%2FProperties%2F-1704498033" anchor-label="algebra" id="1910719973%2FProperties%2F-1704498033" data-filterable-set=":kmath-complex:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-togglable="EXTENSION_PROPERTY" data-filterable-current=":kmath-complex:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-complex:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="algebra.html"><span><span>algebra</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1910719973%2FProperties%2F-1704498033"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-complex:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="-complex/-companion/index.html">Complex.Companion</a><span class="token punctuation">.</span><a href="algebra.html">algebra</a><span class="token operator">: </span><a href="-complex-field/index.html">ComplexField</a></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-474022968%2FProperties%2F-1704498033" anchor-label="conjugate" id="-474022968%2FProperties%2F-1704498033" data-filterable-set=":kmath-complex:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-togglable="EXTENSION_PROPERTY" data-filterable-current=":kmath-complex:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-complex:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="conjugate.html"><span><span>conjugate</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-474022968%2FProperties%2F-1704498033"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-complex:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="-complex/index.html">Complex</a><span class="token punctuation">.</span><a href="conjugate.html">conjugate</a><span class="token operator">: </span><a href="-complex/index.html">Complex</a></div><div class="brief "><p class="paragraph">This complex's conjugate.</p></div><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="-quaternion/index.html">Quaternion</a><span class="token punctuation">.</span><a href="conjugate.html">conjugate</a><span class="token operator">: </span><a href="-quaternion/index.html">Quaternion</a></div><div class="brief "><p class="paragraph">This quaternion's conjugate.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1424310233%2FProperties%2F-1704498033" anchor-label="ndAlgebra" id="1424310233%2FProperties%2F-1704498033" data-filterable-set=":kmath-complex:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-togglable="EXTENSION_PROPERTY" data-filterable-current=":kmath-complex:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-complex:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="nd-algebra.html"><span>nd</span><wbr><span><span>Algebra</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1424310233%2FProperties%2F-1704498033"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-complex:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="-complex-field/index.html">ComplexField</a><span class="token punctuation">.</span><a href="nd-algebra.html">ndAlgebra</a><span class="token operator">: </span><a href="-complex-field-ops-n-d/index.html">ComplexFieldOpsND</a></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="252819869%2FProperties%2F-1704498033" anchor-label="r" id="252819869%2FProperties%2F-1704498033" data-filterable-set=":kmath-complex:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-togglable="EXTENSION_PROPERTY" data-filterable-current=":kmath-complex:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-complex:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="r.html"><span><span>r</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="252819869%2FProperties%2F-1704498033"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-complex:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="-complex/index.html">Complex</a><span class="token punctuation">.</span><a href="r.html">r</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a></div><div class="brief "><p class="paragraph">Absolute value of complex number.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1106623298%2FProperties%2F-1704498033" anchor-label="reciprocal" id="-1106623298%2FProperties%2F-1704498033" data-filterable-set=":kmath-complex:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-togglable="EXTENSION_PROPERTY" data-filterable-current=":kmath-complex:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-complex:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="reciprocal.html"><span><span>reciprocal</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1106623298%2FProperties%2F-1704498033"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-complex:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="-complex/index.html">Complex</a><span class="token punctuation">.</span><a href="reciprocal.html">reciprocal</a><span class="token operator">: </span><a href="-complex/index.html">Complex</a></div><div class="brief "><p class="paragraph">This complex's reciprocal.</p></div><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="-quaternion/index.html">Quaternion</a><span class="token punctuation">.</span><a href="reciprocal.html">reciprocal</a><span class="token operator">: </span><a href="-quaternion/index.html">Quaternion</a></div><div class="brief "><p class="paragraph">This quaternion's reciprocal.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1449262833%2FProperties%2F-1704498033" anchor-label="theta" id="1449262833%2FProperties%2F-1704498033" data-filterable-set=":kmath-complex:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-togglable="EXTENSION_PROPERTY" data-filterable-current=":kmath-complex:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-complex:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="theta.html"><span><span>theta</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1449262833%2FProperties%2F-1704498033"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-complex:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="-complex/index.html">Complex</a><span class="token punctuation">.</span><a href="theta.html">theta</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a></div><div class="brief "><p class="paragraph">An angle between vector represented by complex number and X axis.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>
</div>
</div>
</body>
</html>
View Git Blame Copy Permalink