| <!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:34 PDT 2017 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>Model (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="Model (Mahout Map-Reduce 0.13.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":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/Model.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/GaussianAccumulator.html" title="interface in org.apache.mahout.clustering"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/mahout/clustering/ModelDistribution.html" title="interface in org.apache.mahout.clustering"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/mahout/clustering/Model.html" target="_top">Frames</a></li> |
| <li><a href="Model.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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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</div> |
| <h2 title="Interface Model" class="title">Interface Model<O></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 Subinterfaces:</dt> |
| <dd><a href="../../../../org/apache/mahout/clustering/Cluster.html" title="interface in org.apache.mahout.clustering">Cluster</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/mahout/clustering/AbstractCluster.html" title="class in org.apache.mahout.clustering">AbstractCluster</a>, <a href="../../../../org/apache/mahout/clustering/canopy/Canopy.html" title="class in org.apache.mahout.clustering.canopy">Canopy</a>, <a href="../../../../org/apache/mahout/clustering/iterator/DistanceMeasureCluster.html" title="class in org.apache.mahout.clustering.iterator">DistanceMeasureCluster</a>, <a href="../../../../org/apache/mahout/clustering/kmeans/Kluster.html" title="class in org.apache.mahout.clustering.kmeans">Kluster</a>, <a href="../../../../org/apache/mahout/clustering/fuzzykmeans/SoftCluster.html" title="class in org.apache.mahout.clustering.fuzzykmeans">SoftCluster</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">Model<O></span> |
| extends org.apache.hadoop.io.Writable</pre> |
| <div class="block">A model is a probability distribution over observed data points and allows |
| the probability of any data point to be computed. All Models have a |
| persistent representation and extend |
| WritablesampleFromPosterior(Model<VectorWritable>[])</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mahout/clustering/Model.html#computeParameters--">computeParameters</a></span>()</code> |
| <div class="block">Compute a new set of posterior parameters based upon the Observations that |
| have been observed since my creation</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mahout/clustering/Model.html#getNumObservations--">getNumObservations</a></span>()</code> |
| <div class="block">Return the number of observations that this model has seen since its |
| parameters were last computed</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mahout/clustering/Model.html#getTotalObservations--">getTotalObservations</a></span>()</code> |
| <div class="block">Return the number of observations that this model has seen over its |
| lifetime</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/Model.html#observe-org.apache.mahout.clustering.Model-">observe</a></span>(<a href="../../../../org/apache/mahout/clustering/Model.html" title="interface in org.apache.mahout.clustering">Model</a><<a href="../../../../org/apache/mahout/clustering/Model.html" title="type parameter in Model">O</a>> x)</code> |
| <div class="block">Observe the given model, retaining information about its observations</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mahout/clustering/Model.html#observe-O-">observe</a></span>(<a href="../../../../org/apache/mahout/clustering/Model.html" title="type parameter in Model">O</a> x)</code> |
| <div class="block">Observe the given observation, retaining information about it</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mahout/clustering/Model.html#observe-O-double-">observe</a></span>(<a href="../../../../org/apache/mahout/clustering/Model.html" title="type parameter in Model">O</a> x, |
| double weight)</code> |
| <div class="block">Observe the given observation, retaining information about it</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mahout/clustering/Model.html#pdf-O-">pdf</a></span>(<a href="../../../../org/apache/mahout/clustering/Model.html" title="type parameter in Model">O</a> x)</code> |
| <div class="block">Return the probability that the observation is described by this model</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/mahout/clustering/Model.html" title="interface in org.apache.mahout.clustering">Model</a><<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>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mahout/clustering/Model.html#sampleFromPosterior--">sampleFromPosterior</a></span>()</code> </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 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="pdf-java.lang.Object-"> |
| <!-- --> |
| </a><a name="pdf-O-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>pdf</h4> |
| <pre>double pdf(<a href="../../../../org/apache/mahout/clustering/Model.html" title="type parameter in Model">O</a> x)</pre> |
| <div class="block">Return the probability that the observation is described by this model</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>x</code> - an Observation from the posterior</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the probability that x is in the receiver</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="observe-java.lang.Object-"> |
| <!-- --> |
| </a><a name="observe-O-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>observe</h4> |
| <pre>void observe(<a href="../../../../org/apache/mahout/clustering/Model.html" title="type parameter in Model">O</a> x)</pre> |
| <div class="block">Observe the given observation, retaining information about it</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>x</code> - an Observation from the posterior</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="observe-java.lang.Object-double-"> |
| <!-- --> |
| </a><a name="observe-O-double-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>observe</h4> |
| <pre>void observe(<a href="../../../../org/apache/mahout/clustering/Model.html" title="type parameter in Model">O</a> x, |
| double weight)</pre> |
| <div class="block">Observe the given observation, retaining information about it</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>x</code> - an Observation from the posterior</dd> |
| <dd><code>weight</code> - a double weighting factor</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="observe-org.apache.mahout.clustering.Model-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>observe</h4> |
| <pre>void observe(<a href="../../../../org/apache/mahout/clustering/Model.html" title="interface in org.apache.mahout.clustering">Model</a><<a href="../../../../org/apache/mahout/clustering/Model.html" title="type parameter in Model">O</a>> x)</pre> |
| <div class="block">Observe the given model, retaining information about its observations</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>x</code> - a Model<0></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="computeParameters--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>computeParameters</h4> |
| <pre>void computeParameters()</pre> |
| <div class="block">Compute a new set of posterior parameters based upon the Observations that |
| have been observed since my creation</div> |
| </li> |
| </ul> |
| <a name="getNumObservations--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNumObservations</h4> |
| <pre>long getNumObservations()</pre> |
| <div class="block">Return the number of observations that this model has seen since its |
| parameters were last computed</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a long</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTotalObservations--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTotalObservations</h4> |
| <pre>long getTotalObservations()</pre> |
| <div class="block">Return the number of observations that this model has seen over its |
| lifetime</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a long</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="sampleFromPosterior--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>sampleFromPosterior</h4> |
| <pre><a href="../../../../org/apache/mahout/clustering/Model.html" title="interface in org.apache.mahout.clustering">Model</a><<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>> sampleFromPosterior()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a sample of my posterior model</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/Model.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/GaussianAccumulator.html" title="interface in org.apache.mahout.clustering"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/mahout/clustering/ModelDistribution.html" title="interface in org.apache.mahout.clustering"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/mahout/clustering/Model.html" target="_top">Frames</a></li> |
| <li><a href="Model.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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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 © 2008–2017 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
