commons-geometry-core/src/main/java/org/apache/commons/geometry/core/partitioning/HyperplaneLocation.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 containing possible locations of a point with respect to
 * a hyperplane.
 * @see Hyperplane
 */
public enum HyperplaneLocation {

    /** Value indicating that a point lies on the minus side of
     * a hyperplane.
     */
    MINUS,

    /** Value indicating that a point lies on the plus side of
     * a hyperplane.
     */
    PLUS,

    /** Value indicating that a point lies directly on a hyperplane.
     */
    ON
}