blob: ebb43a808e219ae391cf0221693113faa5e19cf1 [file] [log] [blame]
<!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 (1.8.0_121) on Fri Apr 14 22:12:45 PDT 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CDbwEvaluator (Mahout Integration 0.13.0 API)</title>
<meta name="date" content="2017-04-14">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CDbwEvaluator (Mahout Integration 0.13.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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="class-use/CDbwEvaluator.html">Use</a></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>Prev&nbsp;Class</li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/mahout/clustering/cdbw/CDbwEvaluator.html" target="_top">Frames</a></li>
<li><a href="CDbwEvaluator.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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.mahout.clustering.cdbw</div>
<h2 title="Class CDbwEvaluator" class="title">Class CDbwEvaluator</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.mahout.clustering.cdbw.CDbwEvaluator</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <span class="typeNameLabel">CDbwEvaluator</span>
extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">This class calculates the CDbw metric as defined in
http://www.db-net.aueb.gr/index.php/corporate/content/download/227/833/file/HV_poster2002.pdf</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="memberSummary" 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><span class="memberNameLink"><a href="../../../../../org/apache/mahout/clustering/cdbw/CDbwEvaluator.html#CDbwEvaluator-org.apache.hadoop.conf.Configuration-org.apache.hadoop.fs.Path-">CDbwEvaluator</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf,
org.apache.hadoop.fs.Path&nbsp;clustersIn)</code>
<div class="block">Initialize a new instance from job information</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/clustering/cdbw/CDbwEvaluator.html#CDbwEvaluator-java.util.Map-java.util.List-org.apache.mahout.common.distance.DistanceMeasure-">CDbwEvaluator</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/VectorWritable.html?is-external=true" title="class or interface in org.apache.mahout.math">VectorWritable</a>&gt;&gt;&nbsp;representativePoints,
<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://mahout.apache.org/mahout-mr/apidocs/org/apache/mahout/clustering/Cluster.html?is-external=true" title="class or interface in org.apache.mahout.clustering">Cluster</a>&gt;&nbsp;clusters,
<a href="http://mahout.apache.org/mahout-mr/apidocs/org/apache/mahout/common/distance/DistanceMeasure.html?is-external=true" title="class or interface in org.apache.mahout.common.distance">DistanceMeasure</a>&nbsp;measure)</code>
<div class="block">For testing only</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/clustering/cdbw/CDbwEvaluator.html#getCDbw--">getCDbw</a></span>()</code>
<div class="block">Compute the CDbw validity metric (eqn 8).</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</a>&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/clustering/cdbw/CDbwEvaluator.html#interClusterDensities--">interClusterDensities</a></span>()</code>
<div class="block">This function evaluates the density of points in the regions between each clusters (eqn 1).</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/clustering/cdbw/CDbwEvaluator.html#interClusterDensity--">interClusterDensity</a></span>()</code>
<div class="block">This function evaluates the average density of points in the regions between clusters (eqn 1).</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Vector.html?is-external=true" title="class or interface in org.apache.mahout.math">Vector</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/clustering/cdbw/CDbwEvaluator.html#intraClusterDensities--">intraClusterDensities</a></span>()</code>
<div class="block">The average density within clusters is defined as the percentage of representative points that reside in the
neighborhood of the clusters' centers.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/clustering/cdbw/CDbwEvaluator.html#intraClusterDensity--">intraClusterDensity</a></span>()</code>
<div class="block">The average density within clusters is defined as the percentage of representative points that reside in the
neighborhood of the clusters' centers.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/clustering/cdbw/CDbwEvaluator.html#separation--">separation</a></span>()</code>
<div class="block">Calculate the separation of clusters (eqn 4) taking into account both the distances between the clusters' closest
points and the Inter-cluster density.</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.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></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="CDbwEvaluator-java.util.Map-java.util.List-org.apache.mahout.common.distance.DistanceMeasure-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CDbwEvaluator</h4>
<pre>public&nbsp;CDbwEvaluator(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/VectorWritable.html?is-external=true" title="class or interface in org.apache.mahout.math">VectorWritable</a>&gt;&gt;&nbsp;representativePoints,
<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://mahout.apache.org/mahout-mr/apidocs/org/apache/mahout/clustering/Cluster.html?is-external=true" title="class or interface in org.apache.mahout.clustering">Cluster</a>&gt;&nbsp;clusters,
<a href="http://mahout.apache.org/mahout-mr/apidocs/org/apache/mahout/common/distance/DistanceMeasure.html?is-external=true" title="class or interface in org.apache.mahout.common.distance">DistanceMeasure</a>&nbsp;measure)</pre>
<div class="block">For testing only</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>representativePoints</code> - a Map<Integer,List<VectorWritable>> of representative points keyed by clusterId</dd>
<dd><code>clusters</code> - a Map<Integer,Cluster> of the clusters keyed by clusterId</dd>
<dd><code>measure</code> - an appropriate DistanceMeasure</dd>
</dl>
</li>
</ul>
<a name="CDbwEvaluator-org.apache.hadoop.conf.Configuration-org.apache.hadoop.fs.Path-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CDbwEvaluator</h4>
<pre>public&nbsp;CDbwEvaluator(org.apache.hadoop.conf.Configuration&nbsp;conf,
org.apache.hadoop.fs.Path&nbsp;clustersIn)</pre>
<div class="block">Initialize a new instance from job information</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>conf</code> - a Configuration with appropriate parameters</dd>
<dd><code>clustersIn</code> - a String path to the input clusters directory</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getCDbw--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCDbw</h4>
<pre>public&nbsp;double&nbsp;getCDbw()</pre>
<div class="block">Compute the CDbw validity metric (eqn 8). The goal of this metric is to reward clusterings which have a high
intraClusterDensity and also a high cluster separation.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a double</dd>
</dl>
</li>
</ul>
<a name="intraClusterDensity--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>intraClusterDensity</h4>
<pre>public&nbsp;double&nbsp;intraClusterDensity()</pre>
<div class="block">The average density within clusters is defined as the percentage of representative points that reside in the
neighborhood of the clusters' centers. The goal is the density within clusters to be significantly high. (eqn 5)</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a double</dd>
</dl>
</li>
</ul>
<a name="interClusterDensities--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>interClusterDensities</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</a>&gt;&gt;&nbsp;interClusterDensities()</pre>
<div class="block">This function evaluates the density of points in the regions between each clusters (eqn 1). The goal is the density
in the area between clusters to be significant low.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a Map<Integer,Map<Integer,Double>> of the inter-cluster densities</dd>
</dl>
</li>
</ul>
<a name="separation--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>separation</h4>
<pre>public&nbsp;double&nbsp;separation()</pre>
<div class="block">Calculate the separation of clusters (eqn 4) taking into account both the distances between the clusters' closest
points and the Inter-cluster density. The goal is the distances between clusters to be high while the
representative point density in the areas between them are low.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a double</dd>
</dl>
</li>
</ul>
<a name="interClusterDensity--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>interClusterDensity</h4>
<pre>public&nbsp;double&nbsp;interClusterDensity()</pre>
<div class="block">This function evaluates the average density of points in the regions between clusters (eqn 1). The goal is the
density in the area between clusters to be significant low.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a double</dd>
</dl>
</li>
</ul>
<a name="intraClusterDensities--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>intraClusterDensities</h4>
<pre>public&nbsp;<a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Vector.html?is-external=true" title="class or interface in org.apache.mahout.math">Vector</a>&nbsp;intraClusterDensities()</pre>
<div class="block">The average density within clusters is defined as the percentage of representative points that reside in the
neighborhood of the clusters' centers. The goal is the density within clusters to be significantly high. (eqn 5)</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a Vector of the intra-densities of each clusterId</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>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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="class-use/CDbwEvaluator.html">Use</a></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>Prev&nbsp;Class</li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/mahout/clustering/cdbw/CDbwEvaluator.html" target="_top">Frames</a></li>
<li><a href="CDbwEvaluator.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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 ======= -->
<p class="legalCopy"><small>Copyright &#169; 2008&#x2013;2017 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>