kmath/kmath-nd4j/space.kscience.kmath.nd4j/-nd4j-array-structure/index.html

167 lines
19 KiB
HTML

<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>Nd4jArrayStructure</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/logo-styles.css" rel="Stylesheet"><link href="../../../styles/jetbrains-mono.css" rel="Stylesheet"><link href="../../../styles/main.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" async></script>
<div id="container">
<div id="leftColumn"><a href="../../../index.html">
<div id="logo"></div>
</a>
<div id="paneSearch"></div>
<div id="sideMenu"></div>
</div>
<div id="main">
<script type="text/javascript" src="../../../scripts/main.js"></script><div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="main-content" id="content" pageids="kmath-nd4j::space.kscience.kmath.nd4j/Nd4jArrayStructure///PointingToDeclaration//270562306">
<div class="navigation-wrapper" id="navigation-wrapper">
<div class="breadcrumbs"><a href="../../index.html">kmath-nd4j</a>/<a href="../index.html">space.kscience.kmath.nd4j</a>/<a href="index.html">Nd4jArrayStructure</a></div>
<div class="pull-right d-flex">
<div id="searchBar"></div>
</div>
</div>
<div class="cover ">
<h1 class="cover"><span>Nd4j</span><wbr><span>Array</span><wbr><span>Structure</span></h1>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-nd4j:dokkaHtmlPartial/main"><div class="symbol monospace">sealed class <a href="index.html">Nd4jArrayStructure</a>&lt;<a href="index.html">T</a>&gt; : <a href="../../../kmath-core/space.kscience.kmath.nd/-mutable-structure-n-d/index.html">MutableStructureND</a>&lt;<a href="index.html">T</a>&gt; <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">Represents a <a href="../../../kmath-core/space.kscience.kmath.nd/-structure-n-d/index.html">StructureND</a> wrapping an <a href="https://deeplearning4j.org/api/latest/org/nd4j/linalg/api/ndarray/INDArray.html">INDArray</a> object.</p></div></div>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="Functions">Functions</button><button class="section-tab" data-togglable="Properties">Properties</button><button class="section-tab" data-togglable="Parameters">Parameters</button><button class="section-tab" data-togglable="Sources">Sources</button></div>
<div class="tabs-section-body">
<h2 class="">Parameters</h2>
<div data-togglable="Parameters">
<div class="platform-hinted WithExtraAttributes" data-platform-hinted="data-platform-hinted" data-togglable="Parameters"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-nd4j:dokkaHtmlPartial/main"><div data-togglable="Parameters"><div class="table" data-togglable="Parameters"><div class="table-row" data-filterable-current=":kmath-nd4j:dokkaHtmlPartial/main" data-filterable-set=":kmath-nd4j:dokkaHtmlPartial/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">T</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">the type of items.</p></div></div></div></div></div></div></div></div></div>
</div>
<h2 class="">Functions</h2>
<div class="table" data-togglable="Functions"><a data-name="-1339675464%2FFunctions%2F270562306" anchor-label="elements" id="-1339675464%2FFunctions%2F270562306" data-filterable-set=":kmath-nd4j:dokkaHtmlPartial/main"></a>
<div class="table-row" data-filterable-current=":kmath-nd4j:dokkaHtmlPartial/main" data-filterable-set=":kmath-nd4j:dokkaHtmlPartial/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="elements.html">elements</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1339675464%2FFunctions%2F270562306"></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="divergent-group" data-filterable-current=":kmath-nd4j:dokkaHtmlPartial/main" data-filterable-set=":kmath-nd4j:dokkaHtmlPartial/main"><div class="with-platform-tags"><span class="pull-right"></span></div>
<div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-nd4j:dokkaHtmlPartial/main"><div class="symbol monospace"><div class="block"><div class="block">@<a href="../../../kmath-core/space.kscience.kmath.misc/-performance-pitfall/index.html">PerformancePitfall</a>()</div></div>open override fun <a href="elements.html">elements</a>(): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.sequences/-sequence/index.html">Sequence</a>&lt;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html">Pair</a>&lt;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int-array/index.html">IntArray</a>, <a href="index.html">T</a>&gt;&gt;<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>
</div>
</div>
<a data-name="-356365875%2FFunctions%2F270562306" anchor-label="get" id="-356365875%2FFunctions%2F270562306" data-filterable-set=":kmath-nd4j:dokkaHtmlPartial/main"></a>
<div class="table-row" data-filterable-current=":kmath-nd4j:dokkaHtmlPartial/main" data-filterable-set=":kmath-nd4j:dokkaHtmlPartial/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="index.html#-356365875%2FFunctions%2F270562306">get</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-356365875%2FFunctions%2F270562306"></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="divergent-group" data-filterable-current=":kmath-nd4j:dokkaHtmlPartial/main" data-filterable-set=":kmath-nd4j:dokkaHtmlPartial/main"><div class="with-platform-tags"><span class="pull-right"></span></div>
<div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-nd4j:dokkaHtmlPartial/main"><div class="symbol monospace">abstract operator fun <a href="index.html#-356365875%2FFunctions%2F270562306">get</a>(index: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int-array/index.html">IntArray</a>): <a href="index.html">T</a><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>
</div>
</div>
<a data-name="2024771126%2FFunctions%2F270562306" anchor-label="getFeature" id="2024771126%2FFunctions%2F270562306" data-filterable-set=":kmath-nd4j:dokkaHtmlPartial/main"></a>
<div class="table-row" data-filterable-current=":kmath-nd4j:dokkaHtmlPartial/main" data-filterable-set=":kmath-nd4j:dokkaHtmlPartial/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="index.html#2024771126%2FFunctions%2F270562306">getFeature</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2024771126%2FFunctions%2F270562306"></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="divergent-group" data-filterable-current=":kmath-nd4j:dokkaHtmlPartial/main" data-filterable-set=":kmath-nd4j:dokkaHtmlPartial/main"><div class="with-platform-tags"><span class="pull-right"></span></div>
<div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-nd4j:dokkaHtmlPartial/main"><div class="symbol monospace">open override fun &lt;<a href="index.html#2024771126%2FFunctions%2F270562306">F</a> : <a href="../../../kmath-core/space.kscience.kmath.nd/-structure-feature/index.html">StructureFeature</a>&gt; <a href="index.html#2024771126%2FFunctions%2F270562306">getFeature</a>(type: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.html">KClass</a>&lt;out <a href="index.html#2024771126%2FFunctions%2F270562306">F</a>&gt;): <a href="index.html#2024771126%2FFunctions%2F270562306">F</a>?<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>
</div>
</div>
<a data-name="1459945780%2FFunctions%2F270562306" anchor-label="set" id="1459945780%2FFunctions%2F270562306" data-filterable-set=":kmath-nd4j:dokkaHtmlPartial/main"></a>
<div class="table-row" data-filterable-current=":kmath-nd4j:dokkaHtmlPartial/main" data-filterable-set=":kmath-nd4j:dokkaHtmlPartial/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="index.html#1459945780%2FFunctions%2F270562306">set</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1459945780%2FFunctions%2F270562306"></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="divergent-group" data-filterable-current=":kmath-nd4j:dokkaHtmlPartial/main" data-filterable-set=":kmath-nd4j:dokkaHtmlPartial/main"><div class="with-platform-tags"><span class="pull-right"></span></div>
<div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-nd4j:dokkaHtmlPartial/main"><div class="symbol monospace">abstract operator fun <a href="index.html#1459945780%2FFunctions%2F270562306">set</a>(index: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int-array/index.html">IntArray</a>, value: <a href="index.html">T</a>)<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>
</div>
</div>
</div>
<h2 class="">Properties</h2>
<div class="table" data-togglable="Properties"><a data-name="582132037%2FProperties%2F270562306" anchor-label="dimension" id="582132037%2FProperties%2F270562306" data-filterable-set=":kmath-nd4j:dokkaHtmlPartial/main"></a>
<div class="table-row" data-filterable-current=":kmath-nd4j:dokkaHtmlPartial/main" data-filterable-set=":kmath-nd4j:dokkaHtmlPartial/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="index.html#582132037%2FProperties%2F270562306">dimension</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="582132037%2FProperties%2F270562306"></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" data-togglable="Properties"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-nd4j:dokkaHtmlPartial/main"><a data-name="582132037%2FProperties%2F270562306" anchor-label="dimension" id="582132037%2FProperties%2F270562306" data-filterable-set=":kmath-nd4j:dokkaHtmlPartial/main"></a><div class="symbol monospace">open val <a href="index.html#582132037%2FProperties%2F270562306">dimension</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><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="1462070920%2FProperties%2F270562306" anchor-label="ndArray" id="1462070920%2FProperties%2F270562306" data-filterable-set=":kmath-nd4j:dokkaHtmlPartial/main"></a>
<div class="table-row" data-filterable-current=":kmath-nd4j:dokkaHtmlPartial/main" data-filterable-set=":kmath-nd4j:dokkaHtmlPartial/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="nd-array.html">ndArray</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1462070920%2FProperties%2F270562306"></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" data-togglable="Properties"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-nd4j:dokkaHtmlPartial/main"><a data-name="1462070920%2FProperties%2F270562306" anchor-label="ndArray" id="1462070920%2FProperties%2F270562306" data-filterable-set=":kmath-nd4j:dokkaHtmlPartial/main"></a><div class="symbol monospace">abstract val <a href="nd-array.html">ndArray</a>: <a href="https://deeplearning4j.org/api/latest/org/nd4j/linalg/api/ndarray/INDArray.html">INDArray</a><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 "><a data-name="1462070920%2FProperties%2F270562306" anchor-label="ndArray" id="1462070920%2FProperties%2F270562306" data-filterable-set=":kmath-nd4j:dokkaHtmlPartial/main"></a>The wrapped <a href="https://deeplearning4j.org/api/latest/org/nd4j/linalg/api/ndarray/INDArray.html">INDArray</a>.</div></div></div>
</div>
</div>
</div>
</div>
<a data-name="237661802%2FProperties%2F270562306" anchor-label="shape" id="237661802%2FProperties%2F270562306" data-filterable-set=":kmath-nd4j:dokkaHtmlPartial/main"></a>
<div class="table-row" data-filterable-current=":kmath-nd4j:dokkaHtmlPartial/main" data-filterable-set=":kmath-nd4j:dokkaHtmlPartial/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="shape.html">shape</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="237661802%2FProperties%2F270562306"></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" data-togglable="Properties"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-nd4j:dokkaHtmlPartial/main"><a data-name="237661802%2FProperties%2F270562306" anchor-label="shape" id="237661802%2FProperties%2F270562306" data-filterable-set=":kmath-nd4j:dokkaHtmlPartial/main"></a><div class="symbol monospace">open override val <a href="shape.html">shape</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int-array/index.html">IntArray</a><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>
</div>
<h2 class="">Sources</h2>
<div class="table" data-togglable="Sources"><a data-name="536453296%2FSource%2F270562306" anchor-label="https://github.com/mipt-npm/kmath/tree/master/kmath-nd4j/src/main/kotlin/space/kscience/kmath/nd4j/Nd4jArrayStructure.kt#L13" id="536453296%2FSource%2F270562306" data-filterable-set=":kmath-nd4j:dokkaHtmlPartial/main"></a>
<div class="table-row" data-filterable-current=":kmath-nd4j:dokkaHtmlPartial/main" data-filterable-set=":kmath-nd4j:dokkaHtmlPartial/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="https://github.com/mipt-npm/kmath/tree/master/kmath-nd4j/src/main/kotlin/space/kscience/kmath/nd4j/Nd4jArrayStructure.kt#L13">jvm source</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="536453296%2FSource%2F270562306"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer"><span class="go-to-top-icon"><a href="#content"></a></span><span>© 2021 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>