summaryrefslogblamecommitdiff
path: root/site/docs/1.5.0/api/java/org/apache/spark/AccumulatorParam.html
blob: 5d3a5f78ca12212b43f10d381f75c26034554335 (plain) (tree)
1
2
3
4
5
6
7



                                                                                                      
                                                                                
                               
                                       






































































































































































































































































                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           
<!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>AccumulatorParam</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="AccumulatorParam";
    }
//-->
</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/Accumulator.html" title="class in org.apache.spark"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/apache/spark/AccumulatorParam.DoubleAccumulatorParam$.html" title="class in org.apache.spark"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/apache/spark/AccumulatorParam.html" target="_top">Frames</a></li>
<li><a href="AccumulatorParam.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:&nbsp;</li>
<li><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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.spark</div>
<h2 title="Interface AccumulatorParam" class="title">Interface AccumulatorParam&lt;T&gt;</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../org/apache/spark/AccumulableParam.html" title="interface in org.apache.spark">AccumulableParam</a>&lt;T,T&gt;, java.io.Serializable</dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../org/apache/spark/AccumulatorParam.DoubleAccumulatorParam$.html" title="class in org.apache.spark">AccumulatorParam.DoubleAccumulatorParam$</a>, <a href="../../../org/apache/spark/AccumulatorParam.FloatAccumulatorParam$.html" title="class in org.apache.spark">AccumulatorParam.FloatAccumulatorParam$</a>, <a href="../../../org/apache/spark/AccumulatorParam.IntAccumulatorParam$.html" title="class in org.apache.spark">AccumulatorParam.IntAccumulatorParam$</a>, <a href="../../../org/apache/spark/AccumulatorParam.LongAccumulatorParam$.html" title="class in org.apache.spark">AccumulatorParam.LongAccumulatorParam$</a>, <a href="../../../org/apache/spark/SparkContext.DoubleAccumulatorParam$.html" title="class in org.apache.spark">SparkContext.DoubleAccumulatorParam$</a>, <a href="../../../org/apache/spark/SparkContext.FloatAccumulatorParam$.html" title="class in org.apache.spark">SparkContext.FloatAccumulatorParam$</a>, <a href="../../../org/apache/spark/SparkContext.IntAccumulatorParam$.html" title="class in org.apache.spark">SparkContext.IntAccumulatorParam$</a>, <a href="../../../org/apache/spark/SparkContext.LongAccumulatorParam$.html" title="class in org.apache.spark">SparkContext.LongAccumulatorParam$</a>, <a href="../../../org/apache/spark/util/Vector.VectorAccumParam$.html" title="class in org.apache.spark.util">Vector.VectorAccumParam$</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">AccumulatorParam&lt;T&gt;</span>
extends <a href="../../../org/apache/spark/AccumulableParam.html" title="interface in org.apache.spark">AccumulableParam</a>&lt;T,T&gt;</pre>
<div class="block">A simpler version of <a href="../../../org/apache/spark/AccumulableParam.html" title="interface in org.apache.spark"><code>AccumulableParam</code></a> where the only data type you can add
 in is the same type as the accumulated value. An implicit AccumulatorParam object needs to be
 available when you create Accumulators of a specific type.
 <p></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!--   -->
</a>
<h3>Nested Class Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Interface and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/spark/AccumulatorParam.DoubleAccumulatorParam$.html" title="class in org.apache.spark">AccumulatorParam.DoubleAccumulatorParam$</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/spark/AccumulatorParam.FloatAccumulatorParam$.html" title="class in org.apache.spark">AccumulatorParam.FloatAccumulatorParam$</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/spark/AccumulatorParam.IntAccumulatorParam$.html" title="class in org.apache.spark">AccumulatorParam.IntAccumulatorParam$</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/spark/AccumulatorParam.LongAccumulatorParam$.html" title="class in org.apache.spark">AccumulatorParam.LongAccumulatorParam$</a></strong></code>&nbsp;</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">&nbsp;</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><a href="../../../org/apache/spark/AccumulatorParam.html" title="type parameter in AccumulatorParam">T</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/spark/AccumulatorParam.html#addAccumulator(T, T)">addAccumulator</a></strong>(<a href="../../../org/apache/spark/AccumulatorParam.html" title="type parameter in AccumulatorParam">T</a>&nbsp;t1,
              <a href="../../../org/apache/spark/AccumulatorParam.html" title="type parameter in AccumulatorParam">T</a>&nbsp;t2)</code>
<div class="block">Add additional data to the accumulator value.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.spark.AccumulableParam">
<!--   -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.spark.<a href="../../../org/apache/spark/AccumulableParam.html" title="interface in org.apache.spark">AccumulableParam</a></h3>
<code><a href="../../../org/apache/spark/AccumulableParam.html#addInPlace(R, R)">addInPlace</a>, <a href="../../../org/apache/spark/AccumulableParam.html#zero(R)">zero</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="addAccumulator(java.lang.Object,java.lang.Object)">
<!--   -->
</a><a name="addAccumulator(T, T)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>addAccumulator</h4>
<pre><a href="../../../org/apache/spark/AccumulatorParam.html" title="type parameter in AccumulatorParam">T</a>&nbsp;addAccumulator(<a href="../../../org/apache/spark/AccumulatorParam.html" title="type parameter in AccumulatorParam">T</a>&nbsp;t1,
               <a href="../../../org/apache/spark/AccumulatorParam.html" title="type parameter in AccumulatorParam">T</a>&nbsp;t2)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../org/apache/spark/AccumulableParam.html#addAccumulator(R, T)">AccumulableParam</a></code></strong></div>
<div class="block">Add additional data to the accumulator value. Is allowed to modify and return <code>r</code>
 for efficiency (to avoid allocating objects).
 <p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/apache/spark/AccumulableParam.html#addAccumulator(R, T)">addAccumulator</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/apache/spark/AccumulableParam.html" title="interface in org.apache.spark">AccumulableParam</a>&lt;<a href="../../../org/apache/spark/AccumulatorParam.html" title="type parameter in AccumulatorParam">T</a>,<a href="../../../org/apache/spark/AccumulatorParam.html" title="type parameter in AccumulatorParam">T</a>&gt;</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>t1</code> - the current value of the accumulator</dd><dd><code>t2</code> - the data to be added to the accumulator</dd>
<dt><span class="strong">Returns:</span></dt><dd>the new value of the accumulator</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/Accumulator.html" title="class in org.apache.spark"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/apache/spark/AccumulatorParam.DoubleAccumulatorParam$.html" title="class in org.apache.spark"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/apache/spark/AccumulatorParam.html" target="_top">Frames</a></li>
<li><a href="AccumulatorParam.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:&nbsp;</li>
<li><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&nbsp;|&nbsp;</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>