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

186 lines
24 KiB
HTML
Raw Normal View History

<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/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-nd4j::space.kscience.kmath.nd4j/Nd4jArrayStructure///PointingToDeclaration//270562306">
<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="cover ">
<h1 class="cover"><span>Nd4j</span><wbr><span>Array</span><wbr><span><span>Structure</span></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"><span class="token keyword">sealed </span><span class="token keyword">class </span><a href="index.html">Nd4jArrayStructure</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator">&gt;</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="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 <span data-unresolved-link="org.nd4j.linalg.api.ndarray/INDArray///PointingToDeclaration/">INDArray</span> 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"><div><span><span>T</span></span></div></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">
<div><a href="elements.html"><span><span>elements</span></span></a></div>
<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="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"><span class="token annotation">@</span><a href="../../../kmath-core/space.kscience.kmath.misc/-performance-pitfall/index.html"><span class="token annotation">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><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="-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">
<div><a href="index.html#-356365875%2FFunctions%2F270562306"><span><span>get</span></span></a></div>
<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="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"><span class="token keyword">abstract </span><span class="token keyword">operator </span><span class="token keyword">fun </span><a href="index.html#-356365875%2FFunctions%2F270562306"><span class="token function">get</span></a><span class="token punctuation">(</span>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 class="token operator">: </span><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>
<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">
<div><a href="index.html#2024771126%2FFunctions%2F270562306"><span>get</span><wbr><span><span>Feature</span></span></a></div>
<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="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"><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%2F270562306">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%2F270562306"><span class="token function">getFeature</span></a><span class="token punctuation">(</span>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%2F270562306">F</a><span class="token operator">&gt;</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html#2024771126%2FFunctions%2F270562306">F</a><span class="token operator">?</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="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">
<div><a href="index.html#1459945780%2FFunctions%2F270562306"><span><span>set</span></span></a></div>
<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="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"><span class="token keyword">abstract </span><span class="token keyword">operator </span><span class="token keyword">fun </span><a href="index.html#1459945780%2FFunctions%2F270562306"><span class="token function">set</span></a><span class="token punctuation">(</span>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>value<span class="token operator">: </span><a href="index.html">T</a><span class="token punctuation">)</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>
</div>
<h2 class="">Properties</h2>
<div class="table" data-togglable="Properties"><a data-name="309648750%2FProperties%2F270562306" anchor-label="dimension" id="309648750%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">
<div><a href="index.html#309648750%2FProperties%2F270562306">dimension</a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="309648750%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="309648750%2FProperties%2F270562306" anchor-label="dimension" id="309648750%2FProperties%2F270562306" data-filterable-set=":kmath-nd4j:dokkaHtmlPartial/main"></a><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%2F270562306">dimension</a><span class="token operator">: </span><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="-11447685%2FProperties%2F270562306" anchor-label="indices" id="-11447685%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">
<div><a href="index.html#-11447685%2FProperties%2F270562306">indices</a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-11447685%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="-11447685%2FProperties%2F270562306" anchor-label="indices" id="-11447685%2FProperties%2F270562306" data-filterable-set=":kmath-nd4j:dokkaHtmlPartial/main"></a><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%2F270562306">indices</a><span class="token operator">: </span><a href="../../../kmath-core/space.kscience.kmath.nd/-shape-indexer/index.html">ShapeIndexer</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">
<div><a href="nd-array.html">ndArray</a></div>
<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"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">val </span><a href="nd-array.html">ndArray</a><span class="token operator">: </span><span data-unresolved-link="org.nd4j.linalg.api.ndarray/INDArray///PointingToDeclaration/">INDArray</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 "><a data-name="1462070920%2FProperties%2F270562306" anchor-label="ndArray" id="1462070920%2FProperties%2F270562306" data-filterable-set=":kmath-nd4j:dokkaHtmlPartial/main"></a><p class="paragraph">The wrapped <span data-unresolved-link="org.nd4j.linalg.api.ndarray/INDArray///PointingToDeclaration/">INDArray</span>. Since KMath uses <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a> indexes, assuming the size of <span data-unresolved-link="org.nd4j.linalg.api.ndarray/INDArray///PointingToDeclaration/">INDArray</span> is less or equal to <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/-m-a-x_-v-a-l-u-e.html">Int.MAX_VALUE</a>.</p></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">
<div><a href="shape.html">shape</a></div>
<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"><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="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">
<div><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></div>
<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" 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>