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 /*
19 * This is not the original file distributed by the Apache Software Foundation
20 * It has been modified by the Hipparchus project
21 */
22 package org.hipparchus.geometry.hull;
23
24 import java.util.Collection;
25
26 import org.hipparchus.exception.MathIllegalStateException;
27 import org.hipparchus.geometry.Point;
28 import org.hipparchus.geometry.Space;
29 import org.hipparchus.geometry.partitioning.Hyperplane;
30 import org.hipparchus.geometry.partitioning.SubHyperplane;
31
32 /**
33 * Interface for convex hull generators.
34 *
35 * @param <S> Type of the {@link Space}
36 * @param <P> Type of the {@link Point}
37 * @param <H> Type of the hyperplane.
38 * @param <I> Type of the sub-hyperplane.
39 *
40 * @see <a href="http://en.wikipedia.org/wiki/Convex_hull">Convex Hull (Wikipedia)</a>
41 * @see <a href="http://mathworld.wolfram.com/ConvexHull.html">Convex Hull (MathWorld)</a>
42 *
43 */
44 public interface ConvexHullGenerator<S extends Space,
45 P extends Point<S, P>,
46 H extends Hyperplane<S, P, H, I>,
47 I extends SubHyperplane<S, P, H, I>> {
48
49 /**
50 * Builds the convex hull from the set of input points.
51 *
52 * @param points the set of input points
53 * @return the convex hull
54 * @throws MathIllegalStateException if generator fails to generate a convex hull for
55 * the given set of input points
56 */
57 ConvexHull<S, P, H, I> generate(Collection<P> points) throws MathIllegalStateException;
58 }