kmath/kmath-stat/kmath-stat/space.kscience.kmath.stat/-random-chain/index.html

210 lines
23 KiB
HTML
Raw Normal View History

<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>RandomChain</title>
<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="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="async"></script>
<script type="text/javascript" src="../../../scripts/navigation-loader.js" async="async"></script>
<script type="text/javascript" src="../../../scripts/platform-content-handler.js" async="async"></script>
<script type="text/javascript" src="../../../scripts/main.js" async="async"></script>
</head>
<body>
<div id="container">
<div id="leftColumn">
<div id="logo"></div>
<div id="paneSearch"></div>
<div id="sideMenu"></div>
</div>
<div id="main">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<script type="text/javascript" src="../../../scripts/pages.js"></script>
<script type="text/javascript" src="../../../scripts/main.js"></script>
<div class="main-content" id="content" pageIds="space.kscience.kmath.stat/RandomChain///PointingToDeclaration//1337332980">
<div class="navigation-wrapper" id="navigation-wrapper">
<div class="breadcrumbs"><a href="../../index.html">kmath-stat</a>/<a href="../index.html">space.kscience.kmath.stat</a>/<a href="index.html">RandomChain</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-stat:dokkaHtml/commonMain">common</button></div>
<div id="searchBar"></div>
</div>
</div>
<div class="cover ">
<h1 class="cover"><span>Random</span><wbr></wbr><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-stat:dokkaHtml/commonMain"><div class="symbol monospace">class <a href="index.html">RandomChain</a>&lt;out <a href="index.html">R</a>&gt;(generator: <a href="../-random-generator/index.html">RandomGenerator</a>, gen: suspend <a href="../-random-generator/index.html">RandomGenerator</a>.() -&gt; <a href="index.html">R</a>) : <span data-unresolved-link="space.kscience.kmath.chains/Chain///PointingToDeclaration/">Chain</span>&lt;<a href="index.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><p class="paragraph">A possibly stateful chain producing random values.</p></div></div>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="Constructors">Constructors</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="tabbedcontent">Constructors</h2>
<div class="table" data-togglable="Constructors"><a data-name="%5Bspace.kscience.kmath.stat%2FRandomChain%2FRandomChain%2F%23space.kscience.kmath.stat.RandomGenerator%23kotlin.coroutines.SuspendFunction1%5Bspace.kscience.kmath.stat.RandomGenerator%2CTypeParam%28bounds%3D%5Bkotlin.Any%3F%5D%29%5D%2FPointingToDeclaration%2F%5D%2FConstructors%2F1337332980" anchor-label="RandomChain" id="%5Bspace.kscience.kmath.stat%2FRandomChain%2FRandomChain%2F%23space.kscience.kmath.stat.RandomGenerator%23kotlin.coroutines.SuspendFunction1%5Bspace.kscience.kmath.stat.RandomGenerator%2CTypeParam%28bounds%3D%5Bkotlin.Any%3F%5D%29%5D%2FPointingToDeclaration%2F%5D%2FConstructors%2F1337332980" data-filterable-set=":kmath-stat:dokkaHtml/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-stat:dokkaHtml/commonMain" data-filterable-set=":kmath-stat:dokkaHtml/commonMain">
<div class="main-subrow keyValue TabbedContent">
<div class=""><span class="inline-flex"><a href="-random-chain.html">RandomChain</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bspace.kscience.kmath.stat%2FRandomChain%2FRandomChain%2F%23space.kscience.kmath.stat.RandomGenerator%23kotlin.coroutines.SuspendFunction1%5Bspace.kscience.kmath.stat.RandomGenerator%2CTypeParam%28bounds%3D%5Bkotlin.Any%3F%5D%29%5D%2FPointingToDeclaration%2F%5D%2FConstructors%2F1337332980"></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"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-stat:dokkaHtml/commonMain"><div class="symbol monospace">fun &lt;out <a href="index.html">R</a>&gt; <a href="-random-chain.html">RandomChain</a>(generator: <a href="../-random-generator/index.html">RandomGenerator</a>, gen: suspend <a href="../-random-generator/index.html">RandomGenerator</a>.() -&gt; <a href="index.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>
<h2 class="">Functions</h2>
<div class="table" data-togglable="Functions"><a data-name="%5Bspace.kscience.kmath.chains%2FChain%2Fcollect%2F%23kotlinx.coroutines.flow.FlowCollector%5BTypeParam%28bounds%3D%5Bkotlin.Any%3F%5D%29%5D%2FPointingToDeclaration%2F%5D%2FFunctions%2F1337332980" anchor-label="collect" id="%5Bspace.kscience.kmath.chains%2FChain%2Fcollect%2F%23kotlinx.coroutines.flow.FlowCollector%5BTypeParam%28bounds%3D%5Bkotlin.Any%3F%5D%29%5D%2FPointingToDeclaration%2F%5D%2FFunctions%2F1337332980" data-filterable-set=":kmath-stat:dokkaHtml/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-stat:dokkaHtml/commonMain" data-filterable-set=":kmath-stat:dokkaHtml/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="index.html#%5Bspace.kscience.kmath.chains%2FChain%2Fcollect%2F%23kotlinx.coroutines.flow.FlowCollector%5BTypeParam%28bounds%3D%5Bkotlin.Any%3F%5D%29%5D%2FPointingToDeclaration%2F%5D%2FFunctions%2F1337332980">collect</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bspace.kscience.kmath.chains%2FChain%2Fcollect%2F%23kotlinx.coroutines.flow.FlowCollector%5BTypeParam%28bounds%3D%5Bkotlin.Any%3F%5D%29%5D%2FPointingToDeclaration%2F%5D%2FFunctions%2F1337332980"></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-stat:dokkaHtml/commonMain" data-filterable-set=":kmath-stat:dokkaHtml/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-stat:dokkaHtml/commonMain"><div class="symbol monospace">open suspend override fun <a href="index.html#%5Bspace.kscience.kmath.chains%2FChain%2Fcollect%2F%23kotlinx.coroutines.flow.FlowCollector%5BTypeParam%28bounds%3D%5Bkotlin.Any%3F%5D%29%5D%2FPointingToDeclaration%2F%5D%2FFunctions%2F1337332980">collect</a>(collector: <span data-unresolved-link="kotlinx.coroutines.flow/FlowCollector///PointingToDeclaration/">FlowCollector</span>&lt;<a href="index.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="%5Bkotlin%2FAny%2Fequals%2F%23kotlin.Any%3F%2FPointingToDeclaration%2F%5D%2FFunctions%2F1337332980" anchor-label="equals" id="%5Bkotlin%2FAny%2Fequals%2F%23kotlin.Any%3F%2FPointingToDeclaration%2F%5D%2FFunctions%2F1337332980" data-filterable-set=":kmath-stat:dokkaHtml/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-stat:dokkaHtml/commonMain" data-filterable-set=":kmath-stat:dokkaHtml/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="../-uniform-distribution/index.html#%5Bkotlin%2FAny%2Fequals%2F%23kotlin.Any%3F%2FPointingToDeclaration%2F%5D%2FFunctions%2F1337332980">equals</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bkotlin%2FAny%2Fequals%2F%23kotlin.Any%3F%2FPointingToDeclaration%2F%5D%2FFunctions%2F1337332980"></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-stat:dokkaHtml/commonMain" data-filterable-set=":kmath-stat:dokkaHtml/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-stat:dokkaHtml/commonMain"><div class="symbol monospace">open operator fun <a href="../-uniform-distribution/index.html#%5Bkotlin%2FAny%2Fequals%2F%23kotlin.Any%3F%2FPointingToDeclaration%2F%5D%2FFunctions%2F1337332980">equals</a>(other: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>?): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</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="%5Bspace.kscience.kmath.stat%2FRandomChain%2Ffork%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F1337332980" anchor-label="fork" id="%5Bspace.kscience.kmath.stat%2FRandomChain%2Ffork%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F1337332980" data-filterable-set=":kmath-stat:dokkaHtml/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-stat:dokkaHtml/commonMain" data-filterable-set=":kmath-stat:dokkaHtml/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="%5Bspace.kscience.kmath.stat%2FRandomChain%2Ffork%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F1337332980"></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-stat:dokkaHtml/commonMain" data-filterable-set=":kmath-stat:dokkaHtml/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-stat:dokkaHtml/commonMain"><div class="symbol monospace">open override fun <a href="fork.html">fork</a>(): <span data-unresolved-link="space.kscience.kmath.chains/Chain///PointingToDeclaration/">Chain</span>&lt;<a href="index.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="%5Bkotlin%2FAny%2FhashCode%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F1337332980" anchor-label="hashCode" id="%5Bkotlin%2FAny%2FhashCode%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F1337332980" data-filterable-set=":kmath-stat:dokkaHtml/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-stat:dokkaHtml/commonMain" data-filterable-set=":kmath-stat:dokkaHtml/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="../-uniform-distribution/index.html#%5Bkotlin%2FAny%2FhashCode%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F1337332980">hashCode</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bkotlin%2FAny%2FhashCode%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F1337332980"></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-stat:dokkaHtml/commonMain" data-filterable-set=":kmath-stat:dokkaHtml/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-stat:dokkaHtml/commonMain"><div class="symbol monospace">open fun <a href="../-uniform-distribution/index.html#%5Bkotlin%2FAny%2FhashCode%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F1337332980">hashCode</a>(): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
<a data-name="%5Bspace.kscience.kmath.stat%2FRandomChain%2Fnext%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F1337332980" anchor-label="next" id="%5Bspace.kscience.kmath.stat%2FRandomChain%2Fnext%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F1337332980" data-filterable-set=":kmath-stat:dokkaHtml/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-stat:dokkaHtml/commonMain" data-filterable-set=":kmath-stat:dokkaHtml/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="%5Bspace.kscience.kmath.stat%2FRandomChain%2Fnext%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F1337332980"></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-stat:dokkaHtml/commonMain" data-filterable-set=":kmath-stat:dokkaHtml/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-stat:dokkaHtml/commonMain"><div class="symbol monospace">open suspend override fun <a href="next.html">next</a>(): <a href="index.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="%5Bkotlin%2FAny%2FtoString%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F1337332980" anchor-label="toString" id="%5Bkotlin%2FAny%2FtoString%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F1337332980" data-filterable-set=":kmath-stat:dokkaHtml/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-stat:dokkaHtml/commonMain" data-filterable-set=":kmath-stat:dokkaHtml/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="../-uniform-distribution/index.html#%5Bkotlin%2FAny%2FtoString%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F1337332980">toString</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bkotlin%2FAny%2FtoString%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F1337332980"></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-stat:dokkaHtml/commonMain" data-filterable-set=":kmath-stat:dokkaHtml/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-stat:dokkaHtml/commonMain"><div class="symbol monospace">open fun <a href="../-uniform-distribution/index.html#%5Bkotlin%2FAny%2FtoString%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F1337332980">toString</a>(): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<h2 class="">Properties</h2>
<div class="table" data-togglable="Properties"><a data-name="%5Bspace.kscience.kmath.stat%2FRandomChain%2Fgenerator%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F1337332980" anchor-label="generator" id="%5Bspace.kscience.kmath.stat%2FRandomChain%2Fgenerator%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F1337332980" data-filterable-set=":kmath-stat:dokkaHtml/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-stat:dokkaHtml/commonMain" data-filterable-set=":kmath-stat:dokkaHtml/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="generator.html">generator</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bspace.kscience.kmath.stat%2FRandomChain%2Fgenerator%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F1337332980"></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-stat:dokkaHtml/commonMain"><a data-name="%5Bspace.kscience.kmath.stat%2FRandomChain%2Fgenerator%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F1337332980" anchor-label="generator" id="%5Bspace.kscience.kmath.stat%2FRandomChain%2Fgenerator%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F1337332980" data-filterable-set=":kmath-stat:dokkaHtml/commonMain"></a><div class="symbol monospace">val <a href="generator.html">generator</a>: <a href="../-random-generator/index.html">RandomGenerator</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>© 2020 Copyright</span><span class="pull-right"><span>Sponsored and developed by dokka</span><a href="https://github.com/Kotlin/dokka"><span class="padded-icon"></span></a></span></div>
</div>
</div>
</body>
</html>