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.List;
20
21 import org.apache.commons.geometry.core.Point;
22 import org.apache.commons.geometry.core.Region;
23
24 /**
25 * This class represents a convex hull.
26 *
27 * @param <P> Point implementation type.
28 */
29 public interface ConvexHull<P extends Point<P>> {
30
31 /** Get the vertices of the convex hull.
32 * @return vertices of the convex hull
33 */
34 List<P> getVertices();
35
36 /** Return the region representing the convex hull. This will return
37 * null in cases where the hull does not define a region with non-zero
38 * size, such as when only a single unique point exists or when all points
39 * are collinear.
40 * @return the region representing by the convex hull or null if the
41 * convex hull does not define a region of non-zero size
42 */
43 Region<P> getRegion();
44 }