Google Git
Sign in
apache / mahout / master / . / docs / 0.13.0 / api / docs / mahout-mr / org / apache / mahout / clustering / iterator / ClusteringPolicy.html
blob: 8a5d8a3b1ae4b68de901a4ba616b2e21066fe94f [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:11:35 PDT 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ClusteringPolicy (Mahout Map-Reduce 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="ClusteringPolicy (Mahout Map-Reduce 0.13.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/ClusteringPolicy.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><a href="../../../../../org/apache/mahout/clustering/iterator/CIReducer.html" title="class in org.apache.mahout.clustering.iterator"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/mahout/clustering/iterator/ClusteringPolicyWritable.html" title="class in org.apache.mahout.clustering.iterator"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/mahout/clustering/iterator/ClusteringPolicy.html" target="_top">Frames</a></li>
<li><a href="ClusteringPolicy.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>Constr&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>Constr&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.iterator</div>
<h2 title="Interface ClusteringPolicy" class="title">Interface ClusteringPolicy</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd>org.apache.hadoop.io.Writable</dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/mahout/clustering/iterator/AbstractClusteringPolicy.html" title="class in org.apache.mahout.clustering.iterator">AbstractClusteringPolicy</a>, <a href="../../../../../org/apache/mahout/clustering/iterator/CanopyClusteringPolicy.html" title="class in org.apache.mahout.clustering.iterator">CanopyClusteringPolicy</a>, <a href="../../../../../org/apache/mahout/clustering/iterator/FuzzyKMeansClusteringPolicy.html" title="class in org.apache.mahout.clustering.iterator">FuzzyKMeansClusteringPolicy</a>, <a href="../../../../../org/apache/mahout/clustering/iterator/KMeansClusteringPolicy.html" title="class in org.apache.mahout.clustering.iterator">KMeansClusteringPolicy</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ClusteringPolicy</span>
extends org.apache.hadoop.io.Writable</pre>
<div class="block">A ClusteringPolicy captures the semantics of assignment of points to clusters</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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><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/iterator/ClusteringPolicy.html#classify-org.apache.mahout.math.Vector-org.apache.mahout.clustering.classify.ClusterClassifier-">classify</a></span>(<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;data,
<a href="../../../../../org/apache/mahout/clustering/classify/ClusterClassifier.html" title="class in org.apache.mahout.clustering.classify">ClusterClassifier</a>&nbsp;prior)</code>
<div class="block">Classify the data vector given the classifier's models</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/clustering/iterator/ClusteringPolicy.html#close-org.apache.mahout.clustering.classify.ClusterClassifier-">close</a></span>(<a href="../../../../../org/apache/mahout/clustering/classify/ClusterClassifier.html" title="class in org.apache.mahout.clustering.classify">ClusterClassifier</a>&nbsp;posterior)</code>
<div class="block">Close the policy using the classifier's models</div>
</td>
</tr>
<tr id="i2" class="altColor">
<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/iterator/ClusteringPolicy.html#select-org.apache.mahout.math.Vector-">select</a></span>(<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;probabilities)</code>
<div class="block">Return a vector of weights for each of the models given those probabilities</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/clustering/iterator/ClusteringPolicy.html#update-org.apache.mahout.clustering.classify.ClusterClassifier-">update</a></span>(<a href="../../../../../org/apache/mahout/clustering/classify/ClusterClassifier.html" title="class in org.apache.mahout.clustering.classify">ClusterClassifier</a>&nbsp;posterior)</code>
<div class="block">Update the policy with the given classifier</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.io.Writable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.hadoop.io.Writable</h3>
<code>readFields, write</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="classify-org.apache.mahout.math.Vector-org.apache.mahout.clustering.classify.ClusterClassifier-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>classify</h4>
<pre><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;classify(<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;data,
<a href="../../../../../org/apache/mahout/clustering/classify/ClusterClassifier.html" title="class in org.apache.mahout.clustering.classify">ClusterClassifier</a>&nbsp;prior)</pre>
<div class="block">Classify the data vector given the classifier's models</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>data</code> - a data Vector</dd>
<dd><code>prior</code> - a prior ClusterClassifier</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a Vector of probabilities that the data is described by each of the
models</dd>
</dl>
</li>
</ul>
<a name="select-org.apache.mahout.math.Vector-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>select</h4>
<pre><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;select(<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;probabilities)</pre>
<div class="block">Return a vector of weights for each of the models given those probabilities</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>probabilities</code> - a Vector of pdfs</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a Vector of weights</dd>
</dl>
</li>
</ul>
<a name="update-org.apache.mahout.clustering.classify.ClusterClassifier-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>update</h4>
<pre>void&nbsp;update(<a href="../../../../../org/apache/mahout/clustering/classify/ClusterClassifier.html" title="class in org.apache.mahout.clustering.classify">ClusterClassifier</a>&nbsp;posterior)</pre>
<div class="block">Update the policy with the given classifier</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>posterior</code> - a ClusterClassifier</dd>
</dl>
</li>
</ul>
<a name="close-org.apache.mahout.clustering.classify.ClusterClassifier-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>close</h4>
<pre>void&nbsp;close(<a href="../../../../../org/apache/mahout/clustering/classify/ClusterClassifier.html" title="class in org.apache.mahout.clustering.classify">ClusterClassifier</a>&nbsp;posterior)</pre>
<div class="block">Close the policy using the classifier's models</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>posterior</code> - a posterior ClusterClassifier</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/ClusteringPolicy.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><a href="../../../../../org/apache/mahout/clustering/iterator/CIReducer.html" title="class in org.apache.mahout.clustering.iterator"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/mahout/clustering/iterator/ClusteringPolicyWritable.html" title="class in org.apache.mahout.clustering.iterator"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/mahout/clustering/iterator/ClusteringPolicy.html" target="_top">Frames</a></li>
<li><a href="ClusteringPolicy.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>Constr&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>Constr&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>