org.apache.commons.math3.geometry.hull.ConvexHullGenerator Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of commons-math3 Show documentation
Show all versions of commons-math3 Show documentation
The Apache Commons Math project is a library of lightweight, self-contained mathematics and statistics components addressing the most common practical problems not immediately available in the Java programming language or commons-lang.
/*
* 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.geometry.hull;
import java.util.Collection;
import org.apache.commons.math3.exception.ConvergenceException;
import org.apache.commons.math3.exception.NullArgumentException;
import org.apache.commons.math3.geometry.Point;
import org.apache.commons.math3.geometry.Space;
/**
* Interface for convex hull generators.
*
* @param Type of the {@link Space}
* @param Type of the {@link Point}
*
* @see Convex Hull (Wikipedia)
* @see Convex Hull (MathWorld)
*
* @since 3.3
*/
public interface ConvexHullGenerator> {
/**
* Builds the convex hull from the set of input points.
*
* @param points the set of input points
* @return the convex hull
* @throws NullArgumentException if the input collection is {@code null}
* @throws ConvergenceException if generator fails to generate a convex hull for
* the given set of input points
*/
ConvexHull generate(Collection points) throws NullArgumentException, ConvergenceException;
}