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

163 lines
18 KiB
HTML

<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>space.kscience.kmath.coroutines</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-coroutines::space.kscience.kmath.coroutines////PointingToDeclaration//-205805890">
<div class="navigation-wrapper" id="navigation-wrapper">
<div class="breadcrumbs"><a href="../index.html">kmath-coroutines</a>/<a href="index.html">space.kscience.kmath.coroutines</a></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-coroutines:dokkaHtmlPartial/commonMain">common</button></div>
<div id="searchBar"></div>
</div>
</div>
<div class="cover ">
<h1 class="cover"><span>Package space.</span><wbr><span>kscience.</span><wbr><span>kmath.</span><wbr><span>coroutines</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><button class="section-tab" data-togglable="Properties">Properties</button></div>
<div class="tabs-section-body">
<h2 class="">Types</h2>
<div class="table" data-togglable="Types"><a data-name="571939603%2FClasslikes%2F-205805890" anchor-label="AsyncFlow" id="571939603%2FClasslikes%2F-205805890" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-coroutines:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="-async-flow/index.html">AsyncFlow</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="571939603%2FClasslikes%2F-205805890"></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="platform-tags ">
<div class="platform-tag common-like">common</div>
</div>
<div class="title"><div class="divergent-group" data-filterable-current=":kmath-coroutines:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/commonMain"><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-coroutines:dokkaHtmlPartial/commonMain"><div class="symbol monospace">class <a href="-async-flow/index.html">AsyncFlow</a>&lt;out <a href="-async-flow/index.html">T</a>&gt; : <a href="https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a>&lt;<a href="-async-flow/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></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<h2 class="">Functions</h2>
<div class="table" data-togglable="Functions"><a data-name="1802466894%2FFunctions%2F-205805890" anchor-label="async" id="1802466894%2FFunctions%2F-205805890" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-coroutines:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="async.html">async</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1802466894%2FFunctions%2F-205805890"></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="platform-tags ">
<div class="platform-tag common-like">common</div>
</div>
<div class="title"><div class="divergent-group" data-filterable-current=":kmath-coroutines:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/commonMain"><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-coroutines:dokkaHtmlPartial/commonMain"><div class="symbol monospace">inline fun &lt;<a href="async.html">T</a>, <a href="async.html">R</a>&gt; <a href="https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a>&lt;<a href="async.html">T</a>&gt;.<a href="async.html">async</a>(dispatcher: <a href="https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx-coroutines-core/kotlinx.coroutines/-coroutine-dispatcher/index.html">CoroutineDispatcher</a> = Dispatchers.Default, crossinline block: suspend <a href="https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx-coroutines-core/kotlinx.coroutines/-coroutine-scope/index.html">CoroutineScope</a>.(<a href="async.html">T</a>) -&gt; <a href="async.html">R</a>): <a href="-async-flow/index.html">AsyncFlow</a>&lt;<a href="async.html">R</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></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
<a data-name="-1433985167%2FFunctions%2F-205805890" anchor-label="collect" id="-1433985167%2FFunctions%2F-205805890" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-coroutines:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="collect.html">collect</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1433985167%2FFunctions%2F-205805890"></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="platform-tags ">
<div class="platform-tag common-like">common</div>
</div>
<div class="title"><div class="divergent-group" data-filterable-current=":kmath-coroutines:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/commonMain"><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-coroutines:dokkaHtmlPartial/commonMain"><div class="symbol monospace">inline suspend fun &lt;<a href="collect.html">T</a>&gt; <a href="-async-flow/index.html">AsyncFlow</a>&lt;<a href="collect.html">T</a>&gt;.<a href="collect.html">collect</a>(concurrency: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>, crossinline action: suspend (<a href="collect.html">T</a>) -&gt; <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</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="symbol monospace">suspend fun &lt;<a href="collect.html">T</a>&gt; <a href="-async-flow/index.html">AsyncFlow</a>&lt;<a href="collect.html">T</a>&gt;.<a href="collect.html">collect</a>(concurrency: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>, collector: <a href="https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow-collector/index.html">FlowCollector</a>&lt;<a href="collect.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></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
<a data-name="187106297%2FFunctions%2F-205805890" anchor-label="map" id="187106297%2FFunctions%2F-205805890" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-coroutines:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="map.html">map</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="187106297%2FFunctions%2F-205805890"></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="platform-tags ">
<div class="platform-tag common-like">common</div>
</div>
<div class="title"><div class="divergent-group" data-filterable-current=":kmath-coroutines:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/commonMain"><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-coroutines:dokkaHtmlPartial/commonMain"><div class="symbol monospace">inline fun &lt;<a href="map.html">T</a>, <a href="map.html">R</a>&gt; <a href="-async-flow/index.html">AsyncFlow</a>&lt;<a href="map.html">T</a>&gt;.<a href="map.html">map</a>(crossinline action: (<a href="map.html">T</a>) -&gt; <a href="map.html">R</a>): <a href="-async-flow/index.html">AsyncFlow</a>&lt;<a href="map.html">R</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></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
<a data-name="-1671152088%2FFunctions%2F-205805890" anchor-label="mapParallel" id="-1671152088%2FFunctions%2F-205805890" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-coroutines:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="map-parallel.html">mapParallel</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1671152088%2FFunctions%2F-205805890"></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="platform-tags ">
<div class="platform-tag common-like">common</div>
</div>
<div class="title"><div class="divergent-group" data-filterable-current=":kmath-coroutines:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/commonMain"><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-coroutines:dokkaHtmlPartial/commonMain"><div class="symbol monospace">inline fun &lt;<a href="map-parallel.html">T</a>, <a href="map-parallel.html">R</a>&gt; <a href="https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a>&lt;<a href="map-parallel.html">T</a>&gt;.<a href="map-parallel.html">mapParallel</a>(dispatcher: <a href="https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx-coroutines-core/kotlinx.coroutines/-coroutine-dispatcher/index.html">CoroutineDispatcher</a> = Dispatchers.Default, crossinline transform: suspend (<a href="map-parallel.html">T</a>) -&gt; <a href="map-parallel.html">R</a>): <a href="https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a>&lt;<a href="map-parallel.html">R</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></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<h2 class="">Properties</h2>
<div class="table" data-togglable="Properties"><a data-name="1266578434%2FProperties%2F-205805890" anchor-label="Math" id="1266578434%2FProperties%2F-205805890" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-coroutines:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="-math.html">Math</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1266578434%2FProperties%2F-205805890"></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="platform-tags ">
<div class="platform-tag common-like">common</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-coroutines:dokkaHtmlPartial/commonMain"><a data-name="1266578434%2FProperties%2F-205805890" anchor-label="Math" id="1266578434%2FProperties%2F-205805890" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/commonMain"></a><div class="symbol monospace">val <a href="https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx-coroutines-core/kotlinx.coroutines/-dispatchers/index.html">Dispatchers</a>.<a href="-math.html">Math</a>: <a href="https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx-coroutines-core/kotlinx.coroutines/-coroutine-dispatcher/index.html">CoroutineDispatcher</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>
</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>