blob: 26de5eec42f8222244aa0626066eb743794d87b8 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_292) on Tue Jun 15 06:01:48 GMT 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>MeanStatistic (Apache Hadoop Common 3.3.1 API)</title>
<meta name="date" content="2021-06-15">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="MeanStatistic (Apache Hadoop Common 3.3.1 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/MeanStatistic.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/hadoop/fs/statistics/IOStatisticsSupport.html" title="class in org.apache.hadoop.fs.statistics"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/hadoop/fs/statistics/StoreStatisticNames.html" title="class in org.apache.hadoop.fs.statistics"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/hadoop/fs/statistics/MeanStatistic.html" target="_top">Frames</a></li>
<li><a href="MeanStatistic.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.hadoop.fs.statistics</div>
<h2 title="Class MeanStatistic" class="title">Class MeanStatistic</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.hadoop.fs.statistics.MeanStatistic</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a></dd>
</dl>
<hr>
<br>
<pre>@InterfaceAudience.Public
@InterfaceStability.Evolving
public final class <span class="typeNameLabel">MeanStatistic</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a></pre>
<div class="block">A mean statistic represented as the sum and the sample count;
the mean is calculated on demand.
<p>
It can be used to accrue values so as to dynamically update
the mean. If so, know that there is no synchronization
on the methods.
</p>
<p>
If a statistic has 0 samples then it is considered to be empty.
</p>
<p>
All 'empty' statistics are equivalent, independent of the sum value.
</p>
<p>
For non-empty statistics, sum and sample values must match
for equality.
</p>
<p>
It is serializable and annotated for correct serializations with jackson2.
</p>
<p>
Thread safety. The operations to add/copy sample data, are thread safe.
</p>
<ol>
<li><a href="../../../../../org/apache/hadoop/fs/statistics/MeanStatistic.html#add-org.apache.hadoop.fs.statistics.MeanStatistic-"><code>add(MeanStatistic)</code></a></li>
<li><a href="../../../../../org/apache/hadoop/fs/statistics/MeanStatistic.html#addSample-long-"><code>addSample(long)</code></a> </li>
<li><a href="../../../../../org/apache/hadoop/fs/statistics/MeanStatistic.html#clear--"><code>clear()</code></a> </li>
<li><a href="../../../../../org/apache/hadoop/fs/statistics/MeanStatistic.html#setSamplesAndSum-long-long-"><code>setSamplesAndSum(long, long)</code></a></li>
<li><a href="../../../../../org/apache/hadoop/fs/statistics/MeanStatistic.html#set-org.apache.hadoop.fs.statistics.MeanStatistic-"><code>set(MeanStatistic)</code></a></li>
<li><a href="../../../../../org/apache/hadoop/fs/statistics/MeanStatistic.html#setSamples-long-"><code>setSamples(long)</code></a> and <a href="../../../../../org/apache/hadoop/fs/statistics/MeanStatistic.html#setSum-long-"><code>setSum(long)</code></a></li>
</ol>
<p>
So is the <a href="../../../../../org/apache/hadoop/fs/statistics/MeanStatistic.html#mean--"><code>mean()</code></a> method. This ensures that when
used to aggregated statistics, the aggregate value and sample
count are set and evaluated consistently.
</p>
<p>
Other methods marked as synchronized because Findbugs overreacts
to the idea that some operations to update sum and sample count
are synchronized, but that things like equals are not.
</p></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../serialized-form.html#org.apache.hadoop.fs.statistics.MeanStatistic">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/fs/statistics/MeanStatistic.html#MeanStatistic--">MeanStatistic</a></span>()</code>
<div class="block">Create an empty statistic.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/fs/statistics/MeanStatistic.html#MeanStatistic-long-long-">MeanStatistic</a></span>(long&nbsp;samples,
long&nbsp;sum)</code>
<div class="block">Constructor, with some resilience against invalid sample counts.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/fs/statistics/MeanStatistic.html#MeanStatistic-org.apache.hadoop.fs.statistics.MeanStatistic-">MeanStatistic</a></span>(<a href="../../../../../org/apache/hadoop/fs/statistics/MeanStatistic.html" title="class in org.apache.hadoop.fs.statistics">MeanStatistic</a>&nbsp;that)</code>
<div class="block">Create from another statistic.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/hadoop/fs/statistics/MeanStatistic.html" title="class in org.apache.hadoop.fs.statistics">MeanStatistic</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/fs/statistics/MeanStatistic.html#add-org.apache.hadoop.fs.statistics.MeanStatistic-">add</a></span>(<a href="../../../../../org/apache/hadoop/fs/statistics/MeanStatistic.html" title="class in org.apache.hadoop.fs.statistics">MeanStatistic</a>&nbsp;other)</code>
<div class="block">Add another MeanStatistic.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/fs/statistics/MeanStatistic.html#addSample-long-">addSample</a></span>(long&nbsp;value)</code>
<div class="block">Add a sample.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/fs/statistics/MeanStatistic.html#clear--">clear</a></span>()</code>
<div class="block">Set the values to 0.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/hadoop/fs/statistics/MeanStatistic.html" title="class in org.apache.hadoop.fs.statistics">MeanStatistic</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/fs/statistics/MeanStatistic.html#clone--">clone</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/hadoop/fs/statistics/MeanStatistic.html" title="class in org.apache.hadoop.fs.statistics">MeanStatistic</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/fs/statistics/MeanStatistic.html#copy--">copy</a></span>()</code>
<div class="block">Create a copy of this instance.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/fs/statistics/MeanStatistic.html#equals-java.lang.Object-">equals</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;o)</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/fs/statistics/MeanStatistic.html#getSamples--">getSamples</a></span>()</code>
<div class="block">Get the sample count.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/fs/statistics/MeanStatistic.html#getSum--">getSum</a></span>()</code>
<div class="block">Get the sum of samples.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/fs/statistics/MeanStatistic.html#hashCode--">hashCode</a></span>()</code>
<div class="block">The hash code is derived from the mean
and sample count: if either is changed
the statistic cannot be used as a key
for hash tables/maps.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/fs/statistics/MeanStatistic.html#isEmpty--">isEmpty</a></span>()</code>
<div class="block">Is a statistic empty?</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/fs/statistics/MeanStatistic.html#mean--">mean</a></span>()</code>
<div class="block">Get the arithmetic mean value.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/fs/statistics/MeanStatistic.html#set-org.apache.hadoop.fs.statistics.MeanStatistic-">set</a></span>(<a href="../../../../../org/apache/hadoop/fs/statistics/MeanStatistic.html" title="class in org.apache.hadoop.fs.statistics">MeanStatistic</a>&nbsp;other)</code>
<div class="block">Set the statistic to the values of another.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/fs/statistics/MeanStatistic.html#setSamples-long-">setSamples</a></span>(long&nbsp;samples)</code>
<div class="block">Set the sample count.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/fs/statistics/MeanStatistic.html#setSamplesAndSum-long-long-">setSamplesAndSum</a></span>(long&nbsp;sampleCount,
long&nbsp;newSum)</code>
<div class="block">Set the sum and samples.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/fs/statistics/MeanStatistic.html#setSum-long-">setSum</a></span>(long&nbsp;sum)</code>
<div class="block">Set the sum.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/fs/statistics/MeanStatistic.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="MeanStatistic-long-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MeanStatistic</h4>
<pre>public&nbsp;MeanStatistic(long&nbsp;samples,
long&nbsp;sum)</pre>
<div class="block">Constructor, with some resilience against invalid sample counts.
If the sample count is 0 or less, the sum is set to 0 and
the sample count to 0.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>samples</code> - sample count.</dd>
<dd><code>sum</code> - sum value</dd>
</dl>
</li>
</ul>
<a name="MeanStatistic-org.apache.hadoop.fs.statistics.MeanStatistic-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MeanStatistic</h4>
<pre>public&nbsp;MeanStatistic(<a href="../../../../../org/apache/hadoop/fs/statistics/MeanStatistic.html" title="class in org.apache.hadoop.fs.statistics">MeanStatistic</a>&nbsp;that)</pre>
<div class="block">Create from another statistic.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>that</code> - source</dd>
</dl>
</li>
</ul>
<a name="MeanStatistic--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MeanStatistic</h4>
<pre>public&nbsp;MeanStatistic()</pre>
<div class="block">Create an empty statistic.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getSum--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSum</h4>
<pre>public&nbsp;long&nbsp;getSum()</pre>
<div class="block">Get the sum of samples.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the sum</dd>
</dl>
</li>
</ul>
<a name="getSamples--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSamples</h4>
<pre>public&nbsp;long&nbsp;getSamples()</pre>
<div class="block">Get the sample count.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the sample count; 0 means empty</dd>
</dl>
</li>
</ul>
<a name="isEmpty--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEmpty</h4>
<pre>public&nbsp;boolean&nbsp;isEmpty()</pre>
<div class="block">Is a statistic empty?</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the sample count is 0</dd>
</dl>
</li>
</ul>
<a name="clear--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clear</h4>
<pre>public&nbsp;void&nbsp;clear()</pre>
<div class="block">Set the values to 0.</div>
</li>
</ul>
<a name="setSamplesAndSum-long-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSamplesAndSum</h4>
<pre>public&nbsp;void&nbsp;setSamplesAndSum(long&nbsp;sampleCount,
long&nbsp;newSum)</pre>
<div class="block">Set the sum and samples.
Synchronized.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sampleCount</code> - new sample count.</dd>
<dd><code>newSum</code> - new sum</dd>
</dl>
</li>
</ul>
<a name="set-org.apache.hadoop.fs.statistics.MeanStatistic-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>set</h4>
<pre>public&nbsp;void&nbsp;set(<a href="../../../../../org/apache/hadoop/fs/statistics/MeanStatistic.html" title="class in org.apache.hadoop.fs.statistics">MeanStatistic</a>&nbsp;other)</pre>
<div class="block">Set the statistic to the values of another.
Synchronized.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>other</code> - the source.</dd>
</dl>
</li>
</ul>
<a name="setSum-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSum</h4>
<pre>public&nbsp;void&nbsp;setSum(long&nbsp;sum)</pre>
<div class="block">Set the sum.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sum</code> - new sum</dd>
</dl>
</li>
</ul>
<a name="setSamples-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSamples</h4>
<pre>public&nbsp;void&nbsp;setSamples(long&nbsp;samples)</pre>
<div class="block">Set the sample count.
If this is less than zero, it is set to zero.
This stops an ill-formed JSON entry from
breaking deserialization, or get an invalid sample count
into an entry.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>samples</code> - sample count.</dd>
</dl>
</li>
</ul>
<a name="mean--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mean</h4>
<pre>public&nbsp;double&nbsp;mean()</pre>
<div class="block">Get the arithmetic mean value.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the mean</dd>
</dl>
</li>
</ul>
<a name="add-org.apache.hadoop.fs.statistics.MeanStatistic-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hadoop/fs/statistics/MeanStatistic.html" title="class in org.apache.hadoop.fs.statistics">MeanStatistic</a>&nbsp;add(<a href="../../../../../org/apache/hadoop/fs/statistics/MeanStatistic.html" title="class in org.apache.hadoop.fs.statistics">MeanStatistic</a>&nbsp;other)</pre>
<div class="block">Add another MeanStatistic.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>other</code> - other value</dd>
</dl>
</li>
</ul>
<a name="addSample-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addSample</h4>
<pre>public&nbsp;void&nbsp;addSample(long&nbsp;value)</pre>
<div class="block">Add a sample.
Thread safe.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - value to add to the sum</dd>
</dl>
</li>
</ul>
<a name="hashCode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public&nbsp;int&nbsp;hashCode()</pre>
<div class="block">The hash code is derived from the mean
and sample count: if either is changed
the statistic cannot be used as a key
for hash tables/maps.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a hash value</dd>
</dl>
</li>
</ul>
<a name="equals-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;equals(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;o)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
<a name="clone--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clone</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hadoop/fs/statistics/MeanStatistic.html" title="class in org.apache.hadoop.fs.statistics">MeanStatistic</a>&nbsp;clone()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
<a name="copy--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>copy</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hadoop/fs/statistics/MeanStatistic.html" title="class in org.apache.hadoop.fs.statistics">MeanStatistic</a>&nbsp;copy()</pre>
<div class="block">Create a copy of this instance.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>copy.</dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/MeanStatistic.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/hadoop/fs/statistics/IOStatisticsSupport.html" title="class in org.apache.hadoop.fs.statistics"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/hadoop/fs/statistics/StoreStatisticNames.html" title="class in org.apache.hadoop.fs.statistics"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/hadoop/fs/statistics/MeanStatistic.html" target="_top">Frames</a></li>
<li><a href="MeanStatistic.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2008&#x2013;2021 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>