Brute Force

Source header: cuvs/neighbors/brute_force.h

Bruteforce index

cuvsBruteForceIndex

Struct to hold address of cuvs::neighbors::brute_force::index and its active trained dtype

1
typedef struct {
2
  uintptr_t addr;
3
  DLDataType dtype;
4
} cuvsBruteForceIndex;

Fields

cuvsBruteForceIndexCreate

Allocate BRUTEFORCE index

1
cuvsError_t cuvsBruteForceIndexCreate(cuvsBruteForceIndex_t* index);

Parameters

Returns

cuvsError_t

cuvsBruteForceIndexDestroy

De-allocate BRUTEFORCE index

1
cuvsError_t cuvsBruteForceIndexDestroy(cuvsBruteForceIndex_t index);

Parameters

Returns

cuvsError_t

Bruteforce index build

cuvsBruteForceBuild

Build a BRUTEFORCE index with a DLManagedTensor which has underlying DLDeviceType equal to kDLCUDA, kDLCUDAHost, kDLCUDAManaged, or kDLCPU. Also, acceptable underlying types are:

1. kDLDataType.code == kDLFloat and kDLDataType.bits = 32
2. kDLDataType.code == kDLFloat and kDLDataType.bits = 16

1
cuvsError_t cuvsBruteForceBuild(cuvsResources_t res,
2
DLManagedTensor* dataset,
3
cuvsDistanceType metric,
4
float metric_arg,
5
cuvsBruteForceIndex_t index);

Parameters

Returns

cuvsError_t

Bruteforce index search

cuvsBruteForceSearch

Search a BRUTEFORCE index with a DLManagedTensor which has underlying DLDeviceType equal to kDLCUDA, kDLCUDAHost, kDLCUDAManaged. It is also important to note that the BRUTEFORCE index must have been built with the same type of queries, such that index.dtype.code == queries.dl_tensor.dtype.code Types for input are:

1. queries: kDLDataType.code == kDLFloat and kDLDataType.bits = 32 or kDLDataType.bits = 16
2. neighbors: kDLDataType.code == kDLUInt and kDLDataType.bits = 32
3. distances: kDLDataType.code == kDLFloat and kDLDataType.bits = 32

1
cuvsError_t cuvsBruteForceSearch(cuvsResources_t res,
2
cuvsBruteForceIndex_t index,
3
DLManagedTensor* queries,
4
DLManagedTensor* neighbors,
5
DLManagedTensor* distances,
6
cuvsFilter prefilter);

Parameters

Returns

cuvsError_t

BRUTEFORCE C-API serialize functions

cuvsBruteForceSerialize

Save the index to file.

1
cuvsError_t cuvsBruteForceSerialize(cuvsResources_t res,
2
const char* filename,
3
cuvsBruteForceIndex_t index);

The serialization format can be subject to changes, therefore loading an index saved with a previous version of cuvs is not guaranteed to work.

Parameters

Returns

cuvsError_t

cuvsBruteForceDeserialize

Load index from file.

1
cuvsError_t cuvsBruteForceDeserialize(cuvsResources_t res,
2
const char* filename,
3
cuvsBruteForceIndex_t index);

The serialization format can be subject to changes, therefore loading an index saved with a previous version of cuvs is not guaranteed to work.

Parameters

Returns

cuvsError_t