ZN - org.locationtech.sfcurve.zorder.ZN

Instance Constructors

new ZN()

Abstract Value Members

abstract def BitsPerDimension: Int
abstract def Dimensions: Int
abstract def MaxMask: Long
abstract def TotalBits: Int
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
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
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
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

final def !=(arg0: Any): Boolean

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

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

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

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
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
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
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

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

Definition Classes
AnyRef → Any
def hashCode(): Int

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

Definition Classes
Any
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)
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

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

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
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)
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
def zranges(zbounds: ZRange, precision: Int, maxRanges: Option[Int]): Seq[IndexRange]
def zranges(zbounds: ZRange, precision: Int): Seq[IndexRange]
def zranges(zbounds: ZRange): Seq[IndexRange]

ZN

Related Docs: object ZN | package zorder

abstract class ZN extends AnyRef

Instance Constructors

new ZN()

Abstract Value Members

abstract def BitsPerDimension: Int

abstract def Dimensions: Int

abstract def MaxMask: Long

abstract def TotalBits: Int

abstract def combine(z: Long): Int

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

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

abstract def split(value: Long): Long

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def contains(range: ZRange, value: ZRange): Boolean

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

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def longestCommonPrefix(values: Long*): ZPrefix

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def zdivide(p: Long, rmin: Long, rmax: Long): (Long, Long)

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

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

def zranges(zbounds: ZRange, precision: Int): Seq[IndexRange]

def zranges(zbounds: ZRange): Seq[IndexRange]

Inherited from AnyRef

Inherited from Any

Ungrouped