Trait/Object

com.github.plokhotnyuk.rtree2d.core

RTree

Related Docs: object RTree | package core

Permalink

sealed trait RTree[A] extends AnyRef

In-memory immutable r-tree with the minimal bounding rectangle (MBR).

A

a type of values being put in the tree

Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RTree
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def isEmpty: Boolean

    Permalink
  2. abstract def maxX: Float

    Permalink

    returns

    x value of the upper right point of the MBR

  3. abstract def maxY: Float

    Permalink

    returns

    y value of the upper right point of the MBR

  4. abstract def minX: Float

    Permalink

    returns

    x value of the lower left point of the MBR

  5. abstract def minY: Float

    Permalink

    returns

    y value of the lower left point of the MBR

  6. abstract def nearest(x: Float, y: Float, maxDist: Float = Float.PositiveInfinity)(f: (Float, RTreeEntry[A]) ⇒ Float)(implicit distCalc: DistanceCalculator): Float

    Permalink

    Returns a distance to the nearest R-tree entry for the given point.

    Returns a distance to the nearest R-tree entry for the given point.

    Search distance can be limited by the maxDist parameter.

    x

    x value of the given point

    y

    y value of the given point

    maxDist

    an exclusive limit of the distance (infinity by default)

    f

    the function that receives found values and their distances and returns the current maximum distance

    distCalc

    a distance calculator provided according to geometry of indexed entries

    returns

    the distance to a found entry or initially submitted value of maxDist

  7. abstract def pretty(sb: StringBuilder, indent: Int): StringBuilder

    Permalink

    Appends a prettified string representation of the r-tree.

    Appends a prettified string representation of the r-tree.

    sb

    a string builder to append to

    indent

    a size of indent step for each level or 0 if indenting is not required

    returns

    the provided string builder

  8. abstract def search(minX: Float, minY: Float, maxX: Float, maxY: Float)(f: (RTreeEntry[A]) ⇒ Unit): Unit

    Permalink

    Call the provided f function with entries whose MBR intersects with the given point.

    Call the provided f function with entries whose MBR intersects with the given point.

    minX

    x value of the lower left point of the given rectangle

    minY

    y value of the lower left point of the given rectangle

    maxX

    x value of the upper right point of the given rectangle

    maxY

    y value of the upper right point of the given rectangle

    f

    the function that receives found values

  9. abstract def search(x: Float, y: Float)(f: (RTreeEntry[A]) ⇒ Unit): Unit

    Permalink

    Call the provided f function with entries whose MBR contains the given point.

    Call the provided f function with entries whose MBR contains the given point.

    x

    x value of the given point

    y

    y value of the given point

    f

    the function that receives found values

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. def entries: IndexedSeq[RTreeEntry[A]]

    Permalink

    returns

    a sequence of all entries

  7. final def eq(arg0: AnyRef): Boolean

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  11. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  12. final def isInstanceOf[T0]: Boolean

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

    Permalink
    Definition Classes
    AnyRef
  14. def nearestK(x: Float, y: Float, k: Int, maxDist: Float = Float.PositiveInfinity)(implicit distCalc: DistanceCalculator): IndexedSeq[RTreeEntry[A]]

    Permalink

    Returns a sequence of up to the specified number of nearest R-tree entries for the given point.

    Returns a sequence of up to the specified number of nearest R-tree entries for the given point.

    Search distance can be limited by the maxDist parameter.

    x

    x value of the given point

    y

    y value of the given point

    k

    a maximum number of nearest entries to collect

    maxDist

    an exclusive limit of the distance (infinity by default)

    distCalc

    a distance calculator provided according to geometry of indexed entries

    returns

    a sequence of the nearest entries

  15. def nearestOption(x: Float, y: Float, maxDist: Float = Float.PositiveInfinity)(implicit distCalc: DistanceCalculator): Option[RTreeEntry[A]]

    Permalink

    Returns an option of the nearest R-tree entry for the given point.

    Returns an option of the nearest R-tree entry for the given point.

    Search distance can be limited by the maxDist parameter.

    x

    x value of the given point

    y

    y value of the given point

    maxDist

    an exclusive limit of the distance (infinity by default)

    distCalc

    a distance calculator provided according to geometry of indexed entries

    returns

    an option of the nearest entry

  16. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  18. def searchAll(minX: Float, minY: Float, maxX: Float, maxY: Float): IndexedSeq[RTreeEntry[A]]

    Permalink

    Returns a sequence of all entries in the R-tree whose MBR intersects the given rectangle.

    Returns a sequence of all entries in the R-tree whose MBR intersects the given rectangle.

    minX

    x value of the lower left point of the given rectangle

    minY

    y value of the lower left point of the given rectangle

    maxX

    x value of the upper right point of the given rectangle

    maxY

    y value of the upper right point of the given rectangle

    returns

    a sequence of found values

  19. def searchAll(x: Float, y: Float): IndexedSeq[RTreeEntry[A]]

    Permalink

    Returns a sequence of all entries in the R-tree whose MBR contains the given point.

    Returns a sequence of all entries in the R-tree whose MBR contains the given point.

    x

    x value of the given point

    y

    y value of the given point

    returns

    a sequence of found values

  20. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink

    returns

    a prettified string representation of the r-tree

    Definition Classes
    RTree → AnyRef → Any
  22. final def wait(): Unit

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped