com.io7m.jregions.core.unparameterized.sizes

## Class AreaSizesF

- java.lang.Object
- - com.io7m.jregions.core.unparameterized.sizes.AreaSizesF

-     public final class AreaSizesF
      extends Object

  Functions over area sizes.

- - ### Method Summary

    All Methods Static Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `static AreaF` | `area(AreaSizeF size)` Construct an area at the origin that has the same size as `size`.
    `static boolean` | `includes(AreaSizeF a, AreaSizeF 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 Detail

    - #### includes

          public static boolean includes(AreaSizeF a,
                                         AreaSizeF 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)`

      Parameters:
        `a` - The containing area
        `b` - The contained area
      Returns:
        `true` if `a` can contain `b`

    - #### area

          public static AreaF area(AreaSizeF size)

      Construct an area at the origin that has the same size as `size`.
      Parameters:
        `size` - The area size
      Returns:
        An area at the origin

Copyright © 2017 <code@io7m.com> http://io7m.com