kmath/kmath-core/index.html

227 lines
28 KiB
HTML
Raw Normal View History

<!doctype html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>kmath-core</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-core:dokkaHtmlPartial/commonMain">common</button>
<button class="platform-tag platform-selector js-like" data-active="" data-filter=":kmath-core:dokkaHtmlPartial/jsMain">js</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":kmath-core:dokkaHtmlPartial/jvmMain">jvm</button>
<button class="platform-tag platform-selector native-like" data-active="" data-filter=":kmath-core:dokkaHtmlPartial/nativeMain">native</button>
<button class="platform-tag platform-selector wasm-like" data-active="" data-filter=":kmath-core:dokkaHtmlPartial/wasmMain">wasm</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" id="content" pageids="kmath-core::////PointingToDeclaration//1967979793">
<div class="breadcrumbs"></div>
<div class="cover ">
<h1 class="cover"><span><span>kmath-core</span></span></h1>
<div class="platform-hinted UnderCoverText with-platform-tabs" data-platform-hinted="data-platform-hinted">
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark" data-filterable-current=":kmath-core:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain" data-active="" data-toggle=":kmath-core:dokkaHtmlPartial/commonMain">common</button><button class="platform-bookmark" data-filterable-current=":kmath-core:dokkaHtmlPartial/jsMain" data-filterable-set=":kmath-core:dokkaHtmlPartial/jsMain" data-toggle=":kmath-core:dokkaHtmlPartial/jsMain">js</button><button class="platform-bookmark" data-filterable-current=":kmath-core:dokkaHtmlPartial/jvmMain" data-filterable-set=":kmath-core:dokkaHtmlPartial/jvmMain" data-toggle=":kmath-core:dokkaHtmlPartial/jvmMain">jvm</button><button class="platform-bookmark" data-filterable-current=":kmath-core:dokkaHtmlPartial/nativeMain" data-filterable-set=":kmath-core:dokkaHtmlPartial/nativeMain" data-toggle=":kmath-core:dokkaHtmlPartial/nativeMain">native</button><button class="platform-bookmark" data-filterable-current=":kmath-core:dokkaHtmlPartial/wasmMain" data-filterable-set=":kmath-core:dokkaHtmlPartial/wasmMain" data-toggle=":kmath-core:dokkaHtmlPartial/wasmMain">wasm</button></div>
<div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-core:dokkaHtmlPartial/commonMain"><p class="paragraph">The core interfaces of KMath.</p><ul><li><p class="paragraph">src/commonMain/kotlin/space/kscience/kmath/operations/Algebra.kt : Algebraic structures like rings, spaces and fields.</p></li><li><p class="paragraph">src/commonMain/kotlin/space/kscience/kmath/structures/StructureND.kt : Many-dimensional structures and operations on them.</p></li><li><p class="paragraph">src/commonMain/kotlin/space/kscience/kmath/operations/Algebra.kt : Basic linear algebra operations (sums, products, etc.), backed by the <code class="lang-kotlin">Space</code> API. Advanced linear algebra operations like matrix inversion and LU decomposition.</p></li><li><p class="paragraph">src/commonMain/kotlin/space/kscience/kmath/structures/Buffers.kt : One-dimensional structure</p></li><li><p class="paragraph">src/commonMain/kotlin/space/kscience/kmath/expressions : By writing a single mathematical expression once, users will be able to apply different types of objects to the expression by providing a context. Expressions can be used for a wide variety of purposes from high performance calculations to code generation.</p></li><li><p class="paragraph">src/commonMain/kotlin/space/kscience/kmath/domains : Domains</p></li><li><p class="paragraph">src/commonMain/kotlin/space/kscience/kmath/expressions/SimpleAutoDiff.kt : Automatic differentiation</p></li></ul><h2 class=""> Artifact:</h2><p class="paragraph">The Maven coordinates of this project are <code class="lang-kotlin">space.kscience:kmath-core:0.3.1-dev-RC</code>.</p><p class="paragraph"><strong>Gradle Groovy:</strong></p><div class="sample-container"><pre><code class="block lang-groovy" theme="idea">repositories {<br> maven { url 'https://repo.kotlin.link' }<br> mavenCentral()<br>}<br><br>dependencies {<br> implementation 'space.kscience:kmath-core:0.3.1-dev-RC'<br>}</code></pre><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><p class="paragraph"><strong>Gradle Kotlin DSL:</strong></p><div class="sample-container"><pre><code class="block lang-kotlin" theme="idea">repositories {<br> maven("https://repo.kotlin.link")<br> mavenCentral()<br>}<br><br>dependencies {<br> implementation("space.kscience:kmath-core:0.3.1-dev-RC")<br>}</code></pre><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 class="content sourceset-dependent-content" data-togglable=":kmath-core:dokkaHtmlPartial/jsMain"><p class="paragraph">The core interfaces of KMath.</p><ul><li><p class="paragraph">src/commonMain/kotlin/space/kscience/kmath/operations/Algebra.kt : Algebraic structures like rings, spaces and fields.</p></li><li><p class="paragraph">src/commonMain/kotlin/space/kscience/kmath/structures/StructureND.kt : Many-dimensional structures and operations on them.</p></li><li><p class="paragraph">src/commonMain/kotlin/space/kscience/kmath/operations/Algebra.kt : Basic linear algebra operations (sums, products, etc.), backed by the <code class="lang-kotlin">Space</code> API. Advanced linear algebra operations like matrix inversion and LU decomposition.</p></li><li><p class="paragraph">src/commonMain/kotlin/space/kscience/kmath/structures/Buffers.kt : One-dimensional structure</p></li><li><p class="paragraph">src/commonMain/kotlin/space/kscience/kmath/expressions : By writing a single mathematical expression once, users will be able to apply different types of objects to the expression by providing a context. Expressions can be used for a wide variety of purposes from high performance calculations to code generation.</p></li><li><p class="paragraph">src/commonMain/kotlin/space/kscience/kmath/domains : Domains</p></li><li><p class="paragraph">src/commonMai
</div>
<h2 class="">Packages</h2>
<div class="table"><a data-name="1328362932%2FPackages%2F244675578" anchor-label="space.kscience.kmath.data" id="1328362932%2FPackages%2F244675578" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-core:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain">
<div>
<div class="main-subrow ">
<div class=""><span class="inline-flex">
<div><a href="space.kscience.kmath.data/index.html">space.kscience.kmath.data</a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1328362932%2FPackages%2F244675578"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div class="pull-right">
<div class="platform-tags no-gutters">
<div class="platform-tag common-like">common</div>
</div>
</div>
</div>
<div></div>
</div>
</div>
<a data-name="662987177%2FPackages%2F244675578" anchor-label="space.kscience.kmath.domains" id="662987177%2FPackages%2F244675578" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-core:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain">
<div>
<div class="main-subrow ">
<div class=""><span class="inline-flex">
<div><a href="space.kscience.kmath.domains/index.html">space.kscience.kmath.domains</a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="662987177%2FPackages%2F244675578"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div class="pull-right">
<div class="platform-tags no-gutters">
<div class="platform-tag common-like">common</div>
</div>
</div>
</div>
<div></div>
</div>
</div>
<a data-name="740307797%2FPackages%2F244675578" anchor-label="space.kscience.kmath.expressions" id="740307797%2FPackages%2F244675578" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-core:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain">
<div>
<div class="main-subrow ">
<div class=""><span class="inline-flex">
<div><a href="space.kscience.kmath.expressions/index.html">space.kscience.kmath.expressions</a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="740307797%2FPackages%2F244675578"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div class="pull-right">
<div class="platform-tags no-gutters">
<div class="platform-tag common-like">common</div>
</div>
</div>
</div>
<div></div>
</div>
</div>
<a data-name="2042779503%2FPackages%2F244675578" anchor-label="space.kscience.kmath.linear" id="2042779503%2FPackages%2F244675578" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-core:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain">
<div>
<div class="main-subrow ">
<div class=""><span class="inline-flex">
<div><a href="space.kscience.kmath.linear/index.html">space.kscience.kmath.linear</a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2042779503%2FPackages%2F244675578"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div class="pull-right">
<div class="platform-tags no-gutters">
<div class="platform-tag common-like">common</div>
</div>
</div>
</div>
<div></div>
</div>
</div>
<a data-name="563051638%2FPackages%2F1967979793" anchor-label="space.kscience.kmath.misc" id="563051638%2FPackages%2F1967979793" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain :kmath-core:dokkaHtmlPartial/jsMain :kmath-core:dokkaHtmlPartial/jvmMain :kmath-core:dokkaHtmlPartial/nativeMain :kmath-core:dokkaHtmlPartial/wasmMain"></a>
<div class="table-row" data-filterable-current=":kmath-core:dokkaHtmlPartial/commonMain :kmath-core:dokkaHtmlPartial/jsMain :kmath-core:dokkaHtmlPartial/jvmMain :kmath-core:dokkaHtmlPartial/nativeMain :kmath-core:dokkaHtmlPartial/wasmMain" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain :kmath-core:dokkaHtmlPartial/jsMain :kmath-core:dokkaHtmlPartial/jvmMain :kmath-core:dokkaHtmlPartial/nativeMain :kmath-core:dokkaHtmlPartial/wasmMain">
<div>
<div class="main-subrow ">
<div class=""><span class="inline-flex">
<div><a href="space.kscience.kmath.misc/index.html">space.kscience.kmath.misc</a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="563051638%2FPackages%2F1967979793"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div class="pull-right">
<div class="platform-tags no-gutters">
<div class="platform-tag common-like">common</div>
<div class="platform-tag js-like">js</div>
<div class="platform-tag jvm-like">jvm</div>
<div class="platform-tag native-like">native</div>
<div class="platform-tag wasm-like">wasm</div>
</div>
</div>
</div>
<div></div>
</div>
</div>
<a data-name="-129440064%2FPackages%2F244675578" anchor-label="space.kscience.kmath.nd" id="-129440064%2FPackages%2F244675578" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-core:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain">
<div>
<div class="main-subrow ">
<div class=""><span class="inline-flex">
<div><a href="space.kscience.kmath.nd/index.html">space.kscience.kmath.nd</a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-129440064%2FPackages%2F244675578"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div class="pull-right">
<div class="platform-tags no-gutters">
<div class="platform-tag common-like">common</div>
</div>
</div>
</div>
<div></div>
</div>
</div>
<a data-name="343642486%2FPackages%2F1967979793" anchor-label="space.kscience.kmath.operations" id="343642486%2FPackages%2F1967979793" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain :kmath-core:dokkaHtmlPartial/jsMain :kmath-core:dokkaHtmlPartial/jvmMain :kmath-core:dokkaHtmlPartial/nativeMain :kmath-core:dokkaHtmlPartial/wasmMain"></a>
<div class="table-row" data-filterable-current=":kmath-core:dokkaHtmlPartial/commonMain :kmath-core:dokkaHtmlPartial/jsMain :kmath-core:dokkaHtmlPartial/jvmMain :kmath-core:dokkaHtmlPartial/nativeMain :kmath-core:dokkaHtmlPartial/wasmMain" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain :kmath-core:dokkaHtmlPartial/jsMain :kmath-core:dokkaHtmlPartial/jvmMain :kmath-core:dokkaHtmlPartial/nativeMain :kmath-core:dokkaHtmlPartial/wasmMain">
<div>
<div class="main-subrow ">
<div class=""><span class="inline-flex">
<div><a href="space.kscience.kmath.operations/index.html">space.kscience.kmath.operations</a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="343642486%2FPackages%2F1967979793"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div class="pull-right">
<div class="platform-tags no-gutters">
<div class="platform-tag common-like">common</div>
<div class="platform-tag js-like">js</div>
<div class="platform-tag jvm-like">jvm</div>
<div class="platform-tag native-like">native</div>
<div class="platform-tag wasm-like">wasm</div>
</div>
</div>
</div>
<div></div>
</div>
</div>
<a data-name="839815658%2FPackages%2F244675578" anchor-label="space.kscience.kmath.structures" id="839815658%2FPackages%2F244675578" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-core:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain">
<div>
<div class="main-subrow ">
<div class=""><span class="inline-flex">
<div><a href="space.kscience.kmath.structures/index.html">space.kscience.kmath.structures</a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="839815658%2FPackages%2F244675578"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div class="pull-right">
<div class="platform-tags no-gutters">
<div class="platform-tag common-like">common</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>