Package com.io7m.jregions.core.parameterized.areas

Interface PAreaBIType<S>

Type Parameters:
S - A phantom type parameter indicating the coordinate space of the area
All Superinterfaces:
AreaSizeValuesBIType, AreaValuesBIType
All Known Implementing Classes:
PAreaBI
@Immutable
public interface PAreaBIType<S>
extends AreaValuesBIType

An area with BigInteger coordinates.

The coordinates of the area are given in half-closed form. That is, minimumX() refers to the minimum inclusive value on the X axis, and maximumX() refers to the maximum exclusive value on the X axis. Likewise for the Y axis.

  • Method Summary

    Modifier and Type Method Description
    default void checkPreconditions()
    Check the preconditions for the parameters.
    java.math.BigInteger maximumX()  
    java.math.BigInteger maximumY()  
    java.math.BigInteger minimumX()  
    java.math.BigInteger minimumY()  

    Methods inherited from interface com.io7m.jregions.core.unparameterized.sizes.AreaSizeValuesBIType

    height, width

    Methods inherited from interface com.io7m.jregions.core.unparameterized.areas.AreaValuesBIType

    sizeX, sizeY

  • Method Details

    • minimumX

      @Parameter(order=0) java.math.BigInteger minimumX()
      Specified by:
      minimumX in interface AreaValuesBIType
      Returns:
      The value on the X axis of the minimum edge of the box (inclusive)

    • maximumX

      @Parameter(order=1) java.math.BigInteger maximumX()
      Specified by:
      maximumX in interface AreaValuesBIType
      Returns:
      The value on the X axis of the maximum edge of the box (exclusive)

    • minimumY

      @Parameter(order=2) java.math.BigInteger minimumY()
      Specified by:
      minimumY in interface AreaValuesBIType
      Returns:
      The value on the Y axis of the minimum edge of the box (inclusive)

    • maximumY

      @Parameter(order=3) java.math.BigInteger maximumY()
      Specified by:
      maximumY in interface AreaValuesBIType
      Returns:
      The value on the Y axis of the maximum edge of the box (exclusive)

    • checkPreconditions

      @Check default void checkPreconditions()
      Check the preconditions for the parameters.