org.apache.commons.math3.geometry.euclidean.oned

## Class SubOrientedPoint

- java.lang.Object
- - org.apache.commons.math3.geometry.partitioning.AbstractSubHyperplane<Euclidean1D,Euclidean1D>
  - - org.apache.commons.math3.geometry.euclidean.oned.SubOrientedPoint

- All Implemented Interfaces:
    SubHyperplane<Euclidean1D>

      public class SubOrientedPoint
      extends AbstractSubHyperplane<Euclidean1D,Euclidean1D>

  This class represents sub-hyperplane for `OrientedPoint`.

  An hyperplane in 1D is a simple point, its orientation being a boolean.

  Instances of this class are guaranteed to be immutable.

  Since:
    3.0

- - ### Nested Class Summary

    - ### Nested classes/interfaces inherited from interface org.apache.commons.math3.geometry.partitioning.SubHyperplane

      `SubHyperplane.SplitSubHyperplane<U extends Space>`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `SubOrientedPoint(Hyperplane<Euclidean1D> hyperplane, Region<Euclidean1D> remainingRegion)` Simple constructor.

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `protected AbstractSubHyperplane<Euclidean1D,Euclidean1D>` | `buildNew(Hyperplane<Euclidean1D> hyperplane, Region<Euclidean1D> remainingRegion)` Build a sub-hyperplane from an hyperplane and a region.
    `double` | `getSize()` Get the size of the instance.
    `boolean` | `isEmpty()` Check if the instance is empty.
    `SubHyperplane.SplitSubHyperplane<Euclidean1D>` | `split(Hyperplane<Euclidean1D> hyperplane)` Split the instance in two parts by an hyperplane.

    - ### Methods inherited from class org.apache.commons.math3.geometry.partitioning.AbstractSubHyperplane

      `applyTransform, copySelf, getHyperplane, getRemainingRegion, reunite, side`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### SubOrientedPoint

          public SubOrientedPoint(Hyperplane<Euclidean1D> hyperplane,
                          Region<Euclidean1D> remainingRegion)

      Simple constructor.
      Parameters:
        `hyperplane` - underlying hyperplane
        `remainingRegion` - remaining region of the hyperplane

  - ### Method Detail

    - #### getSize

          public double getSize()

      Get the size of the instance.
      Specified by:
        `getSize` in interface `SubHyperplane<Euclidean1D>`
      Overrides:
        `getSize` in class `AbstractSubHyperplane<Euclidean1D,Euclidean1D>`
      Returns:
        the size of the instance (this is a length in 1D, an area in 2D, a volume in 3D ...)

    - #### isEmpty

          public boolean isEmpty()

      Check if the instance is empty.
      Specified by:
        `isEmpty` in interface `SubHyperplane<Euclidean1D>`
      Overrides:
        `isEmpty` in class `AbstractSubHyperplane<Euclidean1D,Euclidean1D>`
      Returns:
        true if the instance is empty

    - #### buildNew

          protected AbstractSubHyperplane<Euclidean1D,Euclidean1D> buildNew(Hyperplane<Euclidean1D> hyperplane,
                                                                Region<Euclidean1D> remainingRegion)

      Build a sub-hyperplane from an hyperplane and a region.
      Specified by:
        `buildNew` in class `AbstractSubHyperplane<Euclidean1D,Euclidean1D>`
      Parameters:
        `hyperplane` - underlying hyperplane
        `remainingRegion` - remaining region of the hyperplane
      Returns:
        a new sub-hyperplane

    - #### split

          public SubHyperplane.SplitSubHyperplane<Euclidean1D> split(Hyperplane<Euclidean1D> hyperplane)

      Split the instance in two parts by an hyperplane.
      Specified by:
        `split` in interface `SubHyperplane<Euclidean1D>`
      Specified by:
        `split` in class `AbstractSubHyperplane<Euclidean1D,Euclidean1D>`
      Parameters:
        `hyperplane` - splitting hyperplane
      Returns:
        an object containing both the part of the instance on the plus side of the hyperplane and the part of the instance on the minus side of the hyperplane

Copyright © 2003–2016 The Apache Software Foundation. All rights reserved.