search_with_masks

void search_with_masks(Index::idx_t n, const float *x, Index::idx_t k, float *distances, Index::idx_t *labels, const void *mask) const

Queries the feature vectors for AscendIndexSQ and returns IDs of the most similar k features based on the input feature vectors. The mask is a bit string consisting of 0 and 1. Each bit indicates whether the feature of the corresponding sequence in the base library is involved in distance calculation. 1 indicates that it is involved, and 0 indicates that it is not involved.

idx_t n: number of feature vectors to be queried.

const float *x: feature vector data.

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

const void *mask: feature base library mask

float *distances: distance between a vector and the first k nearest vectors.

idx_t *labels: IDs of the first k nearest vectors that are queried.

N/A

• The value of n cannot be greater than 1e9.
• The value of k cannot be greater than 1024.
• The x must be a non-null pointer with a length of dim x n. Otherwise, an out-of-bounds read/write error may occur, causing program breakdown.
• The distances and labels must be non-null pointers with a length of k x n. Otherwise, an out-of-bounds read/write error may occur, causing program breakdown.
• The mask must be a non-null pointer with a length of ceil(n/8). Otherwise, an out-of-bounds read/write error may occur, causing program breakdown.