forked from kscience/kmath
359 lines
41 KiB
HTML
359 lines
41 KiB
HTML
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>Chain</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.chains/Chain///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.chains</a>/<a href="index.html">Chain</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><button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":kmath-coroutines:dokkaHtmlPartial/jvmMain">jvm</button></div>
|
|
<div id="searchBar"></div>
|
|
</div>
|
|
</div>
|
|
<div class="cover ">
|
|
<h1 class="cover"><span>Chain</span></h1>
|
|
<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">interface <a href="index.html">Chain</a><out <a href="index.html">T</a>> : <a href="https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</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><p class="paragraph">A not-necessary-Markov chain of some type</p></div></div>
|
|
</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="Extensions">Extensions</button><button class="section-tab" data-togglable="Parameters">Parameters</button><button class="section-tab" data-togglable="Sources">Sources</button><button class="section-tab" data-togglable="Inheritors">Inheritors</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-coroutines:dokkaHtmlPartial/commonMain"><div data-togglable="Parameters"><div class="table" data-togglable="Parameters"><div class="table-row" data-filterable-current=":kmath-coroutines:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/commonMain"><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 chain element type</p></div></div></div></div></div></div></div></div></div>
|
|
</div>
|
|
<h2 class="">Types</h2>
|
|
<div class="table" data-togglable="Types"><a data-name="1736295975%2FClasslikes%2F-205805890" anchor-label="Companion" id="1736295975%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="-companion/index.html">Companion</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1736295975%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">object <a href="-companion/index.html">Companion</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="">Functions</h2>
|
|
<div class="table" data-togglable="Functions"><a data-name="-2048743107%2FFunctions%2F-205805890" anchor-label="collect" id="-2048743107%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="-2048743107%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">open suspend override fun <a href="collect.html">collect</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><<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="792287800%2FFunctions%2F-205805890" anchor-label="fork" id="792287800%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="fork.html">fork</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="792287800%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">abstract suspend fun <a href="fork.html">fork</a>(): <a href="index.html">Chain</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>
|
|
<a data-name="792287800%2FFunctions%2F-205805890" anchor-label="fork" id="792287800%2FFunctions%2F-205805890" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/commonMain"></a><div class="brief "><a data-name="792287800%2FFunctions%2F-205805890" anchor-label="fork" id="792287800%2FFunctions%2F-205805890" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/commonMain"></a>Create a copy of current chain state.</div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="2048427303%2FFunctions%2F-205805890" anchor-label="next" id="2048427303%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="next.html">next</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2048427303%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">abstract suspend fun <a href="next.html">next</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>
|
|
<a data-name="2048427303%2FFunctions%2F-205805890" anchor-label="next" id="2048427303%2FFunctions%2F-205805890" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/commonMain"></a><div class="brief "><a data-name="2048427303%2FFunctions%2F-205805890" anchor-label="next" id="2048427303%2FFunctions%2F-205805890" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/commonMain"></a>Generate next value, changing state if needed</div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h2 class="">Inheritors</h2>
|
|
<div class="table" data-togglable="Inheritors"><a data-name="1592205445%2FInheritors%2F-205805890" anchor-label="BufferChain" id="1592205445%2FInheritors%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="../-buffer-chain/index.html">BufferChain</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1592205445%2FInheritors%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>
|
|
</div>
|
|
</div>
|
|
<a data-name="-428258182%2FInheritors%2F-205805890" anchor-label="BlockingChain" id="-428258182%2FInheritors%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="../-blocking-chain/index.html">BlockingChain</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-428258182%2FInheritors%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>
|
|
</div>
|
|
</div>
|
|
<a data-name="-2068043145%2FInheritors%2F-205805890" anchor-label="SimpleChain" id="-2068043145%2FInheritors%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="../-simple-chain/index.html">SimpleChain</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-2068043145%2FInheritors%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>
|
|
</div>
|
|
</div>
|
|
<a data-name="1290342073%2FInheritors%2F-205805890" anchor-label="MarkovChain" id="1290342073%2FInheritors%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="../-markov-chain/index.html">MarkovChain</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1290342073%2FInheritors%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>
|
|
</div>
|
|
</div>
|
|
<a data-name="-1396977327%2FInheritors%2F-205805890" anchor-label="StatefulChain" id="-1396977327%2FInheritors%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="../-stateful-chain/index.html">StatefulChain</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1396977327%2FInheritors%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>
|
|
</div>
|
|
</div>
|
|
<a data-name="-1019062359%2FInheritors%2F-205805890" anchor-label="ConstantChain" id="-1019062359%2FInheritors%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="../-constant-chain/index.html">ConstantChain</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1019062359%2FInheritors%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>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h2 class="tabbedcontent">Extensions</h2>
|
|
<div class="table" data-togglable="Extensions"><a data-name="1092613719%2FExtensions%2F1130137208" anchor-label="asSequence" id="1092613719%2FExtensions%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"><a href="../as-sequence.html">asSequence</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1092613719%2FExtensions%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="platform-tags ">
|
|
<div class="platform-tag jvm-like">jvm</div>
|
|
</div>
|
|
<div class="title"><div class="divergent-group" data-filterable-current=":kmath-coroutines:dokkaHtmlPartial/jvmMain" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/jvmMain"><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/jvmMain"><div class="symbol monospace">fun <<a href="../as-sequence.html">R</a>> <a href="index.html#883885029%2FExtensions%2F1130137208">Chain</a><<a href="../as-sequence.html">R</a>>.<a href="../as-sequence.html">asSequence</a>(): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.sequences/-sequence/index.html">Sequence</a><<a href="../as-sequence.html">R</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>
|
|
<a data-name="1092613719%2FExtensions%2F1130137208" anchor-label="asSequence" id="1092613719%2FExtensions%2F1130137208" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/jvmMain"></a><div class="brief "><a data-name="1092613719%2FExtensions%2F1130137208" anchor-label="asSequence" id="1092613719%2FExtensions%2F1130137208" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/jvmMain"></a>Represent a chain as a sequence</div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="972644398%2FExtensions%2F-205805890" anchor-label="collect" id="972644398%2FExtensions%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="972644398%2FExtensions%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">fun <<a href="../collect.html">T</a>, <a href="../collect.html">R</a>> <a href="index.html">Chain</a><<a href="../collect.html">T</a>>.<a href="../collect.html">collect</a>(mapper: suspend (<a href="index.html">Chain</a><<a href="../collect.html">T</a>>) -> <a href="../collect.html">R</a>): <a href="index.html">Chain</a><<a href="../collect.html">R</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>
|
|
<a data-name="972644398%2FExtensions%2F-205805890" anchor-label="collect" id="972644398%2FExtensions%2F-205805890" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/commonMain"></a><div class="brief "><a data-name="972644398%2FExtensions%2F-205805890" anchor-label="collect" id="972644398%2FExtensions%2F-205805890" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/commonMain"></a>Map the whole chain</div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-2139429896%2FExtensions%2F-205805890" anchor-label="collectWithState" id="-2139429896%2FExtensions%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-with-state.html">collectWithState</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-2139429896%2FExtensions%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">fun <<a href="../collect-with-state.html">T</a>, <a href="../collect-with-state.html">S</a>, <a href="../collect-with-state.html">R</a>> <a href="index.html">Chain</a><<a href="../collect-with-state.html">T</a>>.<a href="../collect-with-state.html">collectWithState</a>(state: <a href="../collect-with-state.html">S</a>, stateFork: (<a href="../collect-with-state.html">S</a>) -> <a href="../collect-with-state.html">S</a>, mapper: suspend <a href="../collect-with-state.html">S</a>.(<a href="index.html">Chain</a><<a href="../collect-with-state.html">T</a>>) -> <a href="../collect-with-state.html">R</a>): <a href="index.html">Chain</a><<a href="../collect-with-state.html">R</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="1464188391%2FExtensions%2F-205805890" anchor-label="filter" id="1464188391%2FExtensions%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="../filter.html">filter</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1464188391%2FExtensions%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">fun <<a href="../filter.html">T</a>> <a href="index.html">Chain</a><<a href="../filter.html">T</a>>.<a href="../filter.html">filter</a>(block: (<a href="../filter.html">T</a>) -> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>): <a href="index.html">Chain</a><<a href="../filter.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>
|
|
<a data-name="1464188391%2FExtensions%2F-205805890" anchor-label="filter" id="1464188391%2FExtensions%2F-205805890" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/commonMain"></a><div class="brief "><a data-name="1464188391%2FExtensions%2F-205805890" anchor-label="filter" id="1464188391%2FExtensions%2F-205805890" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/commonMain"></a><a href="../filter.html">block</a> must be a pure function or at least not use external random variables, otherwise fork could be broken</div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-1315873636%2FExtensions%2F1130137208" anchor-label="iterator" id="-1315873636%2FExtensions%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"><a href="../iterator.html">iterator</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1315873636%2FExtensions%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="platform-tags ">
|
|
<div class="platform-tag jvm-like">jvm</div>
|
|
</div>
|
|
<div class="title"><div class="divergent-group" data-filterable-current=":kmath-coroutines:dokkaHtmlPartial/jvmMain" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/jvmMain"><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/jvmMain"><div class="symbol monospace">operator fun <<a href="../iterator.html">R</a>> <a href="index.html#883885029%2FExtensions%2F1130137208">Chain</a><<a href="../iterator.html">R</a>>.<a href="../iterator.html">iterator</a>(): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-iterator/index.html">Iterator</a><<a href="../iterator.html">R</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>
|
|
<a data-name="-1315873636%2FExtensions%2F1130137208" anchor-label="iterator" id="-1315873636%2FExtensions%2F1130137208" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/jvmMain"></a><div class="brief "><a data-name="-1315873636%2FExtensions%2F1130137208" anchor-label="iterator" id="-1315873636%2FExtensions%2F1130137208" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/jvmMain"></a>Represent a chain as regular iterator (uses blocking calls)</div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-804068761%2FExtensions%2F-205805890" anchor-label="map" id="-804068761%2FExtensions%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="-804068761%2FExtensions%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">fun <<a href="../map.html">T</a>, <a href="../map.html">R</a>> <a href="index.html">Chain</a><<a href="../map.html">T</a>>.<a href="../map.html">map</a>(func: suspend (<a href="../map.html">T</a>) -> <a href="../map.html">R</a>): <a href="index.html">Chain</a><<a href="../map.html">R</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>
|
|
<a data-name="-804068761%2FExtensions%2F-205805890" anchor-label="map" id="-804068761%2FExtensions%2F-205805890" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/commonMain"></a><div class="brief "><a data-name="-804068761%2FExtensions%2F-205805890" anchor-label="map" id="-804068761%2FExtensions%2F-205805890" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/commonMain"></a>Map the chain result using suspended transformation.</div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-700556858%2FExtensions%2F-205805890" anchor-label="nextBuffer" id="-700556858%2FExtensions%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="../next-buffer.html">nextBuffer</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-700556858%2FExtensions%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 <<a href="../next-buffer.html">T</a> : <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>> <a href="index.html">Chain</a><<a href="../next-buffer.html">T</a>>.<a href="../next-buffer.html">nextBuffer</a>(size: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>): <a href="../../../kmath-core/space.kscience.kmath.structures/-buffer/index.html">Buffer</a><<a href="../next-buffer.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="489973241%2FExtensions%2F-205805890" anchor-label="zip" id="489973241%2FExtensions%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="../zip.html">zip</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="489973241%2FExtensions%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">fun <<a href="../zip.html">T</a>, <a href="../zip.html">U</a>, <a href="../zip.html">R</a>> <a href="index.html">Chain</a><<a href="../zip.html">T</a>>.<a href="../zip.html">zip</a>(other: <a href="index.html">Chain</a><<a href="../zip.html">U</a>>, block: suspend (<a href="../zip.html">T</a>, <a href="../zip.html">U</a>) -> <a href="../zip.html">R</a>): <a href="index.html">Chain</a><<a href="../zip.html">R</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>
|
|
<a data-name="489973241%2FExtensions%2F-205805890" anchor-label="zip" id="489973241%2FExtensions%2F-205805890" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/commonMain"></a><div class="brief "><a data-name="489973241%2FExtensions%2F-205805890" anchor-label="zip" id="489973241%2FExtensions%2F-205805890" data-filterable-set=":kmath-coroutines:dokkaHtmlPartial/commonMain"></a>Zip two chains together using given transformation</div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h2 class="">Sources</h2>
|
|
<div class="table" data-togglable="Sources"><a data-name="883885029%2FSource%2F-205805890" anchor-label="https://github.com/mipt-npm/kmath/tree/master/kmath-coroutines/src/commonMain/kotlin/space/kscience/kmath/chains/Chain.kt#L14" id="883885029%2FSource%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="https://github.com/mipt-npm/kmath/tree/master/kmath-coroutines/src/commonMain/kotlin/space/kscience/kmath/chains/Chain.kt#L14">common source</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="883885029%2FSource%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>
|
|
</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>
|
|
|
|
|