coop: cosine – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

cosine

Cosine Similarity

Description

Compute the cosine similarity matrix efficiently. The function syntax and behavior is largely modeled after that of the cosine() function from the lsa package, although with a very different implementation.

Usage

cosine(x, y, use = "everything", inverse = FALSE)

tcosine(x, y, use = "everything", inverse = FALSE)

Arguments

`x`	A numeric dataframe/matrix or vector.
`y`	A vector (when `x` is a vector) or missing (blank) when `x` is a matrix.
`use`	The NA handler, as in R's `cov()` and `cor()` functions. Options are "everything", "all.obs", and "complete.obs".
`inverse`	Logical; should the inverse covariance matrix be returned?

Details

See ?coop-package for implementation details.

Value

The n\times n matrix of all pair-wise vector cosine similarities of the columns.

Author(s)

Drew Schmidt

Examples

x <- matrix(rnorm(10*3), 10, 3)

coop::cosine(x)
coop::cosine(x[, 1], x[, 2])

coop

Co-Operation: Fast Covariance, Correlation, and Cosine Similarity Operations

v0.6-2

BSD 2-clause License + file LICENSE

Authors

Drew Schmidt [aut, cre], Christian Heckendorf [ctb] (Caught some memory errors.)

Initial release