67 lines
12 KiB
HTML
67 lines
12 KiB
HTML
<!doctype html>
|
|
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>average</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-core: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-core::space.kscience.kmath.operations//average/space.kscience.kmath.operations.DoubleBufferOps#space.kscience.kmath.structures.Buffer[kotlin.Double]/PointingToDeclaration//244675578">
|
|
<div class="breadcrumbs"><a href="../index.html">kmath-core</a><span class="delimiter">/</span><a href="index.html">space.kscience.kmath.operations</a><span class="delimiter">/</span><span class="current">average</span></div>
|
|
<div class="cover ">
|
|
<h1 class="cover"><span><span>average</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-core:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="-double-buffer-ops/index.html">DoubleBufferOps</a><span class="token punctuation">.</span><a href="average.html"><span class="token function">average</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">buffer<span class="token operator">: </span><a href="../space.kscience.kmath.structures/-buffer/index.html">Buffer</a><span class="token operator"><</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">></span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/SciProgCentre/kmath/tree/master/kmath-core/src/commonMain/kotlin/space/kscience/kmath/operations/DoubleBufferOps.kt#L176">source</a>)</span></span></div><br><hr><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="../../kmath-memory/space.kscience.kmath/-performance-pitfall/index.html"><span class="token annotation builtin">PerformancePitfall</span></a><span class="token punctuation">(</span><span>message<span class="token operator"> = </span><span class="breakable-word"><span class="token string">"Potential boxing access to buffer elements"</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"><</span><span class="token keyword"></span><a href="average.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="average.html">S</a><span class="token operator"> : </span><a href="-group/index.html">Group</a><span class="token operator"><</span><span class="token keyword"></span><a href="average.html">T</a><span class="token operator">></span>, <a href="-scale-operations/index.html">ScaleOperations</a><span class="token operator"><</span><span class="token keyword"></span><a href="average.html">T</a><span class="token operator">></span><span class="token operator">> </span><a href="average.html">S</a><span class="token punctuation">.</span><a href="average.html"><span class="token function">average</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">data<span class="token operator">: </span><a href="../space.kscience.kmath.structures/-buffer/index.html">Buffer</a><span class="token operator"><</span><span class="token keyword"></span><a href="average.html">T</a><span class="token operator">></span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="average.html">T</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/SciProgCentre/kmath/tree/master/kmath-core/src/commonMain/kotlin/space/kscience/kmath/operations/algebraExtensions.kt#L56">source</a>)</span></span></div><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><span class="token operator"><</span><span class="token keyword"></span><a href="average.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="average.html">S</a><span class="token operator"> : </span><a href="-group/index.html">Group</a><span class="token operator"><</span><span class="token keyword"></span><a href="average.html">T</a><span class="token operator">></span>, <a href="-scale-operations/index.html">ScaleOperations</a><span class="token operator"><</span><span class="token keyword"></span><a href="average.html">T</a><span class="token operator">></span><span class="token operator">> </span><a href="average.html">S</a><span class="token punctuation">.</span><a href="average.html"><span class="token function">average</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">data<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-iterable/index.html">Iterable</a><span class="token operator"><</span><span class="token keyword"></span><a href="average.html">T</a><span class="token operator">></span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="average.html">T</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/SciProgCentre/kmath/tree/master/kmath-core/src/commonMain/kotlin/space/kscience/kmath/operations/algebraExtensions.kt#L67">source</a>)</span></span></div><p class="paragraph">Returns an average value of elements in the iterable in this <a href="-group/index.html">Group</a>.</p><span class="kdoc-tag"><h4 class="">Receiver</h4><p class="paragraph">the algebra that provides addition and division.</p></span><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">the average value.</p></span><span class="kdoc-tag"><h4 class="">Author</h4><p class="paragraph">Iaroslav Postovalov</p></span><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":kmath-core:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>data</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the iterable to find average.</p></div></div></div></div></div><hr><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><span class="token operator"><</span><span class="token keyword"></span><a href="average.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="average.html">S</a><span class="token operator"> : </span><a href="-group/index.html">Group</a><span class="token operator"><</span><span class="token keyword"></span><a href="average.html">T</a><span class="token operator">></span>, <a href="-scale-operations/index.html">ScaleOperations</a><span class="token operator"><</span><span class="token keyword"></span><a href="average.html">T</a><span class="token operator">></span><span class="token operator">> </span><a href="average.html">S</a><span class="token punctuation">.</span><a href="average.html"><span class="token function">average</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">data<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.sequences/-sequence/index.html">Sequence</a><span class="token operator"><</span><span class="token keyword"></span><a href="average.html">T</a><span class="token operator">></span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="average.html">T</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/SciProgCentre/kmath/tree/master/kmath-core/src/commonMain/kotlin/space/kscience/kmath/operations/algebraExtensions.kt#L78">source</a>)</span></span></div><p class="paragraph">Returns an average value of elements in the sequence in this <a href="-group/index.html">Group</a>.</p><span class="kdoc-tag"><h4 class="">Receiver</h4><p class="paragraph">the algebra that provides addition and division.</p></span><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">the average value.</p></span><span class="kdoc-tag"><h4 class="">Author</h4><p class="paragraph">Iaroslav Postovalov</p></span><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":kmath-core:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>data</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the sequence to find average.</p></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>
|
|
|