summaryrefslogblamecommitdiff
path: root/site/docs/1.5.0/api/java/org/apache/spark/graphx/lib/LabelPropagation.html
blob: 4cc6a01b9c4e7ae0ca13420361922b241a21bcf6 (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 15:55:08 PDT 2015 -->
<title>LabelPropagation</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="LabelPropagation";
    }
//-->
</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/graphx/lib/ConnectedComponents.html" title="class in org.apache.spark.graphx.lib"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/spark/graphx/lib/PageRank.html" title="class in org.apache.spark.graphx.lib"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/spark/graphx/lib/LabelPropagation.html" target="_top">Frames</a></li>
<li><a href="LabelPropagation.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.graphx.lib</div>
<h2 title="Class LabelPropagation" class="title">Class LabelPropagation</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.spark.graphx.lib.LabelPropagation</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">LabelPropagation</span>
extends java.lang.Object</pre>
<div class="block">Label Propagation algorithm.</div>
</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/graphx/lib/LabelPropagation.html#LabelPropagation()">LabelPropagation</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>static &lt;VD,ED&gt;&nbsp;<a href="../../../../../org/apache/spark/graphx/Graph.html" title="class in org.apache.spark.graphx">Graph</a>&lt;java.lang.Object,ED&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/graphx/lib/LabelPropagation.html#run(org.apache.spark.graphx.Graph, int, scala.reflect.ClassTag)">run</a></strong>(<a href="../../../../../org/apache/spark/graphx/Graph.html" title="class in org.apache.spark.graphx">Graph</a>&lt;VD,ED&gt;&nbsp;graph,
   int&nbsp;maxSteps,
   scala.reflect.ClassTag&lt;ED&gt;&nbsp;evidence$1)</code>
<div class="block">Run static Label Propagation for detecting communities in networks.</div>
</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>
</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="LabelPropagation()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>LabelPropagation</h4>
<pre>public&nbsp;LabelPropagation()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="run(org.apache.spark.graphx.Graph, int, scala.reflect.ClassTag)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>run</h4>
<pre>public static&nbsp;&lt;VD,ED&gt;&nbsp;<a href="../../../../../org/apache/spark/graphx/Graph.html" title="class in org.apache.spark.graphx">Graph</a>&lt;java.lang.Object,ED&gt;&nbsp;run(<a href="../../../../../org/apache/spark/graphx/Graph.html" title="class in org.apache.spark.graphx">Graph</a>&lt;VD,ED&gt;&nbsp;graph,
                                     int&nbsp;maxSteps,
                                     scala.reflect.ClassTag&lt;ED&gt;&nbsp;evidence$1)</pre>
<div class="block">Run static Label Propagation for detecting communities in networks.
 <p>
 Each node in the network is initially assigned to its own community. At every superstep, nodes
 send their community affiliation to all neighbors and update their state to the mode community
 affiliation of incoming messages.
 <p>
 LPA is a standard community detection algorithm for graphs. It is very inexpensive
 computationally, although (1) convergence is not guaranteed and (2) one can end up with
 trivial solutions (all nodes are identified into a single community).
 <p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>graph</code> - the graph for which to compute the community affiliation</dd><dd><code>maxSteps</code> - the number of supersteps of LPA to be performed. Because this is a static
 implementation, the algorithm will run for exactly this many supersteps.
 <p></dd><dd><code>evidence$1</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>a graph with vertex attributes containing the label of community affiliation</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/graphx/lib/ConnectedComponents.html" title="class in org.apache.spark.graphx.lib"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/spark/graphx/lib/PageRank.html" title="class in org.apache.spark.graphx.lib"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/spark/graphx/lib/LabelPropagation.html" target="_top">Frames</a></li>
<li><a href="LabelPropagation.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>