View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.commons.math4.legacy.ml.clustering;
18  
19  /**
20   * A Cluster used by centroid-based clustering algorithms.
21   * <p>
22   * Defines additionally a cluster center which may not necessarily be a member
23   * of the original data set.
24   *
25   * @param <T> the type of points that can be clustered
26   * @since 3.2
27   */
28  public class CentroidCluster<T extends Clusterable> extends Cluster<T> {
29      /** Center of the cluster. */
30      private final Clusterable center;
31  
32      /**
33       * Build a cluster centered at a specified point.
34       * @param center the point which is to be the center of this cluster
35       */
36      public CentroidCluster(final Clusterable center) {
37          super();
38          this.center = center;
39      }
40  
41      /**
42       * Get the point chosen to be the center of this cluster.
43       * @return chosen cluster center
44       */
45      Clusterable getCenter() {
46          return center;
47      }
48  }