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 */
017
018package org.apache.commons.math3.ml.clustering;
019
020import java.io.Serializable;
021import java.util.ArrayList;
022import java.util.List;
023
024/**
025 * Cluster holding a set of {@link Clusterable} points.
026 * @param <T> the type of points that can be clustered
027 * @version $Id: Cluster.html 885258 2013-11-03 02:46:49Z tn $
028 * @since 3.2
029 */
030public class Cluster<T extends Clusterable> implements Serializable {
031
032    /** Serializable version identifier. */
033    private static final long serialVersionUID = -3442297081515880464L;
034
035    /** The points contained in this cluster. */
036    private final List<T> points;
037
038    /**
039     * Build a cluster centered at a specified point.
040     */
041    public Cluster() {
042        points = new ArrayList<T>();
043    }
044
045    /**
046     * Add a point to this cluster.
047     * @param point point to add
048     */
049    public void addPoint(final T point) {
050        points.add(point);
051    }
052
053    /**
054     * Get the points contained in the cluster.
055     * @return points contained in the cluster
056     */
057    public List<T> getPoints() {
058        return points;
059    }
060
061}