Brute Force

Source header: cuvs/neighbors/brute_force.hpp

Bruteforce index

neighbors::brute_force::index

Brute Force index.

The index stores the dataset and norms for the dataset in device memory.

1
template <typename T, typename DistT = T>
2
struct index : cuvs::neighbors::index { ... };

neighbors::brute_force::index::index

Construct an empty index.

1
index(raft::resources const& handle);

Constructs an empty index. This index will either need to be trained with build or loaded from a saved copy with deserialize

Parameters

Returns

void

Additional overload: neighbors::brute_force::index::index

Construct a brute force index from dataset

1
index(raft::resources const& res,
2
raft::host_matrix_view<const T, int64_t, raft::row_major> dataset_view,
3
std::optional<raft::device_vector<DistT, int64_t>>&& norms,
4
cuvs::distance::DistanceType metric,
5
DistT metric_arg = 0.0);

Constructs a brute force index from a dataset. This lets us precompute norms for the dataset, providing a speed benefit over doing this at query time. This index will copy the host dataset onto the device, and take ownership of any precaculated norms.

Parameters

Returns

void

Additional overload: neighbors::brute_force::index::index

Construct a brute force index from dataset

1
index(raft::resources const& res,
2
raft::device_matrix_view<const T, int64_t, raft::row_major> dataset_view,
3
std::optional<raft::device_vector<DistT, int64_t>>&& norms,
4
cuvs::distance::DistanceType metric,
5
DistT metric_arg = 0.0);

Constructs a brute force index from a dataset. This lets us precompute norms for the dataset, providing a speed benefit over doing this at query time. This index will store a non-owning reference to the dataset, but will move any norms supplied.

Parameters

Returns

void

Additional overload: neighbors::brute_force::index::index

Construct a brute force index from dataset

1
index(raft::resources const& res,
2
raft::device_matrix_view<const T, int64_t, raft::row_major> dataset_view,
3
std::optional<raft::device_vector_view<const DistT, int64_t>> norms_view,
4
cuvs::distance::DistanceType metric,
5
DistT metric_arg = 0.0);

This class stores a non-owning reference to the dataset and norms. Having precomputed norms gives us a performance advantage at query time.

Parameters

Returns

void

Additional overload: neighbors::brute_force::index::index

Construct a brute force index from dataset

1
index(raft::resources const& res,
2
raft::device_matrix_view<const T, int64_t, raft::col_major> dataset_view,
3
std::optional<raft::device_vector<DistT, int64_t>>&& norms,
4
cuvs::distance::DistanceType metric,
5
DistT metric_arg = 0.0);

Constructs a brute force index from a dataset. This lets us precompute norms for the dataset, providing a speed benefit over doing this at query time. This index will store a non-owning reference to the dataset, but will move any norms supplied.

Parameters

Returns

void

Additional overload: neighbors::brute_force::index::index

Construct a brute force index from dataset

1
index(raft::resources const& res,
2
raft::device_matrix_view<const T, int64_t, raft::col_major> dataset_view,
3
std::optional<raft::device_vector_view<const DistT, int64_t>> norms_view,
4
cuvs::distance::DistanceType metric,
5
DistT metric_arg = 0.0);

This class stores a non-owning reference to the dataset and norms, with the dataset being supplied on device in a col_major format

Parameters

Returns

void

neighbors::brute_force::index::update_dataset

Replace the dataset with a new dataset.

1
void update_dataset(raft::resources const& res,
2
raft::device_matrix_view<const T, int64_t, raft::row_major> dataset);

Parameters

Returns

void

Additional overload: neighbors::brute_force::index::update_dataset

Replace the dataset with a new dataset.

1
void update_dataset(raft::resources const& res,
2
raft::host_matrix_view<const T, int64_t, raft::row_major> dataset);

We create a copy of the dataset on the device. The index manages the lifetime of this copy.

Parameters

Returns

void

neighbors::brute_force::index::metric

Distance metric used for retrieval

1
cuvs::distance::DistanceType metric() const noexcept;

Returns

cuvs::distance::DistanceType

neighbors::brute_force::index::metric_arg

Metric argument

1
DistT metric_arg() const noexcept;

Returns

DistT

neighbors::brute_force::index::size

Total length of the index (number of vectors).

1
size_t size() const noexcept;

Returns

size_t

neighbors::brute_force::index::dim

Dimensionality of the data.

1
size_t dim() const noexcept;

Returns

size_t

neighbors::brute_force::index::dataset

Dataset [size, dim]

1
raft::device_matrix_view<const T, int64_t, raft::row_major> dataset() const noexcept;

Returns

raft::device_matrix_view<const T, int64_t, raft::row_major>

neighbors::brute_force::index::norms

Dataset norms

1
raft::device_vector_view<const DistT, int64_t, raft::row_major> norms() const;

Returns

raft::device_vector_view<const DistT, int64_t, raft::row_major>

neighbors::brute_force::index::has_norms

Whether ot not this index has dataset norms

1
inline bool has_norms() const noexcept;

Returns

inline bool

Bruteforce index build

neighbors::brute_force::build

Build the index from the dataset for efficient search.

1
auto build(raft::resources const& handle,
2
const cuvs::neighbors::brute_force::index_params& index_params,
3
raft::device_matrix_view<const float, int64_t, raft::row_major> dataset)
4
-> cuvs::neighbors::brute_force::index<float, float>;

Usage example:

Parameters

Returns

cuvs::neighbors::brute_force::index<float, float>

Additional overload: neighbors::brute_force::build

Build the index from the dataset for efficient search.

1
auto build(raft::resources const& handle,
2
const cuvs::neighbors::brute_force::index_params& index_params,
3
raft::host_matrix_view<const float, int64_t, raft::row_major> dataset)
4
-> cuvs::neighbors::brute_force::index<float, float>;

Parameters

Returns

cuvs::neighbors::brute_force::index<float, float>

Additional overload: neighbors::brute_force::build

Build the index from the dataset for efficient search.

1
auto build(raft::resources const& handle,
2
const cuvs::neighbors::brute_force::index_params& index_params,
3
raft::device_matrix_view<const half, int64_t, raft::row_major> dataset)
4
-> cuvs::neighbors::brute_force::index<half, float>;

Usage example:

Parameters

Returns

cuvs::neighbors::brute_force::index<half, float>

Additional overload: neighbors::brute_force::build

Build the index from the dataset for efficient search.

1
auto build(raft::resources const& handle,
2
const cuvs::neighbors::brute_force::index_params& index_params,
3
raft::host_matrix_view<const half, int64_t, raft::row_major> dataset)
4
-> cuvs::neighbors::brute_force::index<half, float>;

Parameters

Returns

cuvs::neighbors::brute_force::index<half, float>

Additional overload: neighbors::brute_force::build

Build the index from the dataset for efficient search.

1
auto build(raft::resources const& handle,
2
const cuvs::neighbors::brute_force::index_params& index_params,
3
raft::device_matrix_view<const float, int64_t, raft::col_major> dataset)
4
-> cuvs::neighbors::brute_force::index<float, float>;

Usage example:

Parameters

Returns

cuvs::neighbors::brute_force::index<float, float>

Additional overload: neighbors::brute_force::build

Build the index from the dataset for efficient search.

1
auto build(raft::resources const& handle,
2
const cuvs::neighbors::brute_force::index_params& index_params,
3
raft::device_matrix_view<const half, int64_t, raft::col_major> dataset)
4
-> cuvs::neighbors::brute_force::index<half, float>;

Usage example:

Parameters

Returns

cuvs::neighbors::brute_force::index<half, float>

Sparse Brute Force index

neighbors::brute_force::sparse_index

Sparse Brute Force index.

1
template <typename T, typename IdxT>
2
struct sparse_index { ... };

neighbors::brute_force::sparse_index::sparse_index

Construct a sparse brute force sparse_index from dataset

1
sparse_index(raft::resources const& res,
2
raft::device_csr_matrix_view<const T, IdxT, IdxT, IdxT> dataset,
3
cuvs::distance::DistanceType metric,
4
T metric_arg);

Parameters

Returns

void

neighbors::brute_force::sparse_index::metric

Distance metric used for retrieval

1
cuvs::distance::DistanceType metric() const noexcept;

Returns

cuvs::distance::DistanceType

neighbors::brute_force::sparse_index::metric_arg

Metric argument

1
T metric_arg() const noexcept;

Returns

T

Sparse Brute Force index search

neighbors::brute_force::sparse_search_params

Sparse Brute Force index search

1
struct sparse_search_params { ... };

Bruteforce index serialize functions

neighbors::brute_force::serialize

Save the index to file.

1
void serialize(raft::resources const& handle,
2
const std::string& filename,
3
const cuvs::neighbors::brute_force::index<half, float>& index,
4
bool include_dataset = true);

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

output

Template Parameters

Parameters

Returns

void

Additional overload: neighbors::brute_force::serialize

Save the index to file.

1
void serialize(raft::resources const& handle,
2
const std::string& filename,
3
const cuvs::neighbors::brute_force::index<float, float>& index,
4
bool include_dataset = true);

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

output

Template Parameters

Parameters

Returns

void

Additional overload: neighbors::brute_force::serialize

Write the index to an output stream

1
void serialize(raft::resources const& handle,
2
std::ostream& os,
3
const cuvs::neighbors::brute_force::index<half, float>& index,
4
bool include_dataset = true);

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

void

Additional overload: neighbors::brute_force::serialize

Write the index to an output stream

1
void serialize(raft::resources const& handle,
2
std::ostream& os,
3
const cuvs::neighbors::brute_force::index<float, float>& index,
4
bool include_dataset = true);

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

void

neighbors::brute_force::deserialize

Load index from file.

1
void deserialize(raft::resources const& handle,
2
const std::string& filename,
3
cuvs::neighbors::brute_force::index<half, float>* 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

void

Additional overload: neighbors::brute_force::deserialize

Load index from file.

1
void deserialize(raft::resources const& handle,
2
const std::string& filename,
3
cuvs::neighbors::brute_force::index<float, float>* 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

void

Additional overload: neighbors::brute_force::deserialize

Load index from input stream

1
void deserialize(raft::resources const& handle,
2
std::istream& is,
3
cuvs::neighbors::brute_force::index<half, float>* 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

void

Additional overload: neighbors::brute_force::deserialize

Load index from input stream

1
void deserialize(raft::resources const& handle,
2
std::istream& is,
3
cuvs::neighbors::brute_force::index<float, float>* 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

void