summaryrefslogtreecommitdiff
path: root/site/docs/0.6.1/api/core/spark/AccumulatorParam.html
diff options
context:
space:
mode:
Diffstat (limited to 'site/docs/0.6.1/api/core/spark/AccumulatorParam.html')
-rw-r--r--site/docs/0.6.1/api/core/spark/AccumulatorParam.html413
1 files changed, 413 insertions, 0 deletions
diff --git a/site/docs/0.6.1/api/core/spark/AccumulatorParam.html b/site/docs/0.6.1/api/core/spark/AccumulatorParam.html
new file mode 100644
index 000000000..2854a3e51
--- /dev/null
+++ b/site/docs/0.6.1/api/core/spark/AccumulatorParam.html
@@ -0,0 +1,413 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html>
+ <head>
+ <title>spark.AccumulatorParam</title>
+ <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
+
+ <link type="text/css" media="screen" rel="stylesheet" href="../lib/template.css" />
+ <script type="text/javascript" src="../lib/jquery.js"></script>
+ <script type="text/javascript" src="../lib/jquery-ui.js"></script>
+ <script type="text/javascript" src="../lib/template.js"></script>
+ <script type="text/javascript" src="../lib/tools.tooltip.js"></script>
+
+ </head>
+ <body onload="sh_highlightDocument('../lib/', '.min.js');" class="type">
+ <div id="definition">
+ <img src="../lib/trait_big.png" />
+ <p id="owner"><a name="spark" class="extype" href="package.html">spark</a></p>
+ <h1>AccumulatorParam</h1>
+ </div>
+
+ <h4 class="signature" id="signature">
+ <span class="modifier_kind">
+ <span class="modifier"></span>
+ <span class="kind">trait</span>
+ </span>
+ <span class="symbol">
+ <span class="name">AccumulatorParam</span><span class="tparams">[<span name="T">T</span>]</span><span class="result"> extends <a name="spark.AccumulableParam" class="extype" href="AccumulableParam.html">AccumulableParam</a>[T, T]</span>
+ </span>
+ </h4>
+
+ <div class="fullcommenttop" id="comment"><div class="comment cmt"><p>A simpler version of <a name="spark.AccumulableParam" class="extype" href="AccumulableParam.html">AccumulableParam</a> where the only datatype 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><dl class="paramcmts block"><dt class="tparam">T</dt><dd class="cmt"><p>type of value to accumulate
+</p></dd></dl><div class="toggleContainer block">
+ <span class="toggle">Linear Supertypes</span>
+ <div class="superTypes hiddenContent"><a name="spark.AccumulableParam" class="extype" href="AccumulableParam.html">AccumulableParam</a>[T, T], <span name="java.io.Serializable" class="extype">Serializable</span>, AnyRef, <span name="scala.Any" class="extype">Any</span></div>
+ </div><div class="toggleContainer block">
+ <span class="toggle">Known Subclasses</span>
+ <div class="subClasses hiddenContent"><a name="spark.SparkContext.DoubleAccumulatorParam" class="extype" href="SparkContext$$DoubleAccumulatorParam$.html">DoubleAccumulatorParam</a>, <a name="spark.SparkContext.IntAccumulatorParam" class="extype" href="SparkContext$$IntAccumulatorParam$.html">IntAccumulatorParam</a>, <a name="spark.util.Vector.VectorAccumParam" class="extype" href="util/Vector$$VectorAccumParam$.html">VectorAccumParam</a></div>
+ </div></div>
+
+
+ <div id="mbrsel">
+ <div id="textfilter"><span class="pre"></span><span class="input"><input accesskey="/" type="text" /></span><span class="post"></span></div>
+ <div id="order">
+ <span class="filtertype">Ordering</span>
+ <ol><li class="alpha in"><span>Alphabetic</span></li><li class="inherit out"><span>By inheritance</span></li></ol>
+ </div>
+ <div id="ancestors">
+ <span class="filtertype">Inherited</span>
+ <ol><li class="hideall out"><span>Hide All</span></li>
+ <li class="showall in"><span>Show all</span></li></ol>
+ <ol id="linearization"><li name="spark.AccumulatorParam" class="in"><span>AccumulatorParam</span></li><li name="spark.AccumulableParam" class="in"><span>AccumulableParam</span></li><li name="java.io.Serializable" class="in"><span>Serializable</span></li><li name="scala.AnyRef" class="in"><span>AnyRef</span></li><li name="scala.Any" class="in"><span>Any</span></li></ol>
+ </div>
+ <div id="visbl">
+ <span class="filtertype">Visibility</span>
+ <ol><li class="public in"><span>Public</span></li><li class="all out"><span>All</span></li></ol>
+ </div>
+ </div>
+
+ <div id="template">
+ <div id="allMembers">
+
+
+
+
+ <div class="values members" id="values">
+ <h3>Abstract Value Members</h3>
+ <ol><li visbl="pub" name="spark.AccumulableParam#addInPlace" data-isabs="true">
+ <a id="addInPlace(T,T):T"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">abstract </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">addInPlace</span><span class="params">(<span name="r1">r1: T</span>, <span name="r2">r2: T</span>)</span><span class="result">: T</span>
+ </span>
+ </h4>
+ <p class="shortcomment cmt">Merge two accumulated values together.</p><div class="fullcomment"><div class="comment cmt"><p>Merge two accumulated values together. Is allowed to modify and return the first value
+for efficiency (to avoid allocating objects).
+</p></div><dl class="paramcmts block"><dt class="param">r1</dt><dd class="cmt"><p>one set of accumulated data</p></dd><dt class="param">r2</dt><dd class="cmt"><p>another set of accumulated data</p></dd><dt>returns</dt><dd class="cmt"><p>both data sets merged together
+</p></dd></dl><dl class="attributes block"> <dt>Definition Classes</dt><dd><a name="spark.AccumulableParam" class="extype" href="AccumulableParam.html">AccumulableParam</a></dd></dl></div>
+ </li><li visbl="pub" name="spark.AccumulableParam#zero" data-isabs="true">
+ <a id="zero(T):T"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">abstract </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">zero</span><span class="params">(<span name="initialValue">initialValue: T</span>)</span><span class="result">: T</span>
+ </span>
+ </h4>
+ <p class="shortcomment cmt">Return the &quot;zero&quot; (identity) value for an accumulator type, given its initial value.</p><div class="fullcomment"><div class="comment cmt"><p>Return the &quot;zero&quot; (identity) value for an accumulator type, given its initial value. For
+example, if R was a vector of N dimensions, this would return a vector of N zeroes.
+</p></div><dl class="attributes block"> <dt>Definition Classes</dt><dd><a name="spark.AccumulableParam" class="extype" href="AccumulableParam.html">AccumulableParam</a></dd></dl></div>
+ </li></ol>
+ </div>
+
+ <div class="values members" id="values">
+ <h3>Concrete Value Members</h3>
+ <ol><li visbl="pub" name="scala.AnyRef#!=" data-isabs="false">
+ <a id="!=(AnyRef):Boolean"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name" title="gt4s: $bang$eq">!=</span><span class="params">(<span name="arg0">arg0: AnyRef</span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
+ </li><li visbl="pub" name="scala.Any#!=" data-isabs="false">
+ <a id="!=(Any):Boolean"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name" title="gt4s: $bang$eq">!=</span><span class="params">(<span name="arg0">arg0: <span name="scala.Any" class="extype">Any</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Any</dd></dl></div>
+ </li><li visbl="pub" name="scala.AnyRef###" data-isabs="false">
+ <a id="##():Int"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name" title="gt4s: $hash$hash">##</span><span class="params">()</span><span class="result">: <span name="scala.Int" class="extype">Int</span></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
+ </li><li visbl="pub" name="scala.AnyRef#==" data-isabs="false">
+ <a id="==(AnyRef):Boolean"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name" title="gt4s: $eq$eq">==</span><span class="params">(<span name="arg0">arg0: AnyRef</span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
+ </li><li visbl="pub" name="scala.Any#==" data-isabs="false">
+ <a id="==(Any):Boolean"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name" title="gt4s: $eq$eq">==</span><span class="params">(<span name="arg0">arg0: <span name="scala.Any" class="extype">Any</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Any</dd></dl></div>
+ </li><li visbl="pub" name="spark.AccumulatorParam#addAccumulator" data-isabs="false">
+ <a id="addAccumulator(T,T):T"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier"></span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">addAccumulator</span><span class="params">(<span name="t1">t1: T</span>, <span name="t2">t2: T</span>)</span><span class="result">: T</span>
+ </span>
+ </h4>
+ <p class="shortcomment cmt">Add additional data to the accumulator value.</p><div class="fullcomment"><div class="comment cmt"><p>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 class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>the new value of the accumulator
+</p></dd></dl><dl class="attributes block"> <dt>Definition Classes</dt><dd><a name="spark.AccumulatorParam" class="extype" href="">AccumulatorParam</a> → <a name="spark.AccumulableParam" class="extype" href="AccumulableParam.html">AccumulableParam</a></dd></dl></div>
+ </li><li visbl="pub" name="scala.Any#asInstanceOf" data-isabs="false">
+ <a id="asInstanceOf[T0]:T0"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">asInstanceOf</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="result">: T0</span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Any</dd></dl></div>
+ </li><li visbl="prt" name="scala.AnyRef#clone" data-isabs="false">
+ <a id="clone():AnyRef"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier"></span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">clone</span><span class="params">()</span><span class="result">: AnyRef</span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Attributes</dt><dd>protected[<a name="java.lang" class="extype" href="../java/lang/package.html">lang</a>] </dd><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
+ <span class="name">@throws</span><span class="args">()</span>
+
+ </dd></dl></div>
+ </li><li visbl="pub" name="scala.AnyRef#eq" data-isabs="false">
+ <a id="eq(AnyRef):Boolean"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">eq</span><span class="params">(<span name="arg0">arg0: AnyRef</span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
+ </li><li visbl="pub" name="scala.AnyRef#equals" data-isabs="false">
+ <a id="equals(Any):Boolean"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier"></span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">equals</span><span class="params">(<span name="arg0">arg0: <span name="scala.Any" class="extype">Any</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
+ </li><li visbl="prt" name="scala.AnyRef#finalize" data-isabs="false">
+ <a id="finalize():Unit"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier"></span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">finalize</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Attributes</dt><dd>protected[<a name="java.lang" class="extype" href="../java/lang/package.html">lang</a>] </dd><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
+ <span class="name">@throws</span><span class="args">()</span>
+
+ </dd></dl></div>
+ </li><li visbl="pub" name="scala.AnyRef#getClass" data-isabs="false">
+ <a id="getClass():java.lang.Class[_]"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">getClass</span><span class="params">()</span><span class="result">: java.lang.Class[_]</span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
+ </li><li visbl="pub" name="scala.AnyRef#hashCode" data-isabs="false">
+ <a id="hashCode():Int"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier"></span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">hashCode</span><span class="params">()</span><span class="result">: <span name="scala.Int" class="extype">Int</span></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
+ </li><li visbl="pub" name="scala.Any#isInstanceOf" data-isabs="false">
+ <a id="isInstanceOf[T0]:Boolean"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">isInstanceOf</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Any</dd></dl></div>
+ </li><li visbl="pub" name="scala.AnyRef#ne" data-isabs="false">
+ <a id="ne(AnyRef):Boolean"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">ne</span><span class="params">(<span name="arg0">arg0: AnyRef</span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
+ </li><li visbl="pub" name="scala.AnyRef#notify" data-isabs="false">
+ <a id="notify():Unit"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">notify</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
+ </li><li visbl="pub" name="scala.AnyRef#notifyAll" data-isabs="false">
+ <a id="notifyAll():Unit"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">notifyAll</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
+ </li><li visbl="pub" name="scala.AnyRef#synchronized" data-isabs="false">
+ <a id="synchronized[T0](⇒ T0):T0"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">synchronized</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="params">(<span name="arg0">arg0: ⇒ T0</span>)</span><span class="result">: T0</span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
+ </li><li visbl="pub" name="scala.AnyRef#toString" data-isabs="false">
+ <a id="toString():String"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier"></span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">toString</span><span class="params">()</span><span class="result">: <span name="java.lang.String" class="extype">String</span></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
+ </li><li visbl="pub" name="scala.AnyRef#wait" data-isabs="false">
+ <a id="wait():Unit"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">wait</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
+ <span class="name">@throws</span><span class="args">()</span>
+
+ </dd></dl></div>
+ </li><li visbl="pub" name="scala.AnyRef#wait" data-isabs="false">
+ <a id="wait(Long,Int):Unit"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">wait</span><span class="params">(<span name="arg0">arg0: <span name="scala.Long" class="extype">Long</span></span>, <span name="arg1">arg1: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
+ <span class="name">@throws</span><span class="args">()</span>
+
+ </dd></dl></div>
+ </li><li visbl="pub" name="scala.AnyRef#wait" data-isabs="false">
+ <a id="wait(Long):Unit"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">wait</span><span class="params">(<span name="arg0">arg0: <span name="scala.Long" class="extype">Long</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
+ <span class="name">@throws</span><span class="args">()</span>
+
+ </dd></dl></div>
+ </li></ol>
+ </div>
+
+
+ </div>
+
+ <div id="inheritedMembers">
+ <div name="spark.AccumulableParam" class="parent">
+ <h3>Inherited from <a name="spark.AccumulableParam" class="extype" href="AccumulableParam.html">AccumulableParam</a>[T, T]</h3>
+ </div><div name="java.io.Serializable" class="parent">
+ <h3>Inherited from <span name="java.io.Serializable" class="extype">Serializable</span></h3>
+ </div><div name="scala.AnyRef" class="parent">
+ <h3>Inherited from AnyRef</h3>
+ </div><div name="scala.Any" class="parent">
+ <h3>Inherited from <span name="scala.Any" class="extype">Any</span></h3>
+ </div>
+ </div>
+
+ </div>
+
+ <div id="tooltip"></div>
+
+ <div id="footer"> </div>
+
+
+ </body>
+ </html> \ No newline at end of file