Skip to contents

Build an exact radius graph from a bigmemory::big.matrix

Usage

radius_graph_bigmatrix(
  x,
  radius,
  metric = "euclidean",
  plan = NULL,
  block_size = knn_default_block_size(),
  include_distance = TRUE,
  format = c("edge_list", "triplet", "dgCMatrix"),
  symmetrize = c("none", "union", "mutual"),
  exclude_self = TRUE,
  sort = TRUE
)

Arguments

x

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

radius

Distance threshold for including an edge.

metric

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

plan

Optional execution plan returned by knn_plan_bigmatrix().

block_size

Number of rows to process per query and reference block.

include_distance

Logical flag controlling whether graph edges store distances or unit weights.

format

Output format. One of "edge_list", "triplet", or "dgCMatrix".

symmetrize

How directed radius edges should be combined. One of "none", "union", or "mutual".

exclude_self

Logical flag controlling whether self loops are suppressed.

sort

Logical flag controlling whether each query's matches are sorted by distance and then by index.

Value

A graph representation in the requested format.