Cluster.java

  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.  * This is not the original file distributed by the Apache Software Foundation
  19.  * It has been modified by the Hipparchus project
  20.  */

  21. package org.hipparchus.clustering;

  22. import java.io.Serializable;
  23. import java.util.ArrayList;
  24. import java.util.List;

  25. /**
  26.  * Cluster holding a set of {@link Clusterable} points.
  27.  * @param <T> the type of points that can be clustered
  28.  */
  29. public class Cluster<T extends Clusterable> implements Serializable {

  30.     /** Serializable version identifier. */
  31.     private static final long serialVersionUID = -3442297081515880464L;

  32.     /** The points contained in this cluster. */
  33.     private final List<T> points;

  34.     /**
  35.      * Build a cluster centered at a specified point.
  36.      */
  37.     public Cluster() {
  38.         points = new ArrayList<>();
  39.     }

  40.     /**
  41.      * Add a point to this cluster.
  42.      * @param point point to add
  43.      */
  44.     public void addPoint(final T point) {
  45.         points.add(point);
  46.     }

  47.     /**
  48.      * Get the points contained in the cluster.
  49.      * @return points contained in the cluster
  50.      */
  51.     public List<T> getPoints() {
  52.         return points;
  53.     }

  54. }