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    *      https://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  
18  /*
19   * This is not the original file distributed by the Apache Software Foundation
20   * It has been modified by the Hipparchus project
21   */
22  package org.hipparchus.clustering;
23  
24  /**
25   * A Cluster used by centroid-based clustering algorithms.
26   * <p>
27   * Defines additionally a cluster center which may not necessarily be a member
28   * of the original data set.
29   *
30   * @param <T> the type of points that can be clustered
31   */
32  public class CentroidCluster<T extends Clusterable> extends Cluster<T> {
33  
34      /** Serializable version identifier. */
35      private static final long serialVersionUID = -3075288519071812288L;
36  
37      /** Center of the cluster. */
38      private final Clusterable center;
39  
40      /**
41       * Build a cluster centered at a specified point.
42       * @param center the point which is to be the center of this cluster
43       */
44      public CentroidCluster(final Clusterable center) {
45          super();
46          this.center = center;
47      }
48  
49      /**
50       * Get the point chosen to be the center of this cluster.
51       * @return chosen cluster center
52       */
53      public Clusterable getCenter() {
54          return center;
55      }
56  
57  }