|
|
<!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 (version 1.7.0_51) on Wed Sep 16 10:26:35 PDT 2015 -->
<title>StatCounter</title>
<meta name="date" content="2015-09-16">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="StatCounter";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="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/spark/util/SparkShutdownHook.html" title="class in org.apache.spark.util"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/spark/util/TaskCompletionListener.html" title="interface in org.apache.spark.util"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/spark/util/StatCounter.html" target="_top">Frames</a></li>
<li><a href="StatCounter.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All 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: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </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.spark.util</div>
<h2 title="Class StatCounter" class="title">Class StatCounter</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.spark.util.StatCounter</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable</dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">StatCounter</span>
extends java.lang.Object
implements scala.Serializable</pre>
<div class="block">A class for tracking the statistics of a set of numbers (count, mean and variance) in a
numerically robust way. Includes support for merging two StatCounters. Based on Welford
and Chan's <code>algorithms</code>
for running variance.
<p></div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../serialized-form.html#org.apache.spark.util.StatCounter">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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/spark/util/StatCounter.html#StatCounter()">StatCounter</a></strong>()</code>
<div class="block">Initialize the StatCounter with no values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/spark/util/StatCounter.html#StatCounter(scala.collection.TraversableOnce)">StatCounter</a></strong>(scala.collection.TraversableOnce<java.lang.Object> values)</code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/spark/util/StatCounter.html" title="class in org.apache.spark.util">StatCounter</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/spark/util/StatCounter.html#apply(scala.collection.Seq)">apply</a></strong>(scala.collection.Seq<java.lang.Object> values)</code>
<div class="block">Build a StatCounter from a list of values passed as variable-length arguments.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/spark/util/StatCounter.html" title="class in org.apache.spark.util">StatCounter</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/spark/util/StatCounter.html#apply(scala.collection.TraversableOnce)">apply</a></strong>(scala.collection.TraversableOnce<java.lang.Object> values)</code>
<div class="block">Build a StatCounter from a list of values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/spark/util/StatCounter.html" title="class in org.apache.spark.util">StatCounter</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/spark/util/StatCounter.html#copy()">copy</a></strong>()</code>
<div class="block">Clone this StatCounter</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/spark/util/StatCounter.html#count()">count</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/spark/util/StatCounter.html#max()">max</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/spark/util/StatCounter.html#mean()">mean</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/spark/util/StatCounter.html" title="class in org.apache.spark.util">StatCounter</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/spark/util/StatCounter.html#merge(double)">merge</a></strong>(double value)</code>
<div class="block">Add a value into this StatCounter, updating the internal statistics.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/spark/util/StatCounter.html" title="class in org.apache.spark.util">StatCounter</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/spark/util/StatCounter.html#merge(org.apache.spark.util.StatCounter)">merge</a></strong>(<a href="../../../../org/apache/spark/util/StatCounter.html" title="class in org.apache.spark.util">StatCounter</a> other)</code>
<div class="block">Merge another StatCounter into this one, adding up the internal statistics.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/spark/util/StatCounter.html" title="class in org.apache.spark.util">StatCounter</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/spark/util/StatCounter.html#merge(scala.collection.TraversableOnce)">merge</a></strong>(scala.collection.TraversableOnce<java.lang.Object> values)</code>
<div class="block">Add multiple values into this StatCounter, updating the internal statistics.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/spark/util/StatCounter.html#min()">min</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/spark/util/StatCounter.html#sampleStdev()">sampleStdev</a></strong>()</code>
<div class="block">Return the sample standard deviation of the values, which corrects for bias in estimating the
variance by dividing by N-1 instead of N.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/spark/util/StatCounter.html#sampleVariance()">sampleVariance</a></strong>()</code>
<div class="block">Return the sample variance, which corrects for bias in estimating the variance by dividing
by N-1 instead of N.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/spark/util/StatCounter.html#stdev()">stdev</a></strong>()</code>
<div class="block">Return the standard deviation of the values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/spark/util/StatCounter.html#sum()">sum</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/spark/util/StatCounter.html#toString()">toString</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/spark/util/StatCounter.html#variance()">variance</a></strong>()</code>
<div class="block">Return the variance of the values.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</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="StatCounter(scala.collection.TraversableOnce)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>StatCounter</h4>
<pre>public StatCounter(scala.collection.TraversableOnce<java.lang.Object> values)</pre>
</li>
</ul>
<a name="StatCounter()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>StatCounter</h4>
<pre>public StatCounter()</pre>
<div class="block">Initialize the StatCounter with no values.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="apply(scala.collection.TraversableOnce)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>apply</h4>
<pre>public static <a href="../../../../org/apache/spark/util/StatCounter.html" title="class in org.apache.spark.util">StatCounter</a> apply(scala.collection.TraversableOnce<java.lang.Object> values)</pre>
<div class="block">Build a StatCounter from a list of values.</div>
</li>
</ul>
<a name="apply(scala.collection.Seq)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>apply</h4>
<pre>public static <a href="../../../../org/apache/spark/util/StatCounter.html" title="class in org.apache.spark.util">StatCounter</a> apply(scala.collection.Seq<java.lang.Object> values)</pre>
<div class="block">Build a StatCounter from a list of values passed as variable-length arguments.</div>
</li>
</ul>
<a name="merge(double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>merge</h4>
<pre>public <a href="../../../../org/apache/spark/util/StatCounter.html" title="class in org.apache.spark.util">StatCounter</a> merge(double value)</pre>
<div class="block">Add a value into this StatCounter, updating the internal statistics.</div>
</li>
</ul>
<a name="merge(scala.collection.TraversableOnce)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>merge</h4>
<pre>public <a href="../../../../org/apache/spark/util/StatCounter.html" title="class in org.apache.spark.util">StatCounter</a> merge(scala.collection.TraversableOnce<java.lang.Object> values)</pre>
<div class="block">Add multiple values into this StatCounter, updating the internal statistics.</div>
</li>
</ul>
<a name="merge(org.apache.spark.util.StatCounter)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>merge</h4>
<pre>public <a href="../../../../org/apache/spark/util/StatCounter.html" title="class in org.apache.spark.util">StatCounter</a> merge(<a href="../../../../org/apache/spark/util/StatCounter.html" title="class in org.apache.spark.util">StatCounter</a> other)</pre>
<div class="block">Merge another StatCounter into this one, adding up the internal statistics.</div>
</li>
</ul>
<a name="copy()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>copy</h4>
<pre>public <a href="../../../../org/apache/spark/util/StatCounter.html" title="class in org.apache.spark.util">StatCounter</a> copy()</pre>
<div class="block">Clone this StatCounter</div>
</li>
</ul>
<a name="count()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>count</h4>
<pre>public long count()</pre>
</li>
</ul>
<a name="mean()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mean</h4>
<pre>public double mean()</pre>
</li>
</ul>
<a name="sum()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sum</h4>
<pre>public double sum()</pre>
</li>
</ul>
<a name="max()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>max</h4>
<pre>public double max()</pre>
</li>
</ul>
<a name="min()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>min</h4>
<pre>public double min()</pre>
</li>
</ul>
<a name="variance()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>variance</h4>
<pre>public double variance()</pre>
<div class="block">Return the variance of the values.</div>
</li>
</ul>
<a name="sampleVariance()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sampleVariance</h4>
<pre>public double sampleVariance()</pre>
<div class="block">Return the sample variance, which corrects for bias in estimating the variance by dividing
by N-1 instead of N.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="stdev()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stdev</h4>
<pre>public double stdev()</pre>
<div class="block">Return the standard deviation of the values.</div>
</li>
</ul>
<a name="sampleStdev()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sampleStdev</h4>
<pre>public double sampleStdev()</pre>
<div class="block">Return the sample standard deviation of the values, which corrects for bias in estimating the
variance by dividing by N-1 instead of N.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public java.lang.String toString()</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>toString</code> in class <code>java.lang.Object</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="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/spark/util/SparkShutdownHook.html" title="class in org.apache.spark.util"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/spark/util/TaskCompletionListener.html" title="interface in org.apache.spark.util"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/spark/util/StatCounter.html" target="_top">Frames</a></li>
<li><a href="StatCounter.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All 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: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<script defer="defer" type="text/javascript" src="../../../../lib/jquery.js"></script><script defer="defer" type="text/javascript" src="../../../../lib/api-javadocs.js"></script></body>
</html>
|