Package io.dingodb.common

Interface Common.CreateIvfPqParamOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Common.CreateIvfPqParam, Common.CreateIvfPqParam.Builder
Enclosing class:
Common
public static interface Common.CreateIvfPqParamOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getBucketInitSize()
    Inverted list (IVF) bucket initialization size default 1000 optional
    int
    getBucketMaxSize()
    Inverted list (IVF) bucket maximum capacity default 1280000 optional
    int
    getDimension()
    dimensions required
    Common.MetricType
    getMetricType()
    distance calculation method (L2 or InnerProduct) required
    int
    getMetricTypeValue()
    distance calculation method (L2 or InnerProduct) required
    int
    getNbitsPerIdx()
    bit number of sub cluster center.
    int
    getNcentroids()
    Number of cluster centers Default 2048 required
    int
    getNsubvector()
    PQ split sub-vector size default 64 required

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getDimension

      int getDimension()
       dimensions required
      uint32 dimension = 1;
      Returns:
      The dimension.

    • getMetricTypeValue

      int getMetricTypeValue()
       distance calculation method (L2 or InnerProduct) required
      .dingodb.pb.common.MetricType metric_type = 2;
      Returns:
      The enum numeric value on the wire for metricType.

    • getMetricType

      Common.MetricType getMetricType()
       distance calculation method (L2 or InnerProduct) required
      .dingodb.pb.common.MetricType metric_type = 2;
      Returns:
      The metricType.

    • getNcentroids

      int getNcentroids()
       Number of cluster centers Default 2048 required
      int32 ncentroids = 3;
      Returns:
      The ncentroids.

    • getNsubvector

      int getNsubvector()
       PQ split sub-vector size default 64 required
      int32 nsubvector = 4;
      Returns:
      The nsubvector.

    • getBucketInitSize

      int getBucketInitSize()
       Inverted list (IVF) bucket initialization size default 1000 optional
      int32 bucket_init_size = 5;
      Returns:
      The bucketInitSize.

    • getBucketMaxSize

      int getBucketMaxSize()
       Inverted list (IVF) bucket maximum capacity default 1280000 optional
      int32 bucket_max_size = 6;
      Returns:
      The bucketMaxSize.

    • getNbitsPerIdx

      int getNbitsPerIdx()
       bit number of sub cluster center. default 8 required.  means 256.
      int32 nbits_per_idx = 7;
      Returns:
      The nbitsPerIdx.