kmath/kmath-tensors/space.kscience.kmath.tensors.api/index.html

121 lines
17 KiB
HTML

<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>space.kscience.kmath.tensors.api</title>
</head><body><link href="../../images/logo-icon.svg" rel="icon" type="image/svg"><script>var pathToRoot = "../../";</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>const storage = localStorage.getItem("dokka-dark-mode")
const savedDarkMode = storage ? JSON.parse(storage) : false
if(savedDarkMode === true){
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}</script>
<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></div>
<div class="pull-right d-flex"><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" id="content" pageids="kmath-tensors::space.kscience.kmath.tensors.api////PointingToDeclaration//-1345790395">
<div class="breadcrumbs"><a href="../index.html">kmath-tensors</a>/<a href="index.html">space.kscience.kmath.tensors.api</a></div>
<div class="cover ">
<h1 class="cover"><span><span>Package</span></span> <span>space.</span><wbr><span>kscience.</span><wbr><span>kmath.</span><wbr><span>tensors.</span><wbr><span>api</span></h1>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="Types">Types</button></div>
<div class="tabs-section-body">
<h2 class="">Types</h2>
<div class="table" data-togglable="Types"><a data-name="276970240%2FClasslikes%2F-1345790395" anchor-label="AnalyticTensorAlgebra" id="276970240%2FClasslikes%2F-1345790395" data-filterable-set=":kmath-tensors:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-tensors:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-tensors:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-analytic-tensor-algebra/index.html"><span>Analytic</span><wbr><span>Tensor</span><wbr><span><span>Algebra</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="276970240%2FClasslikes%2F-1345790395"></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-depenent-content" data-active="" data-togglable=":kmath-tensors:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">interface </span><a href="-analytic-tensor-algebra/index.html">AnalyticTensorAlgebra</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-analytic-tensor-algebra/index.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="-analytic-tensor-algebra/index.html">A</a><span class="token operator"> : </span><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="-analytic-tensor-algebra/index.html">T</a><span class="token operator">&gt;</span><span class="token operator">&gt;</span> : <a href="-tensor-partial-division-algebra/index.html">TensorPartialDivisionAlgebra</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-analytic-tensor-algebra/index.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="-analytic-tensor-algebra/index.html">A</a><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="-analytic-tensor-algebra/index.html">T</a><span class="token operator">&gt;</span><span class="token operator">&gt; </span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="brief "><p class="paragraph">Analytic operations on <a href="index.html#-1680022905%2FClasslikes%2F-1345790395">Tensor</a>.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="259130558%2FClasslikes%2F-1345790395" anchor-label="LinearOpsTensorAlgebra" id="259130558%2FClasslikes%2F-1345790395" data-filterable-set=":kmath-tensors:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-tensors:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-tensors:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-linear-ops-tensor-algebra/index.html"><span>Linear</span><wbr><span>Ops</span><wbr><span>Tensor</span><wbr><span><span>Algebra</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="259130558%2FClasslikes%2F-1345790395"></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-depenent-content" data-active="" data-togglable=":kmath-tensors:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">interface </span><a href="-linear-ops-tensor-algebra/index.html">LinearOpsTensorAlgebra</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-linear-ops-tensor-algebra/index.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="-linear-ops-tensor-algebra/index.html">A</a><span class="token operator"> : </span><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="-linear-ops-tensor-algebra/index.html">T</a><span class="token operator">&gt;</span><span class="token operator">&gt;</span> : <a href="-tensor-partial-division-algebra/index.html">TensorPartialDivisionAlgebra</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-linear-ops-tensor-algebra/index.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="-linear-ops-tensor-algebra/index.html">A</a><span class="token operator">&gt; </span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="brief "><p class="paragraph">Common linear algebra operations. Operates on <a href="index.html#-1680022905%2FClasslikes%2F-1345790395">Tensor</a>.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1680022905%2FClasslikes%2F-1345790395" anchor-label="Tensor" id="-1680022905%2FClasslikes%2F-1345790395" data-filterable-set=":kmath-tensors:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-tensors:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-tensors:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="index.html#-1680022905%2FClasslikes%2F-1345790395"><span><span>Tensor</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1680022905%2FClasslikes%2F-1345790395"></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-depenent-content" data-active="" data-togglable=":kmath-tensors:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">typealias </span><a href="index.html#-1680022905%2FClasslikes%2F-1345790395">Tensor</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html#-1680022905%2FClasslikes%2F-1345790395">T</a><span class="token operator">&gt;</span><span class="token operator"> = </span><a href="../../kmath-core/space.kscience.kmath.nd/-mutable-structure-n-d/index.html">MutableStructureND</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html#-1680022905%2FClasslikes%2F-1345790395">T</a><span class="token operator">&gt;</span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="2144406291%2FClasslikes%2F-1345790395" anchor-label="TensorAlgebra" id="2144406291%2FClasslikes%2F-1345790395" data-filterable-set=":kmath-tensors:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-tensors:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-tensors:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-tensor-algebra/index.html"><span>Tensor</span><wbr><span><span>Algebra</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2144406291%2FClasslikes%2F-1345790395"></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-depenent-content" data-active="" data-togglable=":kmath-tensors:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">interface </span><a href="-tensor-algebra/index.html">TensorAlgebra</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-tensor-algebra/index.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="-tensor-algebra/index.html">A</a><span class="token operator"> : </span><a href="../../kmath-core/space.kscience.kmath.operations/-ring/index.html">Ring</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-tensor-algebra/index.html">T</a><span class="token operator">&gt;</span><span class="token operator">&gt;</span> : <a href="../../kmath-core/space.kscience.kmath.nd/-ring-ops-n-d/index.html">RingOpsND</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-tensor-algebra/index.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="-tensor-algebra/index.html">A</a><span class="token operator">&gt; </span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="brief "><p class="paragraph">Algebra over a ring on <a href="index.html#-1680022905%2FClasslikes%2F-1345790395">Tensor</a>. For more information: https://proofwiki.org/wiki/Definition:Algebra_over_Ring</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-122103507%2FClasslikes%2F-1345790395" anchor-label="TensorPartialDivisionAlgebra" id="-122103507%2FClasslikes%2F-1345790395" data-filterable-set=":kmath-tensors:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-tensors:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-tensors:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-tensor-partial-division-algebra/index.html"><span>Tensor</span><wbr><span>Partial</span><wbr><span>Division</span><wbr><span><span>Algebra</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-122103507%2FClasslikes%2F-1345790395"></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-depenent-content" data-active="" data-togglable=":kmath-tensors:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">interface </span><a href="-tensor-partial-division-algebra/index.html">TensorPartialDivisionAlgebra</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-tensor-partial-division-algebra/index.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="-tensor-partial-division-algebra/index.html">A</a><span class="token operator"> : </span><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="-tensor-partial-division-algebra/index.html">T</a><span class="token operator">&gt;</span><span class="token operator">&gt;</span> : <a href="-tensor-algebra/index.html">TensorAlgebra</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-tensor-partial-division-algebra/index.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="-tensor-partial-division-algebra/index.html">A</a><span class="token operator">&gt; </span>, <a href="../../kmath-core/space.kscience.kmath.nd/-field-ops-n-d/index.html">FieldOpsND</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-tensor-partial-division-algebra/index.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="-tensor-partial-division-algebra/index.html">A</a><span class="token operator">&gt; </span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="brief "><p class="paragraph">Algebra over a field with partial division on <a href="index.html#-1680022905%2FClasslikes%2F-1345790395">Tensor</a>. For more information: https://proofwiki.org/wiki/Definition:Division_Algebra</p></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>© 2022 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>