diff options
Diffstat (limited to 'src/main/java/org/apache/commons/math3/stat/clustering/Clusterable.java')
-rw-r--r-- | src/main/java/org/apache/commons/math3/stat/clustering/Clusterable.java | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/src/main/java/org/apache/commons/math3/stat/clustering/Clusterable.java b/src/main/java/org/apache/commons/math3/stat/clustering/Clusterable.java new file mode 100644 index 0000000..f9818f3 --- /dev/null +++ b/src/main/java/org/apache/commons/math3/stat/clustering/Clusterable.java @@ -0,0 +1,48 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.commons.math3.stat.clustering; + +import java.util.Collection; + +/** + * Interface for points that can be clustered together. + * @param <T> the type of point that can be clustered + * @since 2.0 + * @deprecated As of 3.2 (to be removed in 4.0), + * use {@link org.apache.commons.math3.ml.clustering.Clusterable} instead + */ +@Deprecated +public interface Clusterable<T> { + + /** + * Returns the distance from the given point. + * + * @param p the point to compute the distance from + * @return the distance from the given point + */ + double distanceFrom(T p); + + /** + * Returns the centroid of the given Collection of points. + * + * @param p the Collection of points to compute the centroid of + * @return the centroid of the given Collection of Points + */ + T centroidOf(Collection<T> p); + +} |