kmath/kmath-coroutines/space.kscience.kmath.structures/index.html

135 lines
20 KiB
HTML
Raw Normal View History

<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>space.kscience.kmath.structures</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">
<div class="filter-section" id="filter-section"><button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":kmath-coroutines:dokkaHtmlPartial/jvmMain">jvm</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-coroutines::space.kscience.kmath.structures////PointingToDeclaration//1130137208">
<div class="breadcrumbs"><a href="../index.html">kmath-coroutines</a>/<a href="index.html">space.kscience.kmath.structures</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>structures</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><button class="section-tab" data-togglable="Functions">Functions</button></div>
<div class="tabs-section-body">
<h2 class="">Types</h2>
<div class="table" data-togglable="Types"><a data-name="-1916795709%2FClasslikes%2F1130137208" anchor-label="LazyStructureND" id="-1916795709%2FClasslikes%2F1130137208" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/jvmMain"></a>
<div class="table-row" data-filterable-current=":kmath-coroutines:dokkaHtmlPartial/jvmMain" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/jvmMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-lazy-structure-n-d/index.html"><span>Lazy</span><wbr><span>Structure</span><wbr><span><span>ND</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1916795709%2FClasslikes%2F1130137208"></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 with-platform-tabs" data-platform-hinted="data-platform-hinted">
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark jvm-like" data-filterable-current=":kmath-coroutines:dokkaHtmlPartial/jvmMain" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/jvmMain" data-active="" data-toggle=":kmath-coroutines:dokkaHtmlPartial/jvmMain">jvm</button></div>
<div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-coroutines:dokkaHtmlPartial/jvmMain"><div class="symbol monospace"><span class="token keyword">class </span><a href="-lazy-structure-n-d/index.html">LazyStructureND</a><span class="token operator">&lt;</span><span class="token keyword">out </span><a href="-lazy-structure-n-d/index.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">(</span>scope<span class="token operator">: </span><a href="https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx-coroutines-core/kotlinx.coroutines/-coroutine-scope/index.html">CoroutineScope</a><span class="token punctuation">, </span>shape<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>function<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</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 operator"> -&gt; </span><span class="token keyword"></span><a href="-lazy-structure-n-d/index.html">T</a><span class="token punctuation">)</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="-lazy-structure-n-d/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></div> </div>
</div>
</div>
</div>
</div>
</div>
<h2 class="">Functions</h2>
<div class="table" data-togglable="Functions"><a data-name="1240136609%2FFunctions%2F1130137208" anchor-label="await" id="1240136609%2FFunctions%2F1130137208" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/jvmMain"></a>
<div class="table-row" data-filterable-current=":kmath-coroutines:dokkaHtmlPartial/jvmMain" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/jvmMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="await.html"><span><span>await</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1240136609%2FFunctions%2F1130137208"></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 with-platform-tabs" data-platform-hinted="data-platform-hinted">
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark jvm-like" data-filterable-current=":kmath-coroutines:dokkaHtmlPartial/jvmMain" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/jvmMain" data-active="" data-toggle=":kmath-coroutines:dokkaHtmlPartial/jvmMain">jvm</button></div>
<div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-coroutines:dokkaHtmlPartial/jvmMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="await.html">T</a><span class="token operator">&gt; </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="await.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="await.html"><span class="token function">await</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="await.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="-373025414%2FFunctions%2F1130137208" anchor-label="deferred" id="-373025414%2FFunctions%2F1130137208" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/jvmMain"></a>
<div class="table-row" data-filterable-current=":kmath-coroutines:dokkaHtmlPartial/jvmMain" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/jvmMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="deferred.html"><span><span>deferred</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-373025414%2FFunctions%2F1130137208"></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 with-platform-tabs" data-platform-hinted="data-platform-hinted">
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark jvm-like" data-filterable-current=":kmath-coroutines:dokkaHtmlPartial/jvmMain" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/jvmMain" data-active="" data-toggle=":kmath-coroutines:dokkaHtmlPartial/jvmMain">jvm</button></div>
<div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-coroutines:dokkaHtmlPartial/jvmMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="deferred.html">T</a><span class="token operator">&gt; </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="deferred.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="deferred.html"><span class="token function">deferred</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="https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx-coroutines-core/kotlinx.coroutines/-deferred/index.html">Deferred</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="deferred.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></div> </div>
</div>
</div>
</div>
</div>
<a data-name="349968356%2FFunctions%2F1130137208" anchor-label="mapAsync" id="349968356%2FFunctions%2F1130137208" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/jvmMain"></a>
<div class="table-row" data-filterable-current=":kmath-coroutines:dokkaHtmlPartial/jvmMain" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/jvmMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="map-async.html"><span>map</span><wbr><span><span>Async</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="349968356%2FFunctions%2F1130137208"></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 with-platform-tabs" data-platform-hinted="data-platform-hinted">
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark jvm-like" data-filterable-current=":kmath-coroutines:dokkaHtmlPartial/jvmMain" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/jvmMain" data-active="" data-toggle=":kmath-coroutines:dokkaHtmlPartial/jvmMain">jvm</button></div>
<div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-coroutines:dokkaHtmlPartial/jvmMain"><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="map-async.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="map-async.html">R</a><span class="token operator">&gt; </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="map-async.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="map-async.html"><span class="token function">mapAsync</span></a><span class="token punctuation">(</span>scope<span class="token operator">: </span><a href="https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx-coroutines-core/kotlinx.coroutines/-coroutine-scope/index.html">CoroutineScope</a><span class="token punctuation">, </span><span class="token keyword">crossinline </span>function<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><span class="token keyword"></span><a href="map-async.html">T</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="map-async.html">R</a><span class="token punctuation">)</span><span class="token operator">: </span><a href="-lazy-structure-n-d/index.html">LazyStructureND</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="map-async.html">R</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="473046289%2FFunctions%2F1130137208" anchor-label="mapAsyncIndexed" id="473046289%2FFunctions%2F1130137208" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/jvmMain"></a>
<div class="table-row" data-filterable-current=":kmath-coroutines:dokkaHtmlPartial/jvmMain" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/jvmMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="map-async-indexed.html"><span>map</span><wbr><span>Async</span><wbr><span><span>Indexed</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="473046289%2FFunctions%2F1130137208"></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 with-platform-tabs" data-platform-hinted="data-platform-hinted">
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark jvm-like" data-filterable-current=":kmath-coroutines:dokkaHtmlPartial/jvmMain" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/jvmMain" data-active="" data-toggle=":kmath-coroutines:dokkaHtmlPartial/jvmMain">jvm</button></div>
<div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-coroutines:dokkaHtmlPartial/jvmMain"><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="map-async-indexed.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="map-async-indexed.html">R</a><span class="token operator">&gt; </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="map-async-indexed.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="map-async-indexed.html"><span class="token function">mapAsyncIndexed</span></a><span class="token punctuation">(</span>scope<span class="token operator">: </span><a href="https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx-coroutines-core/kotlinx.coroutines/-coroutine-scope/index.html">CoroutineScope</a><span class="token punctuation">, </span><span class="token keyword">crossinline </span>function<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><span class="token keyword"></span><a href="map-async-indexed.html">T</a><span class="token punctuation">, </span><span class="token keyword"></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"> -&gt; </span><span class="token keyword"></span><a href="map-async-indexed.html">R</a><span class="token punctuation">)</span><span class="token operator">: </span><a href="-lazy-structure-n-d/index.html">LazyStructureND</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="map-async-indexed.html">R</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">PENDING would benefit from KEEP-176</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>