47 lines
6.3 KiB
HTML
47 lines
6.3 KiB
HTML
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>mean</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-tensors::space.kscience.kmath.tensors.api/AnalyticTensorAlgebra/mean/space.kscience.kmath.nd.MutableStructureND[TypeParam(bounds=[kotlin.Any?])]#/PointingToDeclaration//-1345790395">
|
|
<div class="navigation-wrapper" id="navigation-wrapper">
|
|
<div class="breadcrumbs"><a href="../../index.html">kmath-tensors</a>/<a href="../index.html">space.kscience.kmath.tensors.api</a>/<a href="index.html">AnalyticTensorAlgebra</a>/<a href="mean.html">mean</a></div>
|
|
<div class="pull-right d-flex">
|
|
<div id="searchBar"></div>
|
|
</div>
|
|
</div>
|
|
<div class="cover ">
|
|
<h1 class="cover"><span>mean</span></h1>
|
|
</div>
|
|
<div class="divergent-group" data-filterable-current=":kmath-tensors:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-tensors: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-tensors:dokkaHtmlPartial/commonMain"><div class="symbol monospace">abstract fun <a href="../index.html#-1680022905%2FClasslikes%2F-1345790395">Tensor</a><<a href="index.html">T</a>>.<a href="mean.html">mean</a>(): <a href="index.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>
|
|
<h4 class="">Return</h4><p class="paragraph">the mean of all elements in the input tensor.</p></div>
|
|
<div class="divergent-group" data-filterable-current=":kmath-tensors:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-tensors: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-tensors:dokkaHtmlPartial/commonMain"><div class="symbol monospace">abstract fun <a href="../index.html#-1680022905%2FClasslikes%2F-1345790395">Tensor</a><<a href="index.html">T</a>>.<a href="mean.html">mean</a>(dim: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>, keepDim: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>): <a href="../index.html#-1680022905%2FClasslikes%2F-1345790395">Tensor</a><<a href="index.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 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><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><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-tensors:dokkaHtmlPartial/commonMain"><div data-togglable="Parameters"><div class="table" data-togglable="Parameters"><div class="table-row" data-filterable-current=":kmath-tensors:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-tensors:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">dim</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">the dimension to reduce.</p></div></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 WithExtraAttributes"><div class=""><span class="inline-flex">keepDim</span></div><div><div class="title"><div data-togglable="Parameters"><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></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>
|
|
|
|
|