com.io7m.jregions.core.unparameterized.sizes

Class AreaSizesI

java.lang.Object

com.io7m.jregions.core.unparameterized.sizes.AreaSizesI

public final class AreaSizesI
extends Object

Functions over area sizes.

Method Summary

Modifier and Type	Method and Description
static AreaI	area(AreaSizeI size) Construct an area at the origin that has the same size as size.
static boolean	includes(AreaSizeI a, AreaSizeI 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(AreaSizeI a,
                               AreaSizeI 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 AreaI area(AreaSizeI 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