/* * 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.math3.geometry.partitioning; import org.apache.commons.math3.geometry.Point; import org.apache.commons.math3.geometry.Space; /** This interface represents an hyperplane of a space. *
The most prominent place where hyperplane appears in space * partitioning is as cutters. Each partitioning node in a {@link * BSPTree BSP tree} has a cut {@link SubHyperplane sub-hyperplane} * which is either an hyperplane or a part of an hyperplane. In an * n-dimensions euclidean space, an hyperplane is an (n-1)-dimensions * hyperplane (for example a traditional plane in the 3D euclidean * space). They can be more exotic objects in specific fields, for * example a circle on the surface of the unit sphere.
** Note that this interface is not intended to be implemented * by Apache Commons Math users, it is only intended to be implemented * within the library itself. New methods may be added even for minor * versions, which breaks compatibility for external implementations. *
* @paramThe instance created is completely independant of the original * one. A deep copy is used, none of the underlying objects are * shared (except for immutable objects).
* @return a new hyperplane, copy of the instance */ HyperplaneThe offset is 0 if the point is on the underlying hyperplane, * it is positive if the point is on one particular side of the * hyperplane, and it is negative if the point is on the other side, * according to the hyperplane natural orientation.
* @param point point to check * @return offset of the point */ double getOffset(PointThis method is expected to be called on parallel hyperplanes. The * method should not re-check for parallelism, only for * orientation, typically by testing something like the sign of the * dot-products of normals.
* @param other other hyperplane to check against the instance * @return true if the instance and the other hyperplane have * the same orientation */ boolean sameOrientationAs(Hyperplane