org.apache.commons.math3.geometry.partitioning
S
 Type of the space.public interface Hyperplane<S extends Space>
The most prominent place where hyperplane appears in space
partitioning is as cutters. Each partitioning node in a BSP tree
has a cut subhyperplane
which is either an hyperplane or a part of an hyperplane. In an
ndimensions euclidean space, an hyperplane is an (n1)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 

Hyperplane<S> 
copySelf()
Copy the instance.

double 
getOffset(Point<S> point)
Get the offset (oriented distance) of a point.

double 
getTolerance()
Get the tolerance below which points are considered to belong to the hyperplane.

Point<S> 
project(Point<S> point)
Project a point to the hyperplane.

boolean 
sameOrientationAs(Hyperplane<S> other)
Check if the instance has the same orientation as another hyperplane.

SubHyperplane<S> 
wholeHyperplane()
Build a subhyperplane covering the whole hyperplane.

Region<S> 
wholeSpace()
Build a region covering the whole space.

Hyperplane<S> copySelf()
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).
double getOffset(Point<S> 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.
point
 point to checkPoint<S> project(Point<S> point)
point
 point to projectdouble getTolerance()
boolean sameOrientationAs(Hyperplane<S> other)
This method is expected to be called on parallel hyperplanes. The method should not recheck for parallelism, only for orientation, typically by testing something like the sign of the dotproducts of normals.
other
 other hyperplane to check against the instanceSubHyperplane<S> wholeHyperplane()
Region<S> wholeSpace()
Copyright © 2003–2015 The Apache Software Foundation. All rights reserved.