Skip to contents

Build an execution plan for exact search

Usage

knn_plan_bigmatrix(
  x,
  metric = "euclidean",
  memory_budget = "2GB",
  num_threads = getOption("bigKNN.num_threads", 1L),
  progress = getOption("bigKNN.progress", interactive())
)

Arguments

x

A bigmemory::big.matrix, external pointer, or prepared reference.

metric

Distance metric. Supported values are "euclidean", "sqeuclidean", and "cosine".

memory_budget

Memory budget expressed in bytes or a compact size string such as "2GB".

num_threads

Requested thread count forwarded to common BLAS/OpenMP environment variables during execution.

progress

Logical flag controlling progress reporting for plan-aware calls.

Value

An object of class "bigknn_plan".