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    *      https://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.hipparchus.geometry.hull;
18  
19  import java.io.Serializable;
20  
21  import org.hipparchus.exception.MathIllegalArgumentException;
22  import org.hipparchus.geometry.Point;
23  import org.hipparchus.geometry.Space;
24  import org.hipparchus.geometry.partitioning.Region;
25  
26  /**
27   * This class represents a convex hull.
28   *
29   * @param <S> Space type.
30   * @param <P> Point type.
31   */
32  public interface ConvexHull<S extends Space, P extends Point<S>> extends Serializable {
33  
34      /**
35       * Get the vertices of the convex hull.
36       * @return vertices of the convex hull
37       */
38      P[] getVertices();
39  
40      /**
41       * Returns a new region that is enclosed by the convex hull.
42       * @return the region enclosed by the convex hull
43       * @throws MathIllegalArgumentException if the number of vertices is not enough to
44       * build a region in the respective space
45       */
46      Region<S> createRegion() throws MathIllegalArgumentException;
47  }