kmath/kmath-stat/space.kscience.kmath.stat/chi-squared-expression.html

67 lines
14 KiB
HTML

<!doctype html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>chiSquaredExpression</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="member" id="content" pageids="kmath-stat::space.kscience.kmath.stat//chiSquaredExpression/space.kscience.kmath.expressions.AutoDiffProcessor[TypeParam(bounds=[kotlin.Comparable[^]]),TypeParam(bounds=[kotlin.Any]),TypeParam(bounds=[space.kscience.kmath.operations.ExtendedField[TypeParam(bounds=[kotlin.Any])], space.kscience.kmath.expressions.ExpressionAlgebra[TypeParam(bounds=[kotlin.Comparable[^^]]),TypeParam(bounds=[kotlin.Any])]])]#space.kscience.kmath.structures.Buffer[TypeParam(bounds=[kotlin.Comparable[^]])]#space.kscience.kmath.structures.Buffer[TypeParam(bounds=[kotlin.Comparable[^]])]#space.kscience.kmath.structures.Buffer[TypeParam(bounds=[kotlin.Comparable[^]])]#kotlin.Function2[TypeParam(bounds=[space.kscience.kmath.operations.ExtendedField[TypeParam(bounds=[kotlin.Any])], space.kscience.kmath.expressions.ExpressionAlgebra[TypeParam(bounds=[kotlin.Comparable[^^]]),TypeParam(bounds=[kotlin.Any])]]),TypeParam(bounds=[kotlin.Any]),TypeParam(bounds=[kotlin.Any])]/PointingToDeclaration//-443365019">
<div class="breadcrumbs"><a href="../index.html">kmath-stat</a><span class="delimiter">/</span><a href="index.html">space.kscience.kmath.stat</a><span class="delimiter">/</span><span class="current">chiSquaredExpression</span></div>
<div class="cover ">
<h1 class="cover"><span>chi</span><wbr><span>Squared</span><wbr><span><span>Expression</span></span></h1>
</div>
<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"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-name/index.html"><span class="token annotation builtin">JvmName</span></a><span class="token punctuation">(</span><span>name<span class="token operator"> = </span><span class="breakable-word"><span class="token string">"genericChiSquaredExpression"</span></span></span><wbr><span class="token punctuation">)</span></div></div><span class="token keyword"></span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="chi-squared-expression.html">T</a><span class="token operator"> : </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-comparable/index.html">Comparable</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="chi-squared-expression.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">, </span><span class="token keyword"></span><a href="chi-squared-expression.html">I</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"></span><a href="chi-squared-expression.html">A</a><span class="token operator"> : </span><a href="../../kmath-core/space.kscience.kmath.operations/-extended-field/index.html">ExtendedField</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="chi-squared-expression.html">I</a><span class="token operator">&gt;</span>, <a href="../../kmath-core/space.kscience.kmath.expressions/-expression-algebra/index.html">ExpressionAlgebra</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="chi-squared-expression.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="chi-squared-expression.html">I</a><span class="token operator">&gt;</span><span class="token operator">&gt; </span><a href="../../kmath-core/space.kscience.kmath.expressions/-auto-diff-processor/index.html">AutoDiffProcessor</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="chi-squared-expression.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="chi-squared-expression.html">I</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="chi-squared-expression.html">A</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="chi-squared-expression.html"><span class="token function">chiSquaredExpression</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">x<span class="token operator">: </span><a href="../../kmath-core/space.kscience.kmath.structures/-buffer/index.html">Buffer</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="chi-squared-expression.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">, </span></span><span class="parameter ">y<span class="token operator">: </span><a href="../../kmath-core/space.kscience.kmath.structures/-buffer/index.html">Buffer</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="chi-squared-expression.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">, </span></span><span class="parameter ">yErr<span class="token operator">: </span><a href="../../kmath-core/space.kscience.kmath.structures/-buffer/index.html">Buffer</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="chi-squared-expression.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">, </span></span><span class="parameter ">model<span class="token operator">: </span><span class="token keyword"></span><a href="chi-squared-expression.html">A</a><span class="token punctuation">.</span><span class="token punctuation">(</span><span class="token keyword"></span><a href="chi-squared-expression.html">I</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="chi-squared-expression.html">I</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../kmath-core/space.kscience.kmath.expressions/-differentiable-expression/index.html">DifferentiableExpression</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="chi-squared-expression.html">T</a><span class="token operator">&gt;</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/SciProgCentre/kmath/tree/master/kmath-stat/src/commonMain/kotlin/space/kscience/kmath/stat/chiSquaredExpression.kt#L26">source</a>)</span></span></div><p class="paragraph">Generate a chi squared expression from given x-y-sigma data and inline model. Provides automatic differentiation.</p><p class="paragraph"><strong>WARNING</strong> All elements of <a href="chi-squared-expression.html">yErr</a> must be positive.</p><hr><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="chi-squared-expression.html">I</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"></span><a href="chi-squared-expression.html">A</a><span class="token operator"> : </span><a href="../../kmath-core/space.kscience.kmath.operations/-extended-field/index.html">ExtendedField</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="chi-squared-expression.html">I</a><span class="token operator">&gt;</span>, <a href="../../kmath-core/space.kscience.kmath.expressions/-expression-algebra/index.html">ExpressionAlgebra</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 punctuation">, </span><span class="token keyword"></span><a href="chi-squared-expression.html">I</a><span class="token operator">&gt;</span><span class="token operator">&gt; </span><a href="../../kmath-core/space.kscience.kmath.expressions/-auto-diff-processor/index.html">AutoDiffProcessor</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 punctuation">, </span><span class="token keyword"></span><a href="chi-squared-expression.html">I</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="chi-squared-expression.html">A</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="chi-squared-expression.html"><span class="token function">chiSquaredExpression</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">x<span class="token operator">: </span><a href="../../kmath-core/space.kscience.kmath.structures/-buffer/index.html">Buffer</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><span class="token punctuation">, </span></span><span class="parameter ">y<span class="token operator">: </span><a href="../../kmath-core/space.kscience.kmath.structures/-buffer/index.html">Buffer</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><span class="token punctuation">, </span></span><span class="parameter ">yErr<span class="token operator">: </span><a href="../../kmath-core/space.kscience.kmath.structures/-buffer/index.html">Buffer</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><span class="token punctuation">, </span></span><span class="parameter ">model<span class="token operator">: </span><span class="token keyword"></span><a href="chi-squared-expression.html">A</a><span class="token punctuation">.</span><span class="token punctuation">(</span><span class="token keyword"></span><a href="chi-squared-expression.html">I</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="chi-squared-expression.html">I</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../kmath-core/space.kscience.kmath.expressions/-differentiable-expression/index.html">DifferentiableExpression</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><span class="clearfix"><span class="floating-right">(<a href="https://github.com/SciProgCentre/kmath/tree/master/kmath-stat/src/commonMain/kotlin/space/kscience/kmath/stat/chiSquaredExpression.kt#L50">source</a>)</span></span></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>