PAreaSizesBI

java.lang.Object

com.io7m.jregions.core.parameterized.sizes.PAreaSizesBI

public final class PAreaSizesBI extends Object

Functions over area sizes.

Method Summary

Modifier and Type

Method

Description

static <S> boolean

includes(PAreaSizeBI<S> a, PAreaSizeBI<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(PAreaSizeBI<S> a, PAreaSizeBI<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