diff options
Diffstat (limited to 'site/docs/0.6.1/api/core/spark/Accumulable.html')
-rw-r--r-- | site/docs/0.6.1/api/core/spark/Accumulable.html | 482 |
1 files changed, 482 insertions, 0 deletions
diff --git a/site/docs/0.6.1/api/core/spark/Accumulable.html b/site/docs/0.6.1/api/core/spark/Accumulable.html new file mode 100644 index 000000000..c9bf0d161 --- /dev/null +++ b/site/docs/0.6.1/api/core/spark/Accumulable.html @@ -0,0 +1,482 @@ +<?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.Accumulable</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/class_big.png" /> + <p id="owner"><a name="spark" class="extype" href="package.html">spark</a></p> + <h1>Accumulable</h1> + </div> + + <h4 class="signature" id="signature"> + <span class="modifier_kind"> + <span class="modifier"></span> + <span class="kind">class</span> + </span> + <span class="symbol"> + <span class="name">Accumulable</span><span class="tparams">[<span name="R">R</span>, <span name="T">T</span>]</span><span class="result"> extends <span name="java.io.Serializable" class="extype">Serializable</span></span> + </span> + </h4> + + <div class="fullcommenttop" id="comment"><div class="comment cmt"><p>A datatype that can be accumulated, i.e. 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><p>You must define how to add data, and how to merge two of these together. For some datatypes, +such as a counter, these might be the same operation. In that case, you can use the simpler +<a name="spark.Accumulator" class="extype" href="Accumulator.html">Accumulator</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></div><dl class="paramcmts block"><dt class="tparam">R</dt><dd class="cmt"><p>the full accumulated data (result type)</p></dd><dt class="tparam">T</dt><dd class="cmt"><p>partial data that can be added in +</p></dd></dl><div class="toggleContainer block"> + <span class="toggle">Linear Supertypes</span> + <div class="superTypes hiddenContent"><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.Accumulator" class="extype" href="Accumulator.html">Accumulator</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.Accumulable" class="in"><span>Accumulable</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="members" id="constructors"> + <h3>Instance Constructors</h3> + <ol><li visbl="pub" name="spark.Accumulable#this" data-isabs="false"> + <a id="this:Accumulable[R, T]"></a> + <h4 class="signature"> + <span class="modifier_kind"> + <span class="modifier"></span> + <span class="kind">new</span> + </span> + <span class="symbol"> + <span class="name">Accumulable</span><span class="params">(<span name="initialValue">initialValue: R</span>, <span name="param">param: <a name="spark.AccumulableParam" class="extype" href="AccumulableParam.html">AccumulableParam</a>[R, T]</span>)</span> + </span> + </h4> + <p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">initialValue</dt><dd class="cmt"><p>initial value of accumulator</p></dd><dt class="param">param</dt><dd class="cmt"><p>helper object defining how to add elements of type <code>R</code> and <code>T</code></p></dd></dl></div> + </li></ol> + </div> + + + + + + <div class="values members" id="values"> + <h3>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="spark.Accumulable#++=" data-isabs="false"> + <a id="++=(R):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" title="gt4s: $plus$plus$eq">++=</span><span class="params">(<span name="term">term: R</span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span> + </span> + </h4> + <p class="shortcomment cmt">Merge two accumulable objects together</p><div class="fullcomment"><div class="comment cmt"><p>Merge two accumulable objects together</p><p>Normally, a user will not want to use this version, but will instead call <code>+=</code>.</p></div><dl class="paramcmts block"><dt class="param">term</dt><dd class="cmt"><p>the other Accumulable that will get merged with this +</p></dd></dl></div> + </li><li visbl="pub" name="spark.Accumulable#+=" data-isabs="false"> + <a id="+=(T):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" title="gt4s: $plus$eq">+=</span><span class="params">(<span name="term">term: T</span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span> + </span> + </h4> + <p class="shortcomment cmt">Add more data to this accumulator / accumulable</p><div class="fullcomment"><div class="comment cmt"><p>Add more data to this accumulator / accumulable</p></div><dl class="paramcmts block"><dt class="param">term</dt><dd class="cmt"><p>the data to add +</p></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="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="spark.Accumulable#deserialized" data-isabs="false"> + <a id="deserialized:Boolean"></a> + <h4 class="signature"> + <span class="modifier_kind"> + <span class="modifier"></span> + <span class="kind">var</span> + </span> + <span class="symbol"> + <span class="name">deserialized</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span> + </span> + </h4> + + </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="spark.Accumulable#id" data-isabs="false"> + <a id="id:Long"></a> + <h4 class="signature"> + <span class="modifier_kind"> + <span class="modifier"></span> + <span class="kind">val</span> + </span> + <span class="symbol"> + <span class="name">id</span><span class="result">: <span name="scala.Long" class="extype">Long</span></span> + </span> + </h4> + + </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="spark.Accumulable#localValue" data-isabs="false"> + <a id="localValue:R"></a> + <h4 class="signature"> + <span class="modifier_kind"> + <span class="modifier"></span> + <span class="kind">def</span> + </span> + <span class="symbol"> + <span class="name">localValue</span><span class="result">: R</span> + </span> + </h4> + <p class="shortcomment cmt">Get the current value of this accumulator from within a task.</p><div class="fullcomment"><div class="comment cmt"><p>Get the current value of this accumulator from within a task.</p><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><p>The typical use of this method is to directly mutate the local value, eg., to add +an element to a Set. +</p></div></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="spark.Accumulable#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><a name="spark.Accumulable" class="extype" href="">Accumulable</a> → AnyRef → Any</dd></dl></div> + </li><li visbl="pub" name="spark.Accumulable#value" data-isabs="false"> + <a id="value:R"></a> + <h4 class="signature"> + <span class="modifier_kind"> + <span class="modifier"></span> + <span class="kind">def</span> + </span> + <span class="symbol"> + <span class="name">value</span><span class="result">: R</span> + </span> + </h4> + <p class="shortcomment cmt">Access the accumulator's current value; only allowed on master.</p> + </li><li visbl="pub" name="spark.Accumulable#value_=" data-isabs="false"> + <a id="value_=(R):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" title="gt4s: value_$eq">value_=</span><span class="params">(<span name="r">r: R</span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span> + </span> + </h4> + <p class="shortcomment cmt">Set the accumulator's value; only allowed on master.</p> + </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><li visbl="pub" name="spark.Accumulable#zero" data-isabs="false"> + <a id="zero:R"></a> + <h4 class="signature"> + <span class="modifier_kind"> + <span class="modifier"></span> + <span class="kind">val</span> + </span> + <span class="symbol"> + <span class="name">zero</span><span class="result">: R</span> + </span> + </h4> + + </li></ol> + </div> + + + </div> + + <div id="inheritedMembers"> + <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 |