001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.math3.geometry.hull;
018
019import java.util.Collection;
020
021import org.apache.commons.math3.exception.ConvergenceException;
022import org.apache.commons.math3.exception.NullArgumentException;
023import org.apache.commons.math3.geometry.Point;
024import org.apache.commons.math3.geometry.Space;
025
026/**
027 * Interface for convex hull generators.
028 *
029 * @param <S> Type of the {@link Space}
030 * @param <P> Type of the {@link Point}
031 *
032 * @see <a href="http://en.wikipedia.org/wiki/Convex_hull">Convex Hull (Wikipedia)</a>
033 * @see <a href="http://mathworld.wolfram.com/ConvexHull.html">Convex Hull (MathWorld)</a>
034 *
035 * @since 3.3
036 */
037public interface ConvexHullGenerator<S extends Space, P extends Point<S>> {
038
039    /**
040     * Builds the convex hull from the set of input points.
041     *
042     * @param points the set of input points
043     * @return the convex hull
044     * @throws NullArgumentException if the input collection is {@code null}
045     * @throws ConvergenceException if generator fails to generate a convex hull for
046     * the given set of input points
047     */
048    ConvexHull<S, P> generate(Collection<P> points) throws NullArgumentException, ConvergenceException;
049}