core/org.gnit.lucenekmp.codecs/MutablePointTree

MutablePointTree

abstract class MutablePointTree : PointValues.PointTree

One leaf PointTree whose order of points can be changed. This class is useful for codecs to optimize flush.

Properties

maxPackedValue

open override val maxPackedValue: ByteArray

Return the maximum packed value of the current node.

minPackedValue

open override val minPackedValue: ByteArray

Return the minimum packed value of the current node.

Functions

clone

open override fun clone(): PointValues.PointTree

Clone, the current node becomes the root of the new tree.

getByteAt

abstract fun getByteAt(i: Int, k: Int): Byte

Get the k-th byte of the i-th value.

getDocID

abstract fun getDocID(i: Int): Int

Return the doc ID of the i-th value.

getValue

abstract fun getValue(i: Int, packedValue: BytesRef)

Set packedValue with a reference to the packed bytes of the i-th value.

moveToChild

open override fun moveToChild(): Boolean

Move to the first child node and return true upon success. Returns false for leaf nodes and true otherwise.

moveToParent

open override fun moveToParent(): Boolean

Move to the parent node and return true upon success. Returns false for the root node and true otherwise.

moveToSibling

open override fun moveToSibling(): Boolean

Move to the next sibling node and return true upon success. Returns false if the current node has no more siblings.

restore

abstract fun restore(i: Int, j: Int)

Restore values between i-th and j-th(excluding) in temporary storage into original storage.

save

abstract fun save(i: Int, j: Int)

Save the i-th value into the j-th position in temporary storage.

size

abstract fun size(): Long

Return the number of points below the current node.

swap

abstract fun swap(i: Int, j: Int)

Swap the i-th and j-th values.

visitDocIDs

open override fun visitDocIDs(visitor: PointValues.IntersectVisitor)

Visit all the docs below the current node.

visitDocValues

abstract fun visitDocValues(visitor: PointValues.IntersectVisitor)

Visit all the docs and values below the current node.