SplitLocation.java

/*
 * 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.geometry.core.partitioning;

/** Enumeration representing the location of a split object with respect
 * to its splitting {@link Hyperplane hyperplane}.
 */
public enum SplitLocation {

    /** Value indicating that the split object lies entirely on the
     * plus side of the splitting hyperplane.
     */
    PLUS,

    /** Value indicating that the split object lies entirely on the
     * minus side of the splitting hyperplane.
     */
    MINUS,

    /** Value indicating that the split object lies in both the plus
     * and minus sides of the splitting hyperplane.
     */
    BOTH,

    /** Value indicating that the split object lies neither on the plus
     * or minus sides of the splitting hyperplane. This is the case when
     * the object lies entirely on the hyperplane or is empty (and
     * therefore "lies" nowhere).
     */
    NEITHER
}