diff options
Diffstat (limited to 'src/main/java/org/apache/commons/math3/geometry/hull')
3 files changed, 121 insertions, 0 deletions
diff --git a/src/main/java/org/apache/commons/math3/geometry/hull/ConvexHull.java b/src/main/java/org/apache/commons/math3/geometry/hull/ConvexHull.java new file mode 100644 index 0000000..8dfa3f3 --- /dev/null +++ b/src/main/java/org/apache/commons/math3/geometry/hull/ConvexHull.java @@ -0,0 +1,48 @@ +/* + * 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.io.Serializable; + +import org.apache.commons.math3.exception.InsufficientDataException; +import org.apache.commons.math3.geometry.Point; +import org.apache.commons.math3.geometry.Space; +import org.apache.commons.math3.geometry.partitioning.Region; + +/** + * This class represents a convex hull. + * + * @param <S> Space type. + * @param <P> Point type. + * @since 3.3 + */ +public interface ConvexHull<S extends Space, P extends Point<S>> extends Serializable { + + /** + * Get the vertices of the convex hull. + * @return vertices of the convex hull + */ + P[] getVertices(); + + /** + * Returns a new region that is enclosed by the convex hull. + * @return the region enclosed by the convex hull + * @throws InsufficientDataException if the number of vertices is not enough to + * build a region in the respective space + */ + Region<S> createRegion() throws InsufficientDataException; +} diff --git a/src/main/java/org/apache/commons/math3/geometry/hull/ConvexHullGenerator.java b/src/main/java/org/apache/commons/math3/geometry/hull/ConvexHullGenerator.java new file mode 100644 index 0000000..8f601d2 --- /dev/null +++ b/src/main/java/org/apache/commons/math3/geometry/hull/ConvexHullGenerator.java @@ -0,0 +1,49 @@ +/* + * 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 <S> Type of the {@link Space} + * @param <P> Type of the {@link Point} + * + * @see <a href="http://en.wikipedia.org/wiki/Convex_hull">Convex Hull (Wikipedia)</a> + * @see <a href="http://mathworld.wolfram.com/ConvexHull.html">Convex Hull (MathWorld)</a> + * + * @since 3.3 + */ +public interface ConvexHullGenerator<S extends Space, P extends Point<S>> { + + /** + * 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<S, P> generate(Collection<P> points) throws NullArgumentException, ConvergenceException; +} diff --git a/src/main/java/org/apache/commons/math3/geometry/hull/package-info.java b/src/main/java/org/apache/commons/math3/geometry/hull/package-info.java new file mode 100644 index 0000000..2246682 --- /dev/null +++ b/src/main/java/org/apache/commons/math3/geometry/hull/package-info.java @@ -0,0 +1,24 @@ +/* + * 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. + */ +/** + * + * <p> + * This package provides interfaces and classes related to the convex hull problem. + * </p> + * + */ +package org.apache.commons.math3.geometry.hull; |