Packages

abstract class ZN extends AnyRef

N-dimensional z-curve base class

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

Instance Constructors

  1. new ZN()

Abstract Value Members

  1. abstract def BitsPerDimension: Int
  2. abstract def Dimensions: Int
  3. abstract def MaxMask: Long
  4. abstract def TotalBits: Int
  5. abstract def combine(z: Long): Int

    Combine every (Dimensions - 1) bits to re-create a single dimension.

    Combine every (Dimensions - 1) bits to re-create a single dimension. Opposite of split.

    z

    value to combine

  6. abstract def contains(range: ZRange, value: Long): Boolean

    Is the value contained in the range.

    Is the value contained in the range. Considers user-space.

    range

    range

    value

    value to be tested

  7. abstract def overlaps(range: ZRange, value: ZRange): Boolean

    Does the value overlap with the range.

    Does the value overlap with the range. Considers user-space.

    range

    range

    value

    value to be tested

  8. abstract def split(value: Long): Long

    Insert (Dimensions - 1) zeros between each bit to create a zvalue from a single dimension.

    Insert (Dimensions - 1) zeros between each bit to create a zvalue from a single dimension. Only the first BitsPerDimension can be considered.

    value

    value to split

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  6. def contains(range: ZRange, value: ZRange): Boolean

    Is the value contained in the range.

    Is the value contained in the range. Considers user-space.

    range

    range

    value

    value to be tested

  7. def cut(r: ZRange, xd: Long, inRange: Boolean): List[ZRange]

    Cuts Z-Range in two and trims based on user space, can be used to perform augmented binary search

  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. def longestCommonPrefix(values: Long*): ZPrefix

    Calculates the longest common binary prefix between two z longs

    Calculates the longest common binary prefix between two z longs

    returns

    (common prefix, number of bits in common)

  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. def zdivide(p: Long, rmin: Long, rmax: Long): (Long, Long)

    Returns (litmax, bigmin) for the given range and point

    Returns (litmax, bigmin) for the given range and point

    p

    point

    rmin

    minimum value

    rmax

    maximum value

    returns

    (litmax, bigmin)

  23. def zranges(zbounds: Array[ZRange], precision: Int = 64, maxRanges: Option[Int] = None, maxRecurse: Option[Int] = Some(ZN.DefaultRecurse)): Seq[IndexRange]

    Calculates ranges in index space that match any of the input bounds.

    Calculates ranges in index space that match any of the input bounds. Uses breadth-first searching to allow a limit on the number of ranges returned.

    To improve performance, the following decisions have been made: uses loops instead of foreach/maps uses java queues instead of scala queues allocates initial sequences of decent size sorts once at the end before merging

    zbounds

    search space

    precision

    precision to consider, in bits (max 64)

    maxRanges

    loose cap on the number of ranges to return. A higher number of ranges will have less false positives, but require more processing.

    maxRecurse

    max levels of recursion to apply before stopping

    returns

    ranges covering the search space

  24. def zranges(zbounds: ZRange, precision: Int, maxRanges: Option[Int]): Seq[IndexRange]
  25. def zranges(zbounds: ZRange, precision: Int): Seq[IndexRange]
  26. def zranges(zbounds: ZRange): Seq[IndexRange]

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped