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  package org.apache.commons.geometry.hull;
    18
    19  import java.util.Collection;
    20
    21  import org.apache.commons.geometry.core.Point;
    22
    23  /**
    24   * Interface for convex hull generators.
    25   *
    26   * @param <P> Type of the {@link Point}
    27   *
    28   * @see <a href="http://en.wikipedia.org/wiki/Convex_hull">Convex Hull (Wikipedia)</a>
    29   * @see <a href="http://mathworld.wolfram.com/ConvexHull.html">Convex Hull (MathWorld)</a>
    30   */
    31  public interface ConvexHullGenerator<P extends Point<P>> {
    32      /**
    33       * Build a convex hull from the set of input points.
    34       *
    35       * @param points the set of input points
    36       * @return the convex hull
    37       * @throws IllegalStateException if generator fails to generate a convex hull for
    38       *      the given set of input points
    39       */
    40      ConvexHull<P> generate(Collection<P> points);
    41  }