forked from kscience/kmath
67 lines
7.7 KiB
HTML
67 lines
7.7 KiB
HTML
<!doctype html>
|
|
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>mean</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-tensors: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-tensors::space.kscience.kmath.tensors.api/AnalyticTensorAlgebra/mean/#space.kscience.kmath.nd.StructureND[TypeParam(bounds=[kotlin.Any?])]/PointingToDeclaration//-1345790395">
|
|
<div class="breadcrumbs"><a href="../../index.html">kmath-tensors</a><span class="delimiter">/</span><a href="../index.html">space.kscience.kmath.tensors.api</a><span class="delimiter">/</span><a href="index.html">AnalyticTensorAlgebra</a><span class="delimiter">/</span><span class="current">mean</span></div>
|
|
<div class="cover ">
|
|
<h1 class="cover"><span><span>mean</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-tensors:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="mean.html"><span class="token function">mean</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">structureND<span class="token operator">: </span><a href="../../../kmath-core/space.kscience.kmath.nd/-structure-n-d/index.html">StructureND</a><span class="token operator"><</span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator">></span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">T</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/SciProgCentre/kmath/tree/master/kmath-tensors/src/commonMain/kotlin/space/kscience/kmath/tensors/api/AnalyticTensorAlgebra.kt#L24">source</a>)</span></span></div><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">the mean of all elements in the input tensor.</p></span><hr><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="mean.html"><span class="token function">mean</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">structureND<span class="token operator">: </span><a href="../../../kmath-core/space.kscience.kmath.nd/-structure-n-d/index.html">StructureND</a><span class="token operator"><</span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator">></span><span class="token punctuation">, </span></span><span class="parameter ">dim<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token punctuation">, </span></span><span class="parameter ">keepDim<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../index.html#-1680022905%2FClasslikes%2F-1345790395">Tensor</a><span class="token operator"><</span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator">></span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/SciProgCentre/kmath/tree/master/kmath-tensors/src/commonMain/kotlin/space/kscience/kmath/tensors/api/AnalyticTensorAlgebra.kt#L37">source</a>)</span></span></div><p class="paragraph">Returns the mean of each row of the input tensor in the given dimension <a href="mean.html">dim</a>.</p><p class="paragraph">If <a href="mean.html">keepDim</a> is true, the output tensor is of the same size as input except in the dimension <a href="mean.html">dim</a> where it is of size 1. Otherwise, <a href="mean.html">dim</a> is squeezed, resulting in the output tensor having 1 fewer dimension.</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">the mean of each row of the input tensor in the given dimension <a href="mean.html">dim</a>.</p></span><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":kmath-tensors:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-tensors:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>dim</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the dimension to reduce.</p></div></div></div></div><div class="table-row" data-filterable-current=":kmath-tensors:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-tensors:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>keep</span><wbr><span><span>Dim</span></span></u></div></span></div><div><div class="title"><p class="paragraph">whether the output tensor has <a href="mean.html">dim</a> retained or not.</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>
|
|
|