001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.math3.ml.clustering;
018
019/**
020 * A Cluster used by centroid-based clustering algorithms.
021 * <p>
022 * Defines additionally a cluster center which may not necessarily be a member
023 * of the original data set.
024 *
025 * @param <T> the type of points that can be clustered
026 * @since 3.2
027 */
028public class CentroidCluster<T extends Clusterable> extends Cluster<T> {
029
030    /** Serializable version identifier. */
031    private static final long serialVersionUID = -3075288519071812288L;
032
033    /** Center of the cluster. */
034    private final Clusterable center;
035
036    /**
037     * Build a cluster centered at a specified point.
038     * @param center the point which is to be the center of this cluster
039     */
040    public CentroidCluster(final Clusterable center) {
041        super();
042        this.center = center;
043    }
044
045    /**
046     * Get the point chosen to be the center of this cluster.
047     * @return chosen cluster center
048     */
049    public Clusterable getCenter() {
050        return center;
051    }
052
053}