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 representing the location of a split object with respect
20 * to its splitting {@link Hyperplane hyperplane}.
21 */
22 public enum SplitLocation {
23
24 /** Value indicating that the split object lies entirely on the
25 * plus side of the splitting hyperplane.
26 */
27 PLUS,
28
29 /** Value indicating that the split object lies entirely on the
30 * minus side of the splitting hyperplane.
31 */
32 MINUS,
33
34 /** Value indicating that the split object lies in both the plus
35 * and minus sides of the splitting hyperplane.
36 */
37 BOTH,
38
39 /** Value indicating that the split object lies neither on the plus
40 * or minus sides of the splitting hyperplane. This is the case when
41 * the object lies entirely on the hyperplane or is empty (and
42 * therefore "lies" nowhere).
43 */
44 NEITHER
45 }