summaryrefslogblamecommitdiff
path: root/site/docs/1.5.0/api/java/org/apache/spark/Aggregator.html
blob: fc73c8dd3e3d3b4cbbfe2b0afc7415950a17d058 (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>Aggregator</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="Aggregator";
    }
//-->
</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/AccumulatorParam.LongAccumulatorParam$.html" title="class in org.apache.spark"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/apache/spark/CleanAccum.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/Aggregator.html" target="_top">Frames</a></li>
<li><a href="Aggregator.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>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.spark</div>
<h2 title="Class Aggregator" class="title">Class Aggregator&lt;K,V,C&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.spark.Aggregator&lt;K,V,C&gt;</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable, scala.Equals, scala.Product</dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">Aggregator&lt;K,V,C&gt;</span>
extends java.lang.Object
implements scala.Product, scala.Serializable</pre>
<div class="block">:: DeveloperApi ::
 A set of functions used to aggregate data.
 <p>
 param:  createCombiner function to create the initial value of the aggregation.
 param:  mergeValue function to merge a new value into the aggregation result.
 param:  mergeCombiners function to merge outputs from multiple mergeValue function.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../serialized-form.html#org.apache.spark.Aggregator">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">&nbsp;</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/Aggregator.html#Aggregator(scala.Function1, scala.Function2, scala.Function2)">Aggregator</a></strong>(scala.Function1&lt;<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">V</a>,<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">C</a>&gt;&nbsp;createCombiner,
          scala.Function2&lt;<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">C</a>,<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">V</a>,<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">C</a>&gt;&nbsp;mergeValue,
          scala.Function2&lt;<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">C</a>,<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">C</a>,<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">C</a>&gt;&nbsp;mergeCombiners)</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>scala.collection.Iterator&lt;scala.Tuple2&lt;<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">K</a>,<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">C</a>&gt;&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/spark/Aggregator.html#combineCombinersByKey(scala.collection.Iterator)">combineCombinersByKey</a></strong>(scala.collection.Iterator&lt;scala.Product2&lt;<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">K</a>,<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">C</a>&gt;&gt;&nbsp;iter)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>scala.collection.Iterator&lt;scala.Tuple2&lt;<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">K</a>,<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">C</a>&gt;&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/spark/Aggregator.html#combineCombinersByKey(scala.collection.Iterator, org.apache.spark.TaskContext)">combineCombinersByKey</a></strong>(scala.collection.Iterator&lt;scala.Product2&lt;<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">K</a>,<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">C</a>&gt;&gt;&nbsp;iter,
                     <a href="../../../org/apache/spark/TaskContext.html" title="class in org.apache.spark">TaskContext</a>&nbsp;context)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>scala.collection.Iterator&lt;scala.Tuple2&lt;<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">K</a>,<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">C</a>&gt;&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/spark/Aggregator.html#combineValuesByKey(scala.collection.Iterator)">combineValuesByKey</a></strong>(scala.collection.Iterator&lt;scala.Product2&lt;<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">K</a>,<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">V</a>&gt;&gt;&nbsp;iter)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>scala.collection.Iterator&lt;scala.Tuple2&lt;<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">K</a>,<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">C</a>&gt;&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/spark/Aggregator.html#combineValuesByKey(scala.collection.Iterator, org.apache.spark.TaskContext)">combineValuesByKey</a></strong>(scala.collection.Iterator&lt;scala.Product2&lt;<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">K</a>,<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">V</a>&gt;&gt;&nbsp;iter,
                  <a href="../../../org/apache/spark/TaskContext.html" title="class in org.apache.spark">TaskContext</a>&nbsp;context)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>scala.Function1&lt;<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">V</a>,<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">C</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/spark/Aggregator.html#createCombiner()">createCombiner</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>scala.Function2&lt;<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">C</a>,<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">C</a>,<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">C</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/spark/Aggregator.html#mergeCombiners()">mergeCombiners</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>scala.Function2&lt;<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">C</a>,<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">V</a>,<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">C</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/spark/Aggregator.html#mergeValue()">mergeValue</a></strong>()</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.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_scala.Product">
<!--   -->
</a>
<h3>Methods inherited from interface&nbsp;scala.Product</h3>
<code>productArity, productElement, productIterator, productPrefix</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_scala.Equals">
<!--   -->
</a>
<h3>Methods inherited from interface&nbsp;scala.Equals</h3>
<code>canEqual, equals</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="Aggregator(scala.Function1, scala.Function2, scala.Function2)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Aggregator</h4>
<pre>public&nbsp;Aggregator(scala.Function1&lt;<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">V</a>,<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">C</a>&gt;&nbsp;createCombiner,
          scala.Function2&lt;<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">C</a>,<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">V</a>,<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">C</a>&gt;&nbsp;mergeValue,
          scala.Function2&lt;<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">C</a>,<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">C</a>,<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">C</a>&gt;&nbsp;mergeCombiners)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="createCombiner()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createCombiner</h4>
<pre>public&nbsp;scala.Function1&lt;<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">V</a>,<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">C</a>&gt;&nbsp;createCombiner()</pre>
</li>
</ul>
<a name="mergeValue()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mergeValue</h4>
<pre>public&nbsp;scala.Function2&lt;<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">C</a>,<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">V</a>,<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">C</a>&gt;&nbsp;mergeValue()</pre>
</li>
</ul>
<a name="mergeCombiners()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mergeCombiners</h4>
<pre>public&nbsp;scala.Function2&lt;<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">C</a>,<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">C</a>,<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">C</a>&gt;&nbsp;mergeCombiners()</pre>
</li>
</ul>
<a name="combineValuesByKey(scala.collection.Iterator)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>combineValuesByKey</h4>
<pre>public&nbsp;scala.collection.Iterator&lt;scala.Tuple2&lt;<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">K</a>,<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">C</a>&gt;&gt;&nbsp;combineValuesByKey(scala.collection.Iterator&lt;scala.Product2&lt;<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">K</a>,<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">V</a>&gt;&gt;&nbsp;iter)</pre>
</li>
</ul>
<a name="combineValuesByKey(scala.collection.Iterator, org.apache.spark.TaskContext)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>combineValuesByKey</h4>
<pre>public&nbsp;scala.collection.Iterator&lt;scala.Tuple2&lt;<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">K</a>,<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">C</a>&gt;&gt;&nbsp;combineValuesByKey(scala.collection.Iterator&lt;scala.Product2&lt;<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">K</a>,<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">V</a>&gt;&gt;&nbsp;iter,
                                                              <a href="../../../org/apache/spark/TaskContext.html" title="class in org.apache.spark">TaskContext</a>&nbsp;context)</pre>
</li>
</ul>
<a name="combineCombinersByKey(scala.collection.Iterator)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>combineCombinersByKey</h4>
<pre>public&nbsp;scala.collection.Iterator&lt;scala.Tuple2&lt;<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">K</a>,<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">C</a>&gt;&gt;&nbsp;combineCombinersByKey(scala.collection.Iterator&lt;scala.Product2&lt;<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">K</a>,<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">C</a>&gt;&gt;&nbsp;iter)</pre>
</li>
</ul>
<a name="combineCombinersByKey(scala.collection.Iterator, org.apache.spark.TaskContext)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>combineCombinersByKey</h4>
<pre>public&nbsp;scala.collection.Iterator&lt;scala.Tuple2&lt;<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">K</a>,<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">C</a>&gt;&gt;&nbsp;combineCombinersByKey(scala.collection.Iterator&lt;scala.Product2&lt;<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">K</a>,<a href="../../../org/apache/spark/Aggregator.html" title="type parameter in Aggregator">C</a>&gt;&gt;&nbsp;iter,
                                                                 <a href="../../../org/apache/spark/TaskContext.html" title="class in org.apache.spark">TaskContext</a>&nbsp;context)</pre>
</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/AccumulatorParam.LongAccumulatorParam$.html" title="class in org.apache.spark"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/apache/spark/CleanAccum.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/Aggregator.html" target="_top">Frames</a></li>
<li><a href="Aggregator.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>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 ======= -->
<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>