The most prominent place where hyperplane appears in space
partitioning is as cutters. Each partitioning node in a BSP tree has a cut 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.
| Modifier and Type | Method and Description |
|---|---|
| public Hyperplane | |
| public double | |
| public double | Returns: tolerance below which points are considered to belong to the hyperplaneGet the tolerance below which points are considered to belong to the hyperplane. |
| public Point | |
| public boolean | Returns: true if the instance and the other hyperplane have the same orientationother hyperplane to check against the instance other)Check if the instance has the same orientation as another hyperplane. |
| public SubHyperplane | Returns: a sub-hyperplane covering the whole hyperplaneBuild a sub-hyperplane covering the whole hyperplane. |
| public Region |
| copySelf | back to summary |
|---|---|
| public Hyperplane Copy the instance. The 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).
| |
| getOffset | back to summary |
|---|---|
| public double getOffset(Point<S> point) Get the offset (oriented distance) of a point. The 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.
| |
| getTolerance | back to summary |
|---|---|
| public double getTolerance() Get the tolerance below which points are considered to belong to the hyperplane.
| |
| project | back to summary |
|---|---|
| public Point Project a point to the hyperplane. | |
| sameOrientationAs | back to summary |
|---|---|
| public boolean sameOrientationAs(Hyperplane<S> other) Check if the instance has the same orientation as another hyperplane. This 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.
| |
| wholeHyperplane | back to summary |
|---|---|
| public SubHyperplane Build a sub-hyperplane covering the whole hyperplane.
| |
| wholeSpace | back to summary |
|---|---|
| public Region Build a region covering the whole space.
| |