kscience/kmath
9
0
Fork 1
Code Issues Pull Requests 6 Packages Projects Releases 16 Wiki Activity
gh-pages
kmath/kmath-stat/space.kscience.kmath.samplers/index.html

334 lines
40 KiB
HTML
Raw Permalink Blame History

<!doctype html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>space.kscience.kmath.samplers</title>
<link href="../../images/logo-icon.svg" rel="icon" type="image/svg"><script>var pathToRoot = "../../";</script> <script>const storage = localStorage.getItem("dokka-dark-mode")
if (storage == null) {
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
if (osDarkSchemePreferred === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
} else {
const savedDarkMode = JSON.parse(storage)
if(savedDarkMode === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
}
</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 type="text/javascript" src="../../scripts/symbol-parameters-wrapper_deferred.js" defer></script></head>
<body>
<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>0.3.1-dev-RC
</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:dokkaHtmlPartial/commonMain">common</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" data-page-type="package" id="content" pageids="kmath-stat::space.kscience.kmath.samplers////PointingToDeclaration//-443365019">
<div class="breadcrumbs"><a href="../index.html">kmath-stat</a><span class="delimiter">/</span><span class="current">space.kscience.kmath.samplers</span></div>
<div class="cover ">
<h1 class="cover"><span><span>Package-level</span></span> <span><span>declarations</span></span></h1>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="TYPE">Types</button><button class="section-tab" data-togglable="FUNCTION,EXTENSION_FUNCTION">Functions</button></div>
<div class="tabs-section-body">
<div data-togglable="TYPE">
<h2 class="">Types</h2>
<div class="table"><a data-name="-533873934%2FClasslikes%2F-443365019" anchor-label="AhrensDieterExponentialSampler" id="-533873934%2FClasslikes%2F-443365019" data-filterable-set=":kmath-stat:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-stat:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-stat:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-ahrens-dieter-exponential-sampler/index.html"><span>Ahrens</span><wbr><span>Dieter</span><wbr><span>Exponential</span><wbr><span><span>Sampler</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-533873934%2FClasslikes%2F-443365019"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-stat:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">class </span><a href="-ahrens-dieter-exponential-sampler/index.html">AhrensDieterExponentialSampler</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>mean<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a></span></span><span class="token punctuation">)</span> : <a href="../space.kscience.kmath.stat/-sampler/index.html">Sampler</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a><span class="token operator">&gt; </span></div><div class="brief "><p class="paragraph">Sampling from an <a href="http://mathworld.wolfram.com/ExponentialDistribution.html">exponential distribution</a>.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1454518558%2FClasslikes%2F-443365019" anchor-label="AhrensDieterMarsagliaTsangGammaSampler" id="-1454518558%2FClasslikes%2F-443365019" data-filterable-set=":kmath-stat:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-stat:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-stat:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-ahrens-dieter-marsaglia-tsang-gamma-sampler/index.html"><span>Ahrens</span><wbr><span>Dieter</span><wbr><span>Marsaglia</span><wbr><span>Tsang</span><wbr><span>Gamma</span><wbr><span><span>Sampler</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1454518558%2FClasslikes%2F-443365019"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-stat:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">class </span><a href="-ahrens-dieter-marsaglia-tsang-gamma-sampler/index.html">AhrensDieterMarsagliaTsangGammaSampler</a> : <a href="../space.kscience.kmath.stat/-sampler/index.html">Sampler</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a><span class="token operator">&gt; </span></div><div class="brief "><p class="paragraph">Sampling from the <a href="http://mathworld.wolfram.com/GammaDistribution.html">gamma distribution</a>.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="2039416215%2FClasslikes%2F-443365019" anchor-label="AliasMethodDiscreteSampler" id="2039416215%2FClasslikes%2F-443365019" data-filterable-set=":kmath-stat:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-stat:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-stat:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-alias-method-discrete-sampler/index.html"><span>Alias</span><wbr><span>Method</span><wbr><span>Discrete</span><wbr><span><span>Sampler</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2039416215%2FClasslikes%2F-443365019"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-stat:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">class </span><a href="-alias-method-discrete-sampler/index.html">AliasMethodDiscreteSampler</a> : <a href="../space.kscience.kmath.stat/-sampler/index.html">Sampler</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token operator">&gt; </span></div><div class="brief "><p class="paragraph">Distribution sampler that uses the Alias method. It can be used to sample from n values each with an associated probability. This implementation is based on the detailed explanation of the alias method by Keith Schartz and implements Vose's algorithm.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="2070476635%2FClasslikes%2F-443365019" anchor-label="BasicSampler" id="2070476635%2FClasslikes%2F-443365019" data-filterable-set=":kmath-stat:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-stat:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-stat:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-basic-sampler/index.html"><span>Basic</span><wbr><span><span>Sampler</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2070476635%2FClasslikes%2F-443365019"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-stat:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">class </span><a href="-basic-sampler/index.html">BasicSampler</a><span class="token operator">&lt;</span><span class="token keyword">out </span><a href="-basic-sampler/index.html">T</a><span class="token operator"> : </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">&gt;</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>chainBuilder<span class="token operator">: </span><span class="token punctuation">(</span><span class="token keyword"></span><a href="../space.kscience.kmath.random/-random-generator/index.html">RandomGenerator</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="../../kmath-coroutines/space.kscience.kmath.chains/-chain/index.html">Chain</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-basic-sampler/index.html">T</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span> : <a href="../space.kscience.kmath.stat/-sampler/index.html">Sampler</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-basic-sampler/index.html">T</a><span class="token operator">&gt; </span></div><div class="brief "><p class="paragraph">Implements <a href="../space.kscience.kmath.stat/-sampler/index.html">Sampler</a> by delegating sampling to value of <a href="-basic-sampler/chain-builder.html">chainBuilder</a>.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="2053876811%2FClasslikes%2F-443365019" anchor-label="BlockingDoubleSampler" id="2053876811%2FClasslikes%2F-443365019" data-filterable-set=":kmath-stat:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-stat:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-stat:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-blocking-double-sampler/index.html"><span>Blocking</span><wbr><span>Double</span><wbr><span><span>Sampler</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2053876811%2FClasslikes%2F-443365019"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-stat:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">interface </span><a href="-blocking-double-sampler/index.html">BlockingDoubleSampler</a> : <a href="../space.kscience.kmath.stat/-sampler/index.html">Sampler</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a><span class="token operator">&gt; </span></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="675750573%2FClasslikes%2F-443365019" anchor-label="BoxMullerSampler" id="675750573%2FClasslikes%2F-443365019" data-filterable-set=":kmath-stat:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-stat:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-stat:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-box-muller-sampler/index.html"><span>Box</span><wbr><span>Muller</span><wbr><span><span>Sampler</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="675750573%2FClasslikes%2F-443365019"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-stat:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">object </span><a href="-box-muller-sampler/index.html">BoxMullerSampler</a> : <a href="-normalized-gaussian-sampler/index.html">NormalizedGaussianSampler</a></div><div class="brief "><p class="paragraph"><a href="https://en.wikipedia.org/wiki/Box%E2%80%93Muller_transform">Box-Muller algorithm</a> for sampling from a Gaussian distribution.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1457235081%2FClasslikes%2F-443365019" anchor-label="ConstantSampler" id="1457235081%2FClasslikes%2F-443365019" data-filterable-set=":kmath-stat:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-stat:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-stat:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-constant-sampler/index.html"><span>Constant</span><wbr><span><span>Sampler</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1457235081%2FClasslikes%2F-443365019"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-stat:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">class </span><a href="-constant-sampler/index.html">ConstantSampler</a><span class="token operator">&lt;</span><span class="token keyword">out </span><a href="-constant-sampler/index.html">T</a><span class="token operator"> : </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">&gt;</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>value<span class="token operator">: </span><a href="-constant-sampler/index.html">T</a></span></span><span class="token punctuation">)</span> : <a href="../space.kscience.kmath.stat/-sampler/index.html">Sampler</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-constant-sampler/index.html">T</a><span class="token operator">&gt; </span></div><div class="brief "><p class="paragraph">Implements <a href="../space.kscience.kmath.stat/-sampler/index.html">Sampler</a> by sampling only certain <a href="-constant-sampler/value.html">value</a>.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="325292768%2FClasslikes%2F-443365019" anchor-label="GaussianSampler" id="325292768%2FClasslikes%2F-443365019" data-filterable-set=":kmath-stat:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-stat:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-stat:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-gaussian-sampler/index.html"><span>Gaussian</span><wbr><span><span>Sampler</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="325292768%2FClasslikes%2F-443365019"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-stat:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">class </span><a href="-gaussian-sampler/index.html">GaussianSampler</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>mean<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>standardDeviation<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a><span class="token punctuation">, </span></span><span class="parameter ">normalized<span class="token operator">: </span><a href="-normalized-gaussian-sampler/index.html">NormalizedGaussianSampler</a><span class="token operator"> = </span>BoxMullerSampler</span></span><span class="token punctuation">)</span> : <a href="-blocking-double-sampler/index.html">BlockingDoubleSampler</a></div><div class="brief "><p class="paragraph">Sampling from a Gaussian distribution with given mean and standard deviation.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1139170303%2FClasslikes%2F-443365019" anchor-label="KempSmallMeanPoissonSampler" id="1139170303%2FClasslikes%2F-443365019" data-filterable-set=":kmath-stat:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-stat:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-stat:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-kemp-small-mean-poisson-sampler/index.html"><span>Kemp</span><wbr><span>Small</span><wbr><span>Mean</span><wbr><span>Poisson</span><wbr><span><span>Sampler</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1139170303%2FClasslikes%2F-443365019"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-stat:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">class </span><a href="-kemp-small-mean-poisson-sampler/index.html">KempSmallMeanPoissonSampler</a> : <a href="../space.kscience.kmath.stat/-sampler/index.html">Sampler</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token operator">&gt; </span></div><div class="brief "><p class="paragraph">Sampler for the Poisson distribution.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1830557522%2FClasslikes%2F-443365019" anchor-label="LargeMeanPoissonSampler" id="-1830557522%2FClasslikes%2F-443365019" data-filterable-set=":kmath-stat:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-stat:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-stat:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-large-mean-poisson-sampler/index.html"><span>Large</span><wbr><span>Mean</span><wbr><span>Poisson</span><wbr><span><span>Sampler</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1830557522%2FClasslikes%2F-443365019"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-stat:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">class </span><a href="-large-mean-poisson-sampler/index.html">LargeMeanPoissonSampler</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>mean<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a></span></span><span class="token punctuation">)</span> : <a href="../space.kscience.kmath.stat/-sampler/index.html">Sampler</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token operator">&gt; </span></div><div class="brief "><p class="paragraph">Sampler for the Poisson distribution.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1017372936%2FClasslikes%2F-443365019" anchor-label="MarsagliaNormalizedGaussianSampler" id="1017372936%2FClasslikes%2F-443365019" data-filterable-set=":kmath-stat:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-stat:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-stat:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-marsaglia-normalized-gaussian-sampler/index.html"><span>Marsaglia</span><wbr><span>Normalized</span><wbr><span>Gaussian</span><wbr><span><span>Sampler</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1017372936%2FClasslikes%2F-443365019"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-stat:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">object </span><a href="-marsaglia-normalized-gaussian-sampler/index.html">MarsagliaNormalizedGaussianSampler</a> : <a href="-normalized-gaussian-sampler/index.html">NormalizedGaussianSampler</a></div><div class="brief "><p class="paragraph"><a href="https://en.wikipedia.org/wiki/Marsaglia_polar_method">Marsaglia polar method</a> for sampling from a Gaussian distribution with mean 0 and standard deviation 1. This is a variation of the algorithm implemented in BoxMullerNormalizedGaussianSampler.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1057807369%2FClasslikes%2F-443365019" anchor-label="NormalizedGaussianSampler" id="-1057807369%2FClasslikes%2F-443365019" data-filterable-set=":kmath-stat:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-stat:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-stat:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-normalized-gaussian-sampler/index.html"><span>Normalized</span><wbr><span>Gaussian</span><wbr><span><span>Sampler</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1057807369%2FClasslikes%2F-443365019"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-stat:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">fun </span><span class="token keyword">interface </span><a href="-normalized-gaussian-sampler/index.html">NormalizedGaussianSampler</a> : <a href="-blocking-double-sampler/index.html">BlockingDoubleSampler</a></div><div class="brief "><p class="paragraph">Marker interface for a sampler that generates values from an N(0,1) <a href="https://en.wikipedia.org/wiki/Normal_distribution">Gaussian distribution</a>.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="2056728055%2FClasslikes%2F-443365019" anchor-label="SamplerSpace" id="2056728055%2FClasslikes%2F-443365019" data-filterable-set=":kmath-stat:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-stat:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-stat:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-sampler-space/index.html"><span>Sampler</span><wbr><span><span>Space</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2056728055%2FClasslikes%2F-443365019"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-stat:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">class </span><a href="-sampler-space/index.html">SamplerSpace</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-sampler-space/index.html">T</a><span class="token operator"> : </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token punctuation">, </span><span class="token keyword">out </span><a href="-sampler-space/index.html">S</a><span class="token operator"> : </span><a href="../../kmath-core/space.kscience.kmath.operations/-group/index.html">Group</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-sampler-space/index.html">T</a><span class="token operator">&gt;</span>, <a href="../../kmath-core/space.kscience.kmath.operations/-scale-operations/index.html">ScaleOperations</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-sampler-space/index.html">T</a><span class="token operator">&gt;</span><span class="token operator">&gt;</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>algebra<span class="token operator">: </span><a href="-sampler-space/index.html">S</a></span></span><span class="token punctuation">)</span> : <a href="../../kmath-core/space.kscience.kmath.operations/-group/index.html">Group</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../space.kscience.kmath.stat/-sampler/index.html">Sampler</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-sampler-space/index.html">T</a><span class="token operator">&gt;</span><span class="token operator">&gt; </span>, <a href="../../kmath-core/space.kscience.kmath.operations/-scale-operations/index.html">ScaleOperations</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../space.kscience.kmath.stat/-sampler/index.html">Sampler</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-sampler-space/index.html">T</a><span class="token operator">&gt;</span><span class="token operator">&gt; </span></div><div class="brief "><p class="paragraph">A space of samplers. Allows performing simple operations on distributions.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1311611038%2FClasslikes%2F-443365019" anchor-label="SmallMeanPoissonSampler" id="-1311611038%2FClasslikes%2F-443365019" data-filterable-set=":kmath-stat:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-stat:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-stat:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-small-mean-poisson-sampler/index.html"><span>Small</span><wbr><span>Mean</span><wbr><span>Poisson</span><wbr><span><span>Sampler</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1311611038%2FClasslikes%2F-443365019"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-stat:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">class </span><a href="-small-mean-poisson-sampler/index.html">SmallMeanPoissonSampler</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>mean<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a></span></span><span class="token punctuation">)</span> : <a href="../space.kscience.kmath.stat/-sampler/index.html">Sampler</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token operator">&gt; </span></div><div class="brief "><p class="paragraph">Sampler for the Poisson distribution.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="819348150%2FClasslikes%2F-443365019" anchor-label="ZigguratNormalizedGaussianSampler" id="819348150%2FClasslikes%2F-443365019" data-filterable-set=":kmath-stat:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-stat:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-stat:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-ziggurat-normalized-gaussian-sampler/index.html"><span>Ziggurat</span><wbr><span>Normalized</span><wbr><span>Gaussian</span><wbr><span><span>Sampler</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="819348150%2FClasslikes%2F-443365019"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-stat:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">object </span><a href="-ziggurat-normalized-gaussian-sampler/index.html">ZigguratNormalizedGaussianSampler</a> : <a href="-normalized-gaussian-sampler/index.html">NormalizedGaussianSampler</a></div><div class="brief "><p class="paragraph"><a href="https://en.wikipedia.org/wiki/Ziggurat_algorithm">Marsaglia and Tsang "Ziggurat"</a> method for sampling from a Gaussian distribution with mean 0 and standard deviation 1. The algorithm is explained in this paper and this implementation has been adapted from the C code provided therein.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div data-togglable="FUNCTION">
<h2 class="">Functions</h2>
<div class="table"><a data-name="-740026430%2FFunctions%2F-443365019" anchor-label="KempSmallMeanPoissonSampler" id="-740026430%2FFunctions%2F-443365019" data-filterable-set=":kmath-stat:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-stat:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-stat:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-kemp-small-mean-poisson-sampler.html"><span>Kemp</span><wbr><span>Small</span><wbr><span>Mean</span><wbr><span>Poisson</span><wbr><span><span>Sampler</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-740026430%2FFunctions%2F-443365019"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-stat:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="-kemp-small-mean-poisson-sampler.html"><span class="token function">KempSmallMeanPoissonSampler</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">mean<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-kemp-small-mean-poisson-sampler/index.html">KempSmallMeanPoissonSampler</a></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1853178489%2FFunctions%2F-443365019" anchor-label="PoissonSampler" id="1853178489%2FFunctions%2F-443365019" data-filterable-set=":kmath-stat:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-stat:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-stat:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-poisson-sampler.html"><span>Poisson</span><wbr><span><span>Sampler</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1853178489%2FFunctions%2F-443365019"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-stat:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="-poisson-sampler.html"><span class="token function">PoissonSampler</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">mean<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../space.kscience.kmath.stat/-sampler/index.html">Sampler</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token operator">&gt;</span></div><div class="brief "><p class="paragraph">Sampler for the Poisson distribution.</p></div></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>© 2023 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>
View Git Blame Copy Permalink