ComputeDistanceByIdx

APP_ERROR ComputeDistanceByIdx(int n, const float16_t *queries, const int *num, const idx_t *indices, float *distances, unsigned int tableLen = 0, const float *table = nullptr);

与ComputeDistance类似，区别在于ComputeDistance计算待查询向量与所有底库向量的距离，而该接口ComputeDistanceByIdx 只计算待查询向量与给定下标索引的底库向量之间的距离。如传递有效的映射表（tableLen > 0且*table为非空指针），则返回映射后的topk结果。

int n：待查询特征向量的数目。

const float16_t *queries：待查询特征向量，有效长度为 n * dim，“dim”需与初始化时指定的dim保持一致。

const int *num： 给定每个query要比对的底库特征向量数目，长度为n。

const idx_t *indices：给定要比对的底库特征向量下标索引，每个query要比对的底库向量个数可以不同，应从前往后连续存储有效的向量索引，按照最大“num”补齐空间占用，“indices”长度为n * max(num)。

unsigned int tableLen：映射表长度，默认值为0，表示不做映射。目前支持配置映射表长为“10000”。

const float *table：映射表指针，指向“tableLen”长度的有效映射值存储空间，目前支持的冗余长度为“48”，即“*table”指向的空间长度为 10048 * sizeof(float) Byte。

float *distances：查询向量与选定底库向量的距离，每个query从前往后连续记录有效距离，按照最大“num”补齐空间占用，空间长度为n * max(num)。

APP_ERROR：调用返回状态，具体请参见接口调用返回值参考。

• n：取值应在 [0, capacity] 之间。
• num：由用户指定，长度为n，每个query的num值应该在[0， ntotal]之间。
• indices：每个特征的索引应该在 [0, ntotal) 之间。
• 接口参数配置举例：n = 3, num[3] = {1, 3, 5}，表示3个query分别要比对的底库向量个数，max(num) = 5，则 *indices指向空间长度按 5 对齐，总大小为 3 * 5 * sizeof(idx_t) Byte，如{ {1, 0, 0, 0, 0}, {4, 7, 9, 0, 0}, {1, 3, 4, 7, 9} }。
• 传递“TableLen”和“table”参数同时满足要求时，接口会对计算出来的distance进行映射：

  首先将distance值归一化为 [0, 1]之间的浮点数f1，然后用f1乘上“tableLen”并取整，这样得到[0, tableLen]之间的整数索引，再利用该整数索引作为偏移，去“table”指向的内存空间取出对应的 score，即完成映射，将score存入“distance” 。

  索引映射公式可抽象为((CosDistance + 1) / 2) * tableLen。

• “indices”、“queries”、“distances”和“num”需要为非空指针，且长度符合限制，否则可能出现越界读写的错误并引起程序崩溃。