001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.geometry.core.partitioning;
018
019/** Enumeration representing the location of a split object with respect
020 * to its splitting {@link Hyperplane hyperplane}.
021 */
022public enum SplitLocation {
023
024    /** Value indicating that the split object lies entirely on the
025     * plus side of the splitting hyperplane.
026     */
027    PLUS,
028
029    /** Value indicating that the split object lies entirely on the
030     * minus side of the splitting hyperplane.
031     */
032    MINUS,
033
034    /** Value indicating that the split object lies in both the plus
035     * and minus sides of the splitting hyperplane.
036     */
037    BOTH,
038
039    /** Value indicating that the split object lies neither on the plus
040     * or minus sides of the splitting hyperplane. This is the case when
041     * the object lies entirely on the hyperplane or is empty (and
042     * therefore "lies" nowhere).
043     */
044    NEITHER
045}