Trait/Object

geotrellis.layer

Bounds

Related Docs: object Bounds | package layer

Permalink

sealed trait Bounds[+A] extends Product with Serializable

Represents a region of discrete space, bounding it by minimum and maximum points. The bounds maybe EmptyBounds as result of intersection operation.

The dimensionality of region is implied by the dimensionality of type parameter A. Boundable typeclass is required to manipulate instance of A.

Conceptually this ADT is similar Option[KeyBounds[A]] but adds methods convenient for testing and forming region intersection, union and mutation.

A

Type of keys, or points in descrete space

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Bounds
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def canEqual(that: Any): Boolean

    Permalink
    Definition Classes
    Equals
  2. abstract def combine[B >: A](other: Bounds[B])(implicit b: Boundable[B]): Bounds[B]

    Permalink

    Combine two regions by creating a region that covers both regions fully

  3. abstract def contains[B >: A](other: Bounds[B])(implicit b: Boundable[B]): Boolean

    Permalink

    Test if other bounds are fully contained by this bounds.

    Test if other bounds are fully contained by this bounds. EmptyBounds contain no other bounds but are contained by all non-empty bounds.

  4. abstract def get: KeyBounds[A]

    Permalink

    Returns non-empty bounds or throws NoSuchElementException

  5. abstract def include[B >: A](key: B)(implicit b: Boundable[B]): KeyBounds[B]

    Permalink

    Expand bounds to include the key or keep unchanged if it is already included

  6. abstract def includes[B >: A](key: B)(implicit b: Boundable[B]): Boolean

    Permalink

    Test if the key is included in bounds

  7. abstract def intersect[B >: A](other: Bounds[B])(implicit b: Boundable[B]): Bounds[B]

    Permalink

    Returns the intersection, if any, between two bounds

  8. abstract def isEmpty: Boolean

    Permalink

    Returns true if this is EmptyBounds

  9. abstract def productArity: Int

    Permalink
    Definition Classes
    Product
  10. abstract def productElement(n: Int): Any

    Permalink
    Definition Classes
    Product
  11. abstract def setSpatialBounds[B >: A](other: KeyBounds[SpatialKey])(implicit ev: SpatialComponent[B]): Bounds[B]

    Permalink

    Updates the spatial region of bounds to match that of the argument, leaving other dimensions, if any, unchanged.

  12. abstract def toOption: Option[KeyBounds[A]]

    Permalink

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def flatMap[B](f: (KeyBounds[A]) ⇒ Bounds[B]): Bounds[B]

    Permalink

    Returns the result of applying f to this Bounds minKey and maxKey if this it is nonempty.

    Returns the result of applying f to this Bounds minKey and maxKey if this it is nonempty. The minKey and maxKeys are given as instance of KeyBounds instead of a tuple. If this Bounds is EmptyBounds it is returned unchanged.

    Annotations
    @inline()
  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  11. def getOrElse[B >: A](default: ⇒ KeyBounds[B]): KeyBounds[B]

    Permalink

    Returns non-empty bounds or the default value

  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  13. def intersects[B >: A](other: KeyBounds[B])(implicit b: Boundable[B]): Boolean

    Permalink

    Test if two bounds for intersection

  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. def nonEmpty: Boolean

    Permalink

    Returns false if this is EmptyBounds

  17. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. def productIterator: Iterator[Any]

    Permalink
    Definition Classes
    Product
  20. def productPrefix: String

    Permalink
    Definition Classes
    Product
  21. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  22. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  23. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped