| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>KMeansPlusPlusClusterer (Apache Commons Math 3.3 API)</title> |
| <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="KMeansPlusPlusClusterer (Apache Commons Math 3.3 API)"; |
| } |
| //--> |
| </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="class-use/KMeansPlusPlusClusterer.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 class="aboutLanguage"><em><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script></em></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/commons/math3/ml/clustering/FuzzyKMeansClusterer.html" title="class in org.apache.commons.math3.ml.clustering"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/commons/math3/ml/clustering/KMeansPlusPlusClusterer.EmptyClusterStrategy.html" title="enum in org.apache.commons.math3.ml.clustering"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/commons/math3/ml/clustering/KMeansPlusPlusClusterer.html" target="_top">Frames</a></li> |
| <li><a href="KMeansPlusPlusClusterer.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><a href="#nested_class_summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </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.commons.math3.ml.clustering</div> |
| <h2 title="Class KMeansPlusPlusClusterer" class="title">Class KMeansPlusPlusClusterer<T extends <a href="../../../../../../org/apache/commons/math3/ml/clustering/Clusterable.html" title="interface in org.apache.commons.math3.ml.clustering">Clusterable</a>></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/6/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><a href="../../../../../../org/apache/commons/math3/ml/clustering/Clusterer.html" title="class in org.apache.commons.math3.ml.clustering">org.apache.commons.math3.ml.clustering.Clusterer</a><T></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.commons.math3.ml.clustering.KMeansPlusPlusClusterer<T></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - type of the points to cluster</dd></dl> |
| <hr> |
| <br> |
| <pre>public class <span class="strong">KMeansPlusPlusClusterer<T extends <a href="../../../../../../org/apache/commons/math3/ml/clustering/Clusterable.html" title="interface in org.apache.commons.math3.ml.clustering">Clusterable</a>></span> |
| extends <a href="../../../../../../org/apache/commons/math3/ml/clustering/Clusterer.html" title="class in org.apache.commons.math3.ml.clustering">Clusterer</a><T></pre> |
| <div class="block">Clustering algorithm based on David Arthur and Sergei Vassilvitski k-means++ algorithm.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.2</dd> |
| <dt><span class="strong">Version:</span></dt> |
| <dd>$Id: KMeansPlusPlusClusterer.java 1503290 2013-07-15 15:16:29Z sebb $</dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="http://en.wikipedia.org/wiki/K-means%2B%2B">K-means++ (wikipedia)</a></dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested_class_summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/ml/clustering/KMeansPlusPlusClusterer.EmptyClusterStrategy.html" title="enum in org.apache.commons.math3.ml.clustering">KMeansPlusPlusClusterer.EmptyClusterStrategy</a></strong></code> |
| <div class="block">Strategies to use for replacing an empty cluster.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== 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"> </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/commons/math3/ml/clustering/KMeansPlusPlusClusterer.html#KMeansPlusPlusClusterer(int)">KMeansPlusPlusClusterer</a></strong>(int k)</code> |
| <div class="block">Build a clusterer.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/math3/ml/clustering/KMeansPlusPlusClusterer.html#KMeansPlusPlusClusterer(int, int)">KMeansPlusPlusClusterer</a></strong>(int k, |
| int maxIterations)</code> |
| <div class="block">Build a clusterer.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/math3/ml/clustering/KMeansPlusPlusClusterer.html#KMeansPlusPlusClusterer(int, int, org.apache.commons.math3.ml.distance.DistanceMeasure)">KMeansPlusPlusClusterer</a></strong>(int k, |
| int maxIterations, |
| <a href="../../../../../../org/apache/commons/math3/ml/distance/DistanceMeasure.html" title="interface in org.apache.commons.math3.ml.distance">DistanceMeasure</a> measure)</code> |
| <div class="block">Build a clusterer.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/math3/ml/clustering/KMeansPlusPlusClusterer.html#KMeansPlusPlusClusterer(int, int, org.apache.commons.math3.ml.distance.DistanceMeasure, org.apache.commons.math3.random.RandomGenerator)">KMeansPlusPlusClusterer</a></strong>(int k, |
| int maxIterations, |
| <a href="../../../../../../org/apache/commons/math3/ml/distance/DistanceMeasure.html" title="interface in org.apache.commons.math3.ml.distance">DistanceMeasure</a> measure, |
| <a href="../../../../../../org/apache/commons/math3/random/RandomGenerator.html" title="interface in org.apache.commons.math3.random">RandomGenerator</a> random)</code> |
| <div class="block">Build a clusterer.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/math3/ml/clustering/KMeansPlusPlusClusterer.html#KMeansPlusPlusClusterer(int, int, org.apache.commons.math3.ml.distance.DistanceMeasure, org.apache.commons.math3.random.RandomGenerator, org.apache.commons.math3.ml.clustering.KMeansPlusPlusClusterer.EmptyClusterStrategy)">KMeansPlusPlusClusterer</a></strong>(int k, |
| int maxIterations, |
| <a href="../../../../../../org/apache/commons/math3/ml/distance/DistanceMeasure.html" title="interface in org.apache.commons.math3.ml.distance">DistanceMeasure</a> measure, |
| <a href="../../../../../../org/apache/commons/math3/random/RandomGenerator.html" title="interface in org.apache.commons.math3.random">RandomGenerator</a> random, |
| <a href="../../../../../../org/apache/commons/math3/ml/clustering/KMeansPlusPlusClusterer.EmptyClusterStrategy.html" title="enum in org.apache.commons.math3.ml.clustering">KMeansPlusPlusClusterer.EmptyClusterStrategy</a> emptyStrategy)</code> |
| <div class="block">Build a clusterer.</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </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><a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/commons/math3/ml/clustering/CentroidCluster.html" title="class in org.apache.commons.math3.ml.clustering">CentroidCluster</a><<a href="../../../../../../org/apache/commons/math3/ml/clustering/KMeansPlusPlusClusterer.html" title="type parameter in KMeansPlusPlusClusterer">T</a>>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/ml/clustering/KMeansPlusPlusClusterer.html#cluster(java.util.Collection)">cluster</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../../org/apache/commons/math3/ml/clustering/KMeansPlusPlusClusterer.html" title="type parameter in KMeansPlusPlusClusterer">T</a>> points)</code> |
| <div class="block">Runs the K-means++ clustering algorithm.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/commons/math3/ml/clustering/KMeansPlusPlusClusterer.EmptyClusterStrategy.html" title="enum in org.apache.commons.math3.ml.clustering">KMeansPlusPlusClusterer.EmptyClusterStrategy</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/ml/clustering/KMeansPlusPlusClusterer.html#getEmptyClusterStrategy()">getEmptyClusterStrategy</a></strong>()</code> |
| <div class="block">Returns the <a href="../../../../../../org/apache/commons/math3/ml/clustering/KMeansPlusPlusClusterer.EmptyClusterStrategy.html" title="enum in org.apache.commons.math3.ml.clustering"><code>KMeansPlusPlusClusterer.EmptyClusterStrategy</code></a> used by this instance.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/ml/clustering/KMeansPlusPlusClusterer.html#getK()">getK</a></strong>()</code> |
| <div class="block">Return the number of clusters this instance will use.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/ml/clustering/KMeansPlusPlusClusterer.html#getMaxIterations()">getMaxIterations</a></strong>()</code> |
| <div class="block">Returns the maximum number of iterations this instance will use.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/commons/math3/random/RandomGenerator.html" title="interface in org.apache.commons.math3.random">RandomGenerator</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/ml/clustering/KMeansPlusPlusClusterer.html#getRandomGenerator()">getRandomGenerator</a></strong>()</code> |
| <div class="block">Returns the random generator this instance will use.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.commons.math3.ml.clustering.Clusterer"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.commons.math3.ml.clustering.<a href="../../../../../../org/apache/commons/math3/ml/clustering/Clusterer.html" title="class in org.apache.commons.math3.ml.clustering">Clusterer</a></h3> |
| <code><a href="../../../../../../org/apache/commons/math3/ml/clustering/Clusterer.html#distance(org.apache.commons.math3.ml.clustering.Clusterable, org.apache.commons.math3.ml.clustering.Clusterable)">distance</a>, <a href="../../../../../../org/apache/commons/math3/ml/clustering/Clusterer.html#getDistanceMeasure()">getDistanceMeasure</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/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="KMeansPlusPlusClusterer(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>KMeansPlusPlusClusterer</h4> |
| <pre>public KMeansPlusPlusClusterer(int k)</pre> |
| <div class="block">Build a clusterer. |
| <p> |
| The default strategy for handling empty clusters that may appear during |
| algorithm iterations is to split the cluster with largest distance variance. |
| <p> |
| The euclidean distance will be used as default distance measure.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>k</code> - the number of clusters to split the data into</dd></dl> |
| </li> |
| </ul> |
| <a name="KMeansPlusPlusClusterer(int, int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>KMeansPlusPlusClusterer</h4> |
| <pre>public KMeansPlusPlusClusterer(int k, |
| int maxIterations)</pre> |
| <div class="block">Build a clusterer. |
| <p> |
| The default strategy for handling empty clusters that may appear during |
| algorithm iterations is to split the cluster with largest distance variance. |
| <p> |
| The euclidean distance will be used as default distance measure.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>k</code> - the number of clusters to split the data into</dd><dd><code>maxIterations</code> - the maximum number of iterations to run the algorithm for. |
| If negative, no maximum will be used.</dd></dl> |
| </li> |
| </ul> |
| <a name="KMeansPlusPlusClusterer(int, int, org.apache.commons.math3.ml.distance.DistanceMeasure)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>KMeansPlusPlusClusterer</h4> |
| <pre>public KMeansPlusPlusClusterer(int k, |
| int maxIterations, |
| <a href="../../../../../../org/apache/commons/math3/ml/distance/DistanceMeasure.html" title="interface in org.apache.commons.math3.ml.distance">DistanceMeasure</a> measure)</pre> |
| <div class="block">Build a clusterer. |
| <p> |
| The default strategy for handling empty clusters that may appear during |
| algorithm iterations is to split the cluster with largest distance variance.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>k</code> - the number of clusters to split the data into</dd><dd><code>maxIterations</code> - the maximum number of iterations to run the algorithm for. |
| If negative, no maximum will be used.</dd><dd><code>measure</code> - the distance measure to use</dd></dl> |
| </li> |
| </ul> |
| <a name="KMeansPlusPlusClusterer(int, int, org.apache.commons.math3.ml.distance.DistanceMeasure, org.apache.commons.math3.random.RandomGenerator)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>KMeansPlusPlusClusterer</h4> |
| <pre>public KMeansPlusPlusClusterer(int k, |
| int maxIterations, |
| <a href="../../../../../../org/apache/commons/math3/ml/distance/DistanceMeasure.html" title="interface in org.apache.commons.math3.ml.distance">DistanceMeasure</a> measure, |
| <a href="../../../../../../org/apache/commons/math3/random/RandomGenerator.html" title="interface in org.apache.commons.math3.random">RandomGenerator</a> random)</pre> |
| <div class="block">Build a clusterer. |
| <p> |
| The default strategy for handling empty clusters that may appear during |
| algorithm iterations is to split the cluster with largest distance variance.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>k</code> - the number of clusters to split the data into</dd><dd><code>maxIterations</code> - the maximum number of iterations to run the algorithm for. |
| If negative, no maximum will be used.</dd><dd><code>measure</code> - the distance measure to use</dd><dd><code>random</code> - random generator to use for choosing initial centers</dd></dl> |
| </li> |
| </ul> |
| <a name="KMeansPlusPlusClusterer(int, int, org.apache.commons.math3.ml.distance.DistanceMeasure, org.apache.commons.math3.random.RandomGenerator, org.apache.commons.math3.ml.clustering.KMeansPlusPlusClusterer.EmptyClusterStrategy)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>KMeansPlusPlusClusterer</h4> |
| <pre>public KMeansPlusPlusClusterer(int k, |
| int maxIterations, |
| <a href="../../../../../../org/apache/commons/math3/ml/distance/DistanceMeasure.html" title="interface in org.apache.commons.math3.ml.distance">DistanceMeasure</a> measure, |
| <a href="../../../../../../org/apache/commons/math3/random/RandomGenerator.html" title="interface in org.apache.commons.math3.random">RandomGenerator</a> random, |
| <a href="../../../../../../org/apache/commons/math3/ml/clustering/KMeansPlusPlusClusterer.EmptyClusterStrategy.html" title="enum in org.apache.commons.math3.ml.clustering">KMeansPlusPlusClusterer.EmptyClusterStrategy</a> emptyStrategy)</pre> |
| <div class="block">Build a clusterer.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>k</code> - the number of clusters to split the data into</dd><dd><code>maxIterations</code> - the maximum number of iterations to run the algorithm for. |
| If negative, no maximum will be used.</dd><dd><code>measure</code> - the distance measure to use</dd><dd><code>random</code> - random generator to use for choosing initial centers</dd><dd><code>emptyStrategy</code> - strategy to use for handling empty clusters that |
| may appear during algorithm iterations</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="getK()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getK</h4> |
| <pre>public int getK()</pre> |
| <div class="block">Return the number of clusters this instance will use.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the number of clusters</dd></dl> |
| </li> |
| </ul> |
| <a name="getMaxIterations()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxIterations</h4> |
| <pre>public int getMaxIterations()</pre> |
| <div class="block">Returns the maximum number of iterations this instance will use.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the maximum number of iterations, or -1 if no maximum is set</dd></dl> |
| </li> |
| </ul> |
| <a name="getRandomGenerator()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRandomGenerator</h4> |
| <pre>public <a href="../../../../../../org/apache/commons/math3/random/RandomGenerator.html" title="interface in org.apache.commons.math3.random">RandomGenerator</a> getRandomGenerator()</pre> |
| <div class="block">Returns the random generator this instance will use.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the random generator</dd></dl> |
| </li> |
| </ul> |
| <a name="getEmptyClusterStrategy()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEmptyClusterStrategy</h4> |
| <pre>public <a href="../../../../../../org/apache/commons/math3/ml/clustering/KMeansPlusPlusClusterer.EmptyClusterStrategy.html" title="enum in org.apache.commons.math3.ml.clustering">KMeansPlusPlusClusterer.EmptyClusterStrategy</a> getEmptyClusterStrategy()</pre> |
| <div class="block">Returns the <a href="../../../../../../org/apache/commons/math3/ml/clustering/KMeansPlusPlusClusterer.EmptyClusterStrategy.html" title="enum in org.apache.commons.math3.ml.clustering"><code>KMeansPlusPlusClusterer.EmptyClusterStrategy</code></a> used by this instance.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the <a href="../../../../../../org/apache/commons/math3/ml/clustering/KMeansPlusPlusClusterer.EmptyClusterStrategy.html" title="enum in org.apache.commons.math3.ml.clustering"><code>KMeansPlusPlusClusterer.EmptyClusterStrategy</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="cluster(java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>cluster</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/commons/math3/ml/clustering/CentroidCluster.html" title="class in org.apache.commons.math3.ml.clustering">CentroidCluster</a><<a href="../../../../../../org/apache/commons/math3/ml/clustering/KMeansPlusPlusClusterer.html" title="type parameter in KMeansPlusPlusClusterer">T</a>>> cluster(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../../org/apache/commons/math3/ml/clustering/KMeansPlusPlusClusterer.html" title="type parameter in KMeansPlusPlusClusterer">T</a>> points) |
| throws <a href="../../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a>, |
| <a href="../../../../../../org/apache/commons/math3/exception/ConvergenceException.html" title="class in org.apache.commons.math3.exception">ConvergenceException</a></pre> |
| <div class="block">Runs the K-means++ clustering algorithm.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../../org/apache/commons/math3/ml/clustering/Clusterer.html#cluster(java.util.Collection)">cluster</a></code> in class <code><a href="../../../../../../org/apache/commons/math3/ml/clustering/Clusterer.html" title="class in org.apache.commons.math3.ml.clustering">Clusterer</a><<a href="../../../../../../org/apache/commons/math3/ml/clustering/KMeansPlusPlusClusterer.html" title="type parameter in KMeansPlusPlusClusterer">T</a> extends <a href="../../../../../../org/apache/commons/math3/ml/clustering/Clusterable.html" title="interface in org.apache.commons.math3.ml.clustering">Clusterable</a>></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>points</code> - the points to cluster</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a list of clusters containing the points</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a></code> - if the data points are null or the number |
| of clusters is larger than the number of data points</dd> |
| <dd><code><a href="../../../../../../org/apache/commons/math3/exception/ConvergenceException.html" title="class in org.apache.commons.math3.exception">ConvergenceException</a></code> - if an empty cluster is encountered and the |
| <a href="../../../../../../org/apache/commons/math3/ml/clustering/KMeansPlusPlusClusterer.html#emptyStrategy"><code>emptyStrategy</code></a> is set to <code>ERROR</code></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="class-use/KMeansPlusPlusClusterer.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 class="aboutLanguage"><em><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script></em></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/commons/math3/ml/clustering/FuzzyKMeansClusterer.html" title="class in org.apache.commons.math3.ml.clustering"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/commons/math3/ml/clustering/KMeansPlusPlusClusterer.EmptyClusterStrategy.html" title="enum in org.apache.commons.math3.ml.clustering"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/commons/math3/ml/clustering/KMeansPlusPlusClusterer.html" target="_top">Frames</a></li> |
| <li><a href="KMeansPlusPlusClusterer.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><a href="#nested_class_summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </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 © 2003–2014 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
