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  
18  package org.apache.commons.math.stat.clustering;
19  
20  import java.util.Collection;
21  
22  /**
23   * Interface for points that can be clustered together.
24   * @param <T> the type of point that can be clustered
25   * @version $Revision: 799857 $ $Date: 2009-08-01 09:07:12 -0400 (Sat, 01 Aug 2009) $
26   * @since 2.0
27   */
28  public interface Clusterable<T> {
29  
30      /**
31       * Returns the distance from the given point.
32       * 
33       * @param p the point to compute the distance from
34       * @return the distance from the given point
35       */
36      double distanceFrom(T p);
37  
38      /**
39       * Returns the centroid of the given Collection of points.
40       * 
41       * @param p the Collection of points to compute the centroid of
42       * @return the centroid of the given Collection of Points
43       */
44      T centroidOf(Collection<T> p);
45  
46  }