Package org.apache.lucene.util.bkd

Block KD-tree, implementing the generic spatial data structure described in this paper.

Interface Summary

Interface	Description
BKDUtil.ByteArrayPredicate	Predicate for a fixed number of bytes.
BKDWriter.BKDTreeLeafNodes	flat representation of a kd-tree
PointReader	One pass iterator through all points previously written with a PointWriter, abstracting away whether points are read from (offline) disk or simple arrays in heap.
PointValue	Represents a dimensional point value written in the BKD tree.
PointWriter	Appends many points, and then at the end provides a PointReader to iterate those points.

Class Summary

Class	Description
BKDConfig	Basic parameters for indexing points on the BKD tree.
BKDRadixSelector	Offline Radix selector for BKD tree.
BKDRadixSelector.PathSlice	Sliced reference to points in an PointWriter.
BKDReader	Handles reading a block KD-tree in byte[] space previously written with BKDWriter.
BKDReader.BKDPointTree
BKDReader.BKDReaderDocIDSetIterator	Reusable DocIdSetIterator to handle low cardinality leaves.
BKDUtil	Utility functions to build BKD trees.
BKDWriter	Recursively builds a block KD-tree to assign all incoming points in N-dim space to smaller and smaller N-dim rectangles (cells) until the number of points in a given rectangle is <= config.maxPointsInLeafNode.
BKDWriter.BKDMergeQueue
BKDWriter.MergeIntersectsVisitor
BKDWriter.MergeReader
DocIdsWriter
HeapPointReader	Utility class to read buffered points from in-heap arrays.
HeapPointReader.HeapPointValue	Reusable implementation for a point value on-heap
HeapPointWriter	Utility class to write new points into in-heap arrays.
MutablePointTreeReaderUtils	Utility APIs for sorting and partitioning buffered points.
OfflinePointReader	Reads points from disk in a fixed-with format, previously written with OfflinePointWriter.
OfflinePointReader.OfflinePointValue	Reusable implementation for a point value offline
OfflinePointWriter	Writes points to disk in a fixed-with format.