R/AllClasses.R

In LTLA/BiocNeighbors: Nearest Neighbor Detection for Bioconductor Packages

# Defines the BiocNeighborParam class and derivatives.

#' @export
setClass("BiocNeighborParam", contains="VIRTUAL", slots=c(distance="character"))

#' @export
setClass("ExhaustiveParam", contains="BiocNeighborParam")

#' @export
setClass("KmknnParam", contains="BiocNeighborParam")

#' @export
setClass("VptreeParam", contains="BiocNeighborParam")

#' @export
setClass("AnnoyParam", contains="BiocNeighborParam", slots=c(ntrees="integer", search.mult="numeric")) 

#' @export
setClass("HnswParam", contains="BiocNeighborParam", slots=c(nlinks="integer", ef.construction="integer", ef.search="integer")) 

#' @export
setClass("BiocNeighborIndex", contains="VIRTUAL")

#' @export
setClass("BiocNeighborGenericIndex", contains=c("VIRTUAL", "BiocNeighborIndex"), slots=c(ptr="externalptr", names="ANY"))

#' @export
setClass("ExhaustiveIndex", contains="BiocNeighborGenericIndex")

#' @export
setClass("KmknnIndex", contains="BiocNeighborGenericIndex")

#' @export
setClass("VptreeIndex", contains="BiocNeighborGenericIndex")

#' @export
setClass("AnnoyIndex", contains="BiocNeighborGenericIndex")

#' @export
setClass("HnswIndex", contains="BiocNeighborGenericIndex")