kmath/kmath-multik/space.kscience.kmath.multik/-multik-tensor/index.html

219 lines
23 KiB
HTML
Raw Permalink Normal View History

<!doctype html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>MultikTensor</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-multik: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="classlike" id="content" pageids="kmath-multik::space.kscience.kmath.multik/MultikTensor///PointingToDeclaration//1678784231">
<div class="breadcrumbs"><a href="../../index.html">kmath-multik</a><span class="delimiter">/</span><a href="../index.html">space.kscience.kmath.multik</a><span class="delimiter">/</span><span class="current">MultikTensor</span></div>
<div class="cover ">
<h1 class="cover"><span>Multik</span><wbr><span><span>Tensor</span></span></h1>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-multik:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-inline/index.html"><span class="token annotation builtin">JvmInline</span></a></div></div><span class="token keyword">value </span><span class="token keyword">class </span><a href="index.html">MultikTensor</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>array<span class="token operator">: </span><span data-unresolved-link="org.jetbrains.kotlinx.multik.ndarray.data/MutableMultiArray///PointingToDeclaration/">MutableMultiArray</span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><span data-unresolved-link="org.jetbrains.kotlinx.multik.ndarray.data/DN///PointingToDeclaration/">DN</span><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</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">T</a><span class="token operator">&gt; </span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/SciProgCentre/kmath/tree/master/kmath-multik/src/commonMain/kotlin/space/kscience/kmath/multik/MultikTensor.kt#L15">source</a>)</span></span></div></div></div>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,FUNCTION,PROPERTY">Members</button></div>
<div class="tabs-section-body">
<div data-togglable="CONSTRUCTOR">
<h2 class="">Constructors</h2>
<div class="table"><a data-name="-1830644779%2FConstructors%2F1678784231" anchor-label="MultikTensor" id="-1830644779%2FConstructors%2F1678784231" data-filterable-set=":kmath-multik:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-togglable="CONSTRUCTOR" data-filterable-current=":kmath-multik:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-multik:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-multik-tensor.html"><span>Multik</span><wbr><span><span>Tensor</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1830644779%2FConstructors%2F1678784231"></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-multik:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">array<span class="token operator">: </span><span data-unresolved-link="org.jetbrains.kotlinx.multik.ndarray.data/MutableMultiArray///PointingToDeclaration/">MutableMultiArray</span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><span data-unresolved-link="org.jetbrains.kotlinx.multik.ndarray.data/DN///PointingToDeclaration/">DN</span><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div data-togglable="FUNCTION">
<h2 class="">Functions</h2>
<div class="table"><a data-name="1455708599%2FFunctions%2F1678784231" anchor-label="elements" id="1455708599%2FFunctions%2F1678784231" data-filterable-set=":kmath-multik:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-multik:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-multik:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="elements.html"><span><span>elements</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1455708599%2FFunctions%2F1678784231"></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-multik:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="../../../kmath-memory/space.kscience.kmath/-performance-pitfall/index.html"><span class="token annotation builtin">PerformancePitfall</span></a></div></div><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="elements.html"><span class="token function">elements</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.sequences/-sequence/index.html">Sequence</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html">Pair</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int-array/index.html">IntArray</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator">&gt;</span><span class="token operator">&gt;</span></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="27468309%2FFunctions%2F1678784231" anchor-label="get" id="27468309%2FFunctions%2F1678784231" data-filterable-set=":kmath-multik:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-multik:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-multik:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="get.html"><span><span>get</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="27468309%2FFunctions%2F1678784231"></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-multik:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="../../../kmath-memory/space.kscience.kmath/-performance-pitfall/index.html"><span class="token annotation builtin">PerformancePitfall</span></a></div></div><span class="token keyword">open </span><span class="token keyword">operator override </span><span class="token keyword">fun </span><a href="get.html"><span class="token function">get</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">index<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int-array/index.html">IntArray</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">T</a></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="2024771126%2FFunctions%2F1678784231" anchor-label="getFeature" id="2024771126%2FFunctions%2F1678784231" data-filterable-set=":kmath-multik:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-multik:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-multik:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="index.html#2024771126%2FFunctions%2F1678784231"><span>get</span><wbr><span><span>Feature</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2024771126%2FFunctions%2F1678784231"></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-multik:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html#2024771126%2FFunctions%2F1678784231">F</a><span class="token operator"> : </span><a href="../../../kmath-core/space.kscience.kmath.nd/-structure-feature/index.html">StructureFeature</a><span class="token operator">&gt; </span><a href="index.html#2024771126%2FFunctions%2F1678784231"><span class="token function">getFeature</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">type<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.html">KClass</a><span class="token operator">&lt;</span><span class="token keyword">out </span><a href="index.html#2024771126%2FFunctions%2F1678784231">F</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html#2024771126%2FFunctions%2F1678784231">F</a><span class="token operator">?</span></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-680778048%2FFunctions%2F1678784231" anchor-label="set" id="-680778048%2FFunctions%2F1678784231" data-filterable-set=":kmath-multik:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-multik:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-multik:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="set.html"><span><span>set</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-680778048%2FFunctions%2F1678784231"></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-multik:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="../../../kmath-memory/space.kscience.kmath/-performance-pitfall/index.html"><span class="token annotation builtin">PerformancePitfall</span></a></div></div><span class="token keyword">open </span><span class="token keyword">operator override </span><span class="token keyword">fun </span><a href="set.html"><span class="token function">set</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">index<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int-array/index.html">IntArray</a><span class="token punctuation">, </span></span><span class="parameter ">value<span class="token operator">: </span><a href="index.html">T</a></span></span><span class="token punctuation">)</span></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div data-togglable="PROPERTY">
<h2 class="">Properties</h2>
<div class="table"><a data-name="-1978706413%2FProperties%2F1678784231" anchor-label="array" id="-1978706413%2FProperties%2F1678784231" data-filterable-set=":kmath-multik:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-multik:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-multik:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="array.html"><span><span>array</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1978706413%2FProperties%2F1678784231"></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-multik:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="array.html">array</a><span class="token operator">: </span><span data-unresolved-link="org.jetbrains.kotlinx.multik.ndarray.data/MutableMultiArray///PointingToDeclaration/">MutableMultiArray</span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><span data-unresolved-link="org.jetbrains.kotlinx.multik.ndarray.data/DN///PointingToDeclaration/">DN</span><span class="token operator">&gt;</span></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="309648750%2FProperties%2F1678784231" anchor-label="dimension" id="309648750%2FProperties%2F1678784231" data-filterable-set=":kmath-multik:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-multik:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-multik:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="index.html#309648750%2FProperties%2F1678784231"><span><span>dimension</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="309648750%2FProperties%2F1678784231"></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-multik:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword"></span><span class="token keyword">val </span><a href="index.html#309648750%2FProperties%2F1678784231">dimension</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-11447685%2FProperties%2F1678784231" anchor-label="indices" id="-11447685%2FProperties%2F1678784231" data-filterable-set=":kmath-multik:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-multik:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-multik:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="index.html#-11447685%2FProperties%2F1678784231"><span><span>indices</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-11447685%2FProperties%2F1678784231"></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-multik:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword"></span><span class="token keyword">val </span><a href="index.html#-11447685%2FProperties%2F1678784231">indices</a><span class="token operator">: </span><a href="../../../kmath-core/space.kscience.kmath.nd/-shape-indexer/index.html">ShapeIndexer</a></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="838367691%2FProperties%2F1678784231" anchor-label="shape" id="838367691%2FProperties%2F1678784231" data-filterable-set=":kmath-multik:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-multik:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-multik:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="shape.html"><span><span>shape</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="838367691%2FProperties%2F1678784231"></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-multik:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">val </span><a href="shape.html">shape</a><span class="token operator">: </span><a href="../../../kmath-core/space.kscience.kmath.nd/-shape-n-d/index.html">ShapeND</a></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>