Package com.io7m.jregions.core.parameterized.sizes

# Class PAreaSizesBD

java.lang.Object
com.io7m.jregions.core.parameterized.sizes.PAreaSizesBD

    public final class PAreaSizesBD
    extends java.lang.Object

Functions over area sizes.

- ## Method Summary

  Modifier and Type | Method | Description
  --- | --- | ---
  `static <S> boolean` | `includes​(PAreaSizeBD<S> a, PAreaSizeBD<S> b)` | Determine if an area includes another area.

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

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

- ## Method Details

  - ### includes

    public static <S> boolean includes​(PAreaSizeBD<S> a, PAreaSizeBD<S> b)

    Determine if an area includes another area.

    Inclusion is reflexive: `∀a. includes(a, a)`

    Inclusion is transitive: `∀a b c. includes(a, b) ∧ includes(b, c) → includes(a, c)`

    Type Parameters:
      `S` - A phantom type parameter indicating the coordinate space of the area
    Parameters:
      `a` - The containing area
      `b` - The contained area
    Returns:
      `true` if `a` can contain `b`