kmath/kmath-core/space.kscience.kmath.operations/average.html

48 lines
7.9 KiB
HTML
Raw Normal View History

<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>average</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-core::space.kscience.kmath.operations//average/TypeParam(bounds=[space.kscience.kmath.operations.Ring[TypeParam(bounds=[kotlin.Any?])], space.kscience.kmath.operations.ScaleOperations[TypeParam(bounds=[kotlin.Any?])]])#kotlin.collections.Iterable[TypeParam(bounds=[kotlin.Any?])]/PointingToDeclaration//244675578">
<div class="navigation-wrapper" id="navigation-wrapper">
<div class="breadcrumbs"><a href="../index.html">kmath-core</a>/<a href="index.html">space.kscience.kmath.operations</a>/<a href="average.html">average</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-core:dokkaHtmlPartial/commonMain">common</button></div>
<div id="searchBar"></div>
</div>
</div>
<div class="cover ">
<h1 class="cover"><span>average</span></h1>
</div>
<div class="divergent-group" data-filterable-current=":kmath-core:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-core: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-core:dokkaHtmlPartial/commonMain"><div class="symbol monospace">fun &lt;<a href="average.html">T</a>, <a href="average.html">S</a> : <a href="-ring/index.html">Ring</a>&lt;<a href="average.html">T</a>&gt;, <a href="-scale-operations/index.html">ScaleOperations</a>&lt;<a href="average.html">T</a>&gt;&gt; <a href="average.html">S</a>.<a href="average.html">average</a>(data: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-iterable/index.html">Iterable</a>&lt;<a href="average.html">T</a>&gt;): <a href="average.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>
<p class="paragraph">Returns an average value of elements in the iterable in this <a href="-ring/index.html">Ring</a>.</p><h4 class="">Return</h4><p class="paragraph">the average value.</p><h4 class="">Author</h4><p class="paragraph">Iaroslav Postovalov</p><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-core:dokkaHtmlPartial/commonMain"><div data-togglable="Parameters"><div class="table" data-togglable="Parameters"><div class="table-row" data-filterable-current=":kmath-core:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">&lt;receiver&gt;</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">the algebra that provides addition and division.</p></div></div></div></div></div><div class="table-row" data-filterable-current=":kmath-core:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">data</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">the iterable to find average.</p></div></div></div></div></div></div></div></div></div></div></div>
<div class="divergent-group" data-filterable-current=":kmath-core:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-core: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-core:dokkaHtmlPartial/commonMain"><div class="symbol monospace">fun &lt;<a href="average.html">T</a>, <a href="average.html">S</a> : <a href="-ring/index.html">Ring</a>&lt;<a href="average.html">T</a>&gt;, <a href="-scale-operations/index.html">ScaleOperations</a>&lt;<a href="average.html">T</a>&gt;&gt; <a href="average.html">S</a>.<a href="average.html">average</a>(data: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.sequences/-sequence/index.html">Sequence</a>&lt;<a href="average.html">T</a>&gt;): <a href="average.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>
<p class="paragraph">Returns an average value of elements in the sequence in this <a href="-ring/index.html">Ring</a>.</p><h4 class="">Return</h4><p class="paragraph">the average value.</p><h4 class="">Author</h4><p class="paragraph">Iaroslav Postovalov</p><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-core:dokkaHtmlPartial/commonMain"><div data-togglable="Parameters"><div class="table" data-togglable="Parameters"><div class="table-row" data-filterable-current=":kmath-core:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">&lt;receiver&gt;</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">the algebra that provides addition and division.</p></div></div></div></div></div><div class="table-row" data-filterable-current=":kmath-core:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">data</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">the sequence to find average.</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"></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>