Skip to navigation

Dataset

View as Markdown

Source header: cuvs/core/dataset.h

Types

cuvsDatasetLayout_t

Generic dataset layout kind for C API dataset handles.

typedef enum {
CUVS_DATASET_LAYOUT_STANDARD = 0,
CUVS_DATASET_LAYOUT_PADDED = 1,
CUVS_DATASET_LAYOUT_PQ = 2,
CUVS_DATASET_LAYOUT_BBQ = 3
} cuvsDatasetLayout_t;

Values

NameValue
CUVS_DATASET_LAYOUT_STANDARD0
CUVS_DATASET_LAYOUT_PADDED1
CUVS_DATASET_LAYOUT_PQ2
CUVS_DATASET_LAYOUT_BBQ3

cuvsDatasetMemType_t

Memory space holding a C API dataset handle’s data.

typedef enum {
CUVS_DATASET_MEM_TYPE_HOST = 0,
CUVS_DATASET_MEM_TYPE_DEVICE = 1
} cuvsDatasetMemType_t;

Values

NameValue
CUVS_DATASET_MEM_TYPE_HOST0
CUVS_DATASET_MEM_TYPE_DEVICE1

destroy_addr

Dataset handle representing owning storage or a non-owning view.

addr points to C++ dataset storage or view metadata managed by the C API. mem_type identifies the memory space, layout identifies the data layout, and is_owning indicates whether the handle owns its backing data.

typedef struct {
uintptr_t addr;
DLDataType dtype;
cuvsDatasetMemType_t mem_type;
cuvsDatasetLayout_t layout;
bool is_owning;
} cuvsDataset;

Fields

NameTypeDescription
addruintptr_t
dtypeDLDataType
mem_typecuvsDatasetMemType_t
layoutcuvsDatasetLayout_t
is_owningbool

cuvsCagraCompressionParams_t

Compatibility name for PQ dataset parameters; planned for removal in the 27.02 ABI-breaking release.

typedef struct cuvsCagraCompressionParams* cuvsCagraCompressionParams_t;