Module org.apache.lucene.core
Package org.apache.lucene.util.bkd

Class BKDConfig

java.lang.Object
org.apache.lucene.util.bkd.BKDConfig
public final class BKDConfig extends Object
Basic parameters for indexing points on the BKD tree.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    final int
    bytesPerDim
    How many bytes each value in each dimension takes.
    final int
    bytesPerDoc
    packedBytesLength plus docID size
    static final int
    DEFAULT_MAX_POINTS_IN_LEAF_NODE
    Default maximum number of point in each leaf block
    static final int
    MAX_DIMS
    Maximum number of index dimensions (2 * max index dimensions)
    static final int
    MAX_INDEX_DIMS
    Maximum number of index dimensions
    final int
    maxPointsInLeafNode
    max points allowed on a Leaf block
    final int
    numDims
    How many dimensions we are storing at the leaf (data) nodes
    final int
    numIndexDims
    How many dimensions we are indexing in the internal nodes
    final int
    packedBytesLength
    numDataDims * bytesPerDim
    final int
    packedIndexBytesLength
    numIndexDims * bytesPerDim

  • Constructor Summary

    Constructors
    Constructor
    Description
    BKDConfig(int numDims, int numIndexDims, int bytesPerDim, int maxPointsInLeafNode)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    private static void
    verifyParams(int numDims, int numIndexDims, int bytesPerDim, int maxPointsInLeafNode)
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • DEFAULT_MAX_POINTS_IN_LEAF_NODE

      public static final int DEFAULT_MAX_POINTS_IN_LEAF_NODE
      Default maximum number of point in each leaf block
      See Also:

    • MAX_DIMS

      public static final int MAX_DIMS
      Maximum number of index dimensions (2 * max index dimensions)
      See Also:

    • MAX_INDEX_DIMS

      public static final int MAX_INDEX_DIMS
      Maximum number of index dimensions
      See Also:

    • numDims

      public final int numDims
      How many dimensions we are storing at the leaf (data) nodes

    • numIndexDims

      public final int numIndexDims
      How many dimensions we are indexing in the internal nodes

    • bytesPerDim

      public final int bytesPerDim
      How many bytes each value in each dimension takes.

    • maxPointsInLeafNode

      public final int maxPointsInLeafNode
      max points allowed on a Leaf block

    • packedBytesLength

      public final int packedBytesLength
      numDataDims * bytesPerDim

    • packedIndexBytesLength

      public final int packedIndexBytesLength
      numIndexDims * bytesPerDim

    • bytesPerDoc

      public final int bytesPerDoc
      packedBytesLength plus docID size

  • Constructor Details

    • BKDConfig

      public BKDConfig(int numDims, int numIndexDims, int bytesPerDim, int maxPointsInLeafNode)

  • Method Details

    • verifyParams

      private static void verifyParams(int numDims, int numIndexDims, int bytesPerDim, int maxPointsInLeafNode)