<!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:33 PDT 2015 -->
<title>Accumulable</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="Accumulable";
}
//-->
</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>Prev Class</li>
<li><a href="../../../org/apache/spark/AccumulableParam.html" title="interface in org.apache.spark"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/apache/spark/Accumulable.html" target="_top">Frames</a></li>
<li><a href="Accumulable.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</div>
<h2 title="Class Accumulable" class="title">Class Accumulable<R,T></h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.spark.Accumulable<R,T></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>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../org/apache/spark/Accumulator.html" title="class in org.apache.spark">Accumulator</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">Accumulable<R,T></span>
extends java.lang.Object
implements java.io.Serializable</pre>
<div class="block">A data type that can be accumulated, ie has an commutative and associative "add" operation,
but where the result type, <code>R</code>, may be different from the element type being added, <code>T</code>.
<p>
You must define how to add data, and how to merge two of these together. For some data types,
such as a counter, these might be the same operation. In that case, you can use the simpler
<a href="../../../org/apache/spark/Accumulator.html" title="class in org.apache.spark"><code>Accumulator</code></a>. They won't always be the same, though -- e.g., imagine you are
accumulating a set. You will add items to the set, and you will union two sets together.
<p>
param: initialValue initial value of accumulator
param: param helper object defining how to add elements of type <code>R</code> and <code>T</code>
param: name human-readable name for use in Spark's web UI
param: internal if this <a href="../../../org/apache/spark/Accumulable.html" title="class in org.apache.spark"><code>Accumulable</code></a> is internal. Internal <a href="../../../org/apache/spark/Accumulable.html" title="class in org.apache.spark"><code>Accumulable</code></a>s will be reported
to the driver via heartbeats. For internal <a href="../../../org/apache/spark/Accumulable.html" title="class in org.apache.spark"><code>Accumulable</code></a>s, <code>R</code> must be
thread safe so that they can be reported correctly.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../serialized-form.html#org.apache.spark.Accumulable">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/Accumulable.html#Accumulable(R, org.apache.spark.AccumulableParam)">Accumulable</a></strong>(<a href="../../../org/apache/spark/Accumulable.html" title="type parameter in Accumulable">R</a> initialValue,
<a href="../../../org/apache/spark/AccumulableParam.html" title="interface in org.apache.spark">AccumulableParam</a><<a href="../../../org/apache/spark/Accumulable.html" title="type parameter in Accumulable">R</a>,<a href="../../../org/apache/spark/Accumulable.html" title="type parameter in Accumulable">T</a>> param)</code> </td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../org/apache/spark/Accumulable.html#Accumulable(R, org.apache.spark.AccumulableParam, scala.Option)">Accumulable</a></strong>(<a href="../../../org/apache/spark/Accumulable.html" title="type parameter in Accumulable">R</a> initialValue,
<a href="../../../org/apache/spark/AccumulableParam.html" title="interface in org.apache.spark">AccumulableParam</a><<a href="../../../org/apache/spark/Accumulable.html" title="type parameter in Accumulable">R</a>,<a href="../../../org/apache/spark/Accumulable.html" title="type parameter in Accumulable">T</a>> param,
scala.Option<java.lang.String> name)</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>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/spark/Accumulable.html#add(T)">add</a></strong>(<a href="../../../org/apache/spark/Accumulable.html" title="type parameter in Accumulable">T</a> term)</code>
<div class="block">Add more data to this accumulator / accumulable</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/spark/Accumulable.html#id()">id</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/apache/spark/Accumulable.html" title="type parameter in Accumulable">R</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/spark/Accumulable.html#localValue()">localValue</a></strong>()</code>
<div class="block">Get the current value of this accumulator from within a task.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/spark/Accumulable.html#merge(R)">merge</a></strong>(<a href="../../../org/apache/spark/Accumulable.html" title="type parameter in Accumulable">R</a> term)</code>
<div class="block">Merge two accumulable objects together</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>scala.Option<java.lang.String></code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/spark/Accumulable.html#name()">name</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/spark/Accumulable.html#setValue(R)">setValue</a></strong>(<a href="../../../org/apache/spark/Accumulable.html" title="type parameter in Accumulable">R</a> newValue)</code>
<div class="block">Set the accumulator's value; only allowed on master</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/spark/Accumulable.html#toString()">toString</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/apache/spark/Accumulable.html" title="type parameter in Accumulable">R</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/spark/Accumulable.html#value()">value</a></strong>()</code>
<div class="block">Access the accumulator's current value; only allowed on master.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/apache/spark/Accumulable.html" title="type parameter in Accumulable">R</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/spark/Accumulable.html#zero()">zero</a></strong>()</code> </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="Accumulable(java.lang.Object,org.apache.spark.AccumulableParam,scala.Option)">
<!-- -->
</a><a name="Accumulable(R, org.apache.spark.AccumulableParam, scala.Option)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Accumulable</h4>
<pre>public Accumulable(<a href="../../../org/apache/spark/Accumulable.html" title="type parameter in Accumulable">R</a> initialValue,
<a href="../../../org/apache/spark/AccumulableParam.html" title="interface in org.apache.spark">AccumulableParam</a><<a href="../../../org/apache/spark/Accumulable.html" title="type parameter in Accumulable">R</a>,<a href="../../../org/apache/spark/Accumulable.html" title="type parameter in Accumulable">T</a>> param,
scala.Option<java.lang.String> name)</pre>
</li>
</ul>
<a name="Accumulable(java.lang.Object,org.apache.spark.AccumulableParam)">
<!-- -->
</a><a name="Accumulable(R, org.apache.spark.AccumulableParam)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Accumulable</h4>
<pre>public Accumulable(<a href="../../../org/apache/spark/Accumulable.html" title="type parameter in Accumulable">R</a> initialValue,
<a href="../../../org/apache/spark/AccumulableParam.html" title="interface in org.apache.spark">AccumulableParam</a><<a href="../../../org/apache/spark/Accumulable.html" title="type parameter in Accumulable">R</a>,<a href="../../../org/apache/spark/Accumulable.html" title="type parameter in Accumulable">T</a>> param)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="name()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>name</h4>
<pre>public scala.Option<java.lang.String> name()</pre>
</li>
</ul>
<a name="id()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>id</h4>
<pre>public long id()</pre>
</li>
</ul>
<a name="zero()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>zero</h4>
<pre>public <a href="../../../org/apache/spark/Accumulable.html" title="type parameter in Accumulable">R</a> zero()</pre>
</li>
</ul>
<a name="add(java.lang.Object)">
<!-- -->
</a><a name="add(T)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre>public void add(<a href="../../../org/apache/spark/Accumulable.html" title="type parameter in Accumulable">T</a> term)</pre>
<div class="block">Add more data to this accumulator / accumulable</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>term</code> - the data to add</dd></dl>
</li>
</ul>
<a name="merge(java.lang.Object)">
<!-- -->
</a><a name="merge(R)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>merge</h4>
<pre>public void merge(<a href="../../../org/apache/spark/Accumulable.html" title="type parameter in Accumulable">R</a> term)</pre>
<div class="block">Merge two accumulable objects together
<p>
Normally, a user will not want to use this version, but will instead call <code>add</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>term</code> - the other <code>R</code> that will get merged with this</dd></dl>
</li>
</ul>
<a name="value()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>value</h4>
<pre>public <a href="../../../org/apache/spark/Accumulable.html" title="type parameter in Accumulable">R</a> value()</pre>
<div class="block">Access the accumulator's current value; only allowed on master.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="localValue()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>localValue</h4>
<pre>public <a href="../../../org/apache/spark/Accumulable.html" title="type parameter in Accumulable">R</a> localValue()</pre>
<div class="block">Get the current value of this accumulator from within a task.
<p>
This is NOT the global value of the accumulator. To get the global value after a
completed operation on the dataset, call <code>value</code>.
<p>
The typical use of this method is to directly mutate the local value, eg., to add
an element to a Set.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="setValue(java.lang.Object)">
<!-- -->
</a><a name="setValue(R)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setValue</h4>
<pre>public void setValue(<a href="../../../org/apache/spark/Accumulable.html" title="type parameter in Accumulable">R</a> newValue)</pre>
<div class="block">Set the accumulator's value; only allowed on master</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>newValue</code> - (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>Prev Class</li>
<li><a href="../../../org/apache/spark/AccumulableParam.html" title="interface in org.apache.spark"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/apache/spark/Accumulable.html" target="_top">Frames</a></li>
<li><a href="Accumulable.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>