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    *      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  
30  /**
31   * Interface for convex hull generators.
32   *
33   * @param <S> Type of the {@link Space}
34   * @param <P> Type of the {@link Point}
35   *
36   * @see <a href="http://en.wikipedia.org/wiki/Convex_hull">Convex Hull (Wikipedia)</a>
37   * @see <a href="http://mathworld.wolfram.com/ConvexHull.html">Convex Hull (MathWorld)</a>
38   *
39   */
40  public interface ConvexHullGenerator<S extends Space, P extends Point<S>> {
41  
42      /**
43       * Builds the convex hull from the set of input points.
44       *
45       * @param points the set of input points
46       * @return the convex hull
47       * @throws MathIllegalStateException if generator fails to generate a convex hull for
48       * the given set of input points
49       */
50      ConvexHull<S, P> generate(Collection<P> points) throws MathIllegalStateException;
51  }