Common

Source header: cuvs/neighbors/common.hpp

Approximate Nearest Neighbors Types

neighbors::index

The base for approximate KNN index structures.

1
struct index { ... };

neighbors::index_params

The base for KNN index parameters.

1
struct index_params { ... };

Fields

neighbors::MergeStrategy

Strategy for merging indices.

This enum is declared separately to avoid namespace pollution when including common.hpp. It provides a generic merge strategy that can be used across different index types.

1
enum class MergeStrategy { ... };

Values

Types

neighbors::dataset

Two-dimensional dataset; maybe owning, maybe compressed, maybe strided.

1
template <typename IdxT>
2
struct dataset { ... };

neighbors::vpq_dataset

VPQ compressed dataset.

The dataset is compressed using two level quantization

1. Vector Quantization
2. Product Quantization of residuals

1
template <typename MathT, typename IdxT>
2
struct vpq_dataset : public dataset<IdxT> { ... };

Fields

neighbors::ivf::list_base

Abstract base class for IVF list data.

This allows polymorphic access to list data regardless of the underlying layout.

TODO: Make this struct internal (tracking issue: https://github.com/rapidsai/cuvs/issues/1726)

1
template <typename ValueT, typename IdxT, typename SizeT = uint32_t>
2
struct list_base { ... };

neighbors::ivf::list

The data for a single IVF list.

1
template <template <typename, typename...> typename SpecT,
2
typename SizeT,
3
typename... SpecExtraArgs>
4
struct list : public list_base<typename SpecT<SizeT, SpecExtraArgs...>::value_type,
5
typename SpecT<SizeT, SpecExtraArgs...>::index_type,
6
SizeT> { ... };

Fields

Filtering for ANN Types

neighbors::filtering::FilterType

Filtering for ANN Types

1
enum class FilterType { ... };

Values

neighbors::filtering::none_sample_filter::operator

1
constexpr __forceinline__ _RAFT_HOST_DEVICE bool operator()(
2
// query index
3
const uint32_t query_ix,
4
// the current inverted list index
5
const uint32_t cluster_ix,
6
// the index of the current sample inside the current inverted list
7
const uint32_t sample_ix) const;

Returns

constexpr __forceinline__ _RAFT_HOST_DEVICE bool

neighbors::filtering::none_sample_filter::get_filter_type

1
FilterType get_filter_type() const override;

Returns

FilterType

neighbors::filtering::ivf_to_sample_filter

Filter used to convert the cluster index and sample index

of an IVF search into a sample index. This can be used as an intermediate filter.

1
template <typename index_t, typename filter_t>
2
struct ivf_to_sample_filter : public base_filter { ... };

Fields

neighbors::filtering::ivf_to_sample_filter::operator

If the original filter takes three arguments, then don’t modify the arguments.

1
inline _RAFT_HOST_DEVICE bool operator()(
2
// query index
3
const uint32_t query_ix,
4
// the current inverted list index
5
const uint32_t cluster_ix,
6
// the index of the current sample inside the current inverted list
7
const uint32_t sample_ix) const;

If the original filter takes two arguments, then we are using inds_ptr_ to obtain the sample index.

Returns

inline _RAFT_HOST_DEVICE bool

neighbors::filtering::bitmap_filter

Filter an index with a bitmap

1
template <typename bitmap_t, typename index_t>
2
struct bitmap_filter : public base_filter { ... };

Fields

neighbors::filtering::bitmap_filter::operator

1
inline _RAFT_HOST_DEVICE bool operator()(
2
// query index
3
const uint32_t query_ix,
4
// the index of the current sample
5
const uint32_t sample_ix) const;

Returns

inline _RAFT_HOST_DEVICE bool

neighbors::filtering::bitmap_filter::get_filter_type

1
FilterType get_filter_type() const override;

Returns

FilterType

neighbors::filtering::bitset_filter

Filter an index with a bitset

1
template <typename bitset_t, typename index_t>
2
struct bitset_filter : public base_filter { ... };

Fields

neighbors::filtering::bitset_filter::bitset_filter

1
_RAFT_HOST_DEVICE bitset_filter(const view_t bitset_for_filtering);

Parameters

Returns

_RAFT_HOST_DEVICE

neighbors::filtering::bitset_filter::get_filter_type

1
FilterType get_filter_type() const override;

Returns

FilterType

ANN MG index build parameters

neighbors::distribution_mode

1
enum distribution_mode { ... };

neighbors::mg_index_params

1
template <typename Upstream>
2
struct mg_index_params : public Upstream { ... };

Fields

ANN MG search parameters

neighbors::replicated_search_mode

1
enum replicated_search_mode { ... };

Values

neighbors::sharded_merge_mode

1
enum sharded_merge_mode { ... };

Values

neighbors::mg_search_params

1
template <typename Upstream>
2
struct mg_search_params : public Upstream { ... };

Fields