search

API Definition

void search(Index::idx_t n, const char *x, Index::idx_t k, float *distances, Index::idx_t *labels) const

Function

Queries the feature vectors for AscendIndexInt8 and returns the distance and IDs of the most similar k features based on the input feature vectors.

Input

idx_t n: number of feature vectors to be queried.

const char *x: feature vector data.

idx_t k: number of the most similar results to be returned.

Output

float *distances: distance between a vector and the first k nearest vectors. When the number of valid retrieval results is less than k, the remaining invalid distance is filled with 65504 or -65504 (depending on the metric).

idx_t *labels: IDs of the first k nearest vectors that are queried. If the number of valid retrieval results is less than k, the remaining invalid labels are filled with -1.

Return Value

N/A

Restrictions

  • The length of the queried feature vector data x must be dim x n, and the lengths of distances and labels must be topk x n. Otherwise, an out-of-bounds read/write error may occur, causing program breakdown.
  • The value of n is greater than 0 and less than 1e9.
  • The value of k is greater than 0 and less than 1024.