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    *      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.core.partitioning;
18  
19  /** Enumeration containing possible locations of a point with respect to
20   * a hyperplane.
21   * @see Hyperplane
22   */
23  public enum HyperplaneLocation {
24  
25      /** Value indicating that a point lies on the minus side of
26       * a hyperplane.
27       */
28      MINUS,
29  
30      /** Value indicating that a point lies on the plus side of
31       * a hyperplane.
32       */
33      PLUS,
34  
35      /** Value indicating that a point lies directly on a hyperplane.
36       */
37      ON
38  }