Brute Force Module

View as Markdown

Rust module: cuvs::brute_force

Source: rust/cuvs/src/brute_force.rs

Brute Force KNN

Index

1#[derive(Debug)]
2pub struct Index { ... }

Brute Force KNN Index

Methods

NameSource
buildrust/cuvs/src/brute_force.rs:32
newrust/cuvs/src/brute_force.rs:54
searchrust/cuvs/src/brute_force.rs:70

build

1pub fn build<T: Into<ManagedTensor>>(
2res: &Resources,
3metric: DistanceType,
4metric_arg: Option<f32>,
5dataset: T,
6) -> Result<Index> { ... }

Builds a new Brute Force KNN Index from the dataset for efficient search.

Arguments

  • res - Resources to use
  • metric - DistanceType to use for building the index
  • metric_arg - Optional value of p for Minkowski distances
  • dataset - A row-major matrix on either the host or device to index

Source: rust/cuvs/src/brute_force.rs:32

new

1pub fn new() -> Result<Index> { ... }

Creates a new empty index

Source: rust/cuvs/src/brute_force.rs:54

1pub fn search(
2&self,
3res: &Resources,
4queries: &ManagedTensor,
5neighbors: &ManagedTensor,
6distances: &ManagedTensor,
7) -> Result<()> { ... }

Perform a Nearest Neighbors search on the Index

Arguments

  • res - Resources to use
  • queries - A matrix in device memory to query for
  • neighbors - Matrix in device memory that receives the indices of the nearest neighbors
  • distances - Matrix in device memory that receives the distances of the nearest neighbors

Source: rust/cuvs/src/brute_force.rs:70

Source: rust/cuvs/src/brute_force.rs:16