sparse-arithmatic-scalar: Scalar arithmatic with sparse vectors

In sparsevctrs: Sparse Vectors for Use in Data Frames

Scalar arithmatic with sparse vectors

Description

Do Arithmatic on sparse vectors without destroying the sparsity. Note that only multiplication and division preserves the default value.

Usage

sparse_division_scalar(x, val)

sparse_multiplication_scalar(x, val)

sparse_addition_scalar(x, val)

sparse_subtraction_scalar(x, val)

Arguments

x	A sparse vector.
val	A single numeric value.

Details

No checking of the inputs are being done.

sparse_division_scalar() and sparse_multiplication_scalar() are the most used ones, as they preserve the default, which is often what you want to do.

sparse_division_scalar() always produces double vectors, regardless of whether they could be represented as integers or not. Expect when val = 1 as the input is returned unchanged, or val = NA as the input returned will be NA or the appropiate type.

Value

A sparse vector of same type.

Examples

x_sparse <- sparse_double(c(pi, 5, 0.1), c(2, 5, 10), 10)

sparse_division_scalar(x_sparse, 2)
sparse_multiplication_scalar(x_sparse, 2)
sparse_addition_scalar(x_sparse, 2)
sparse_subtraction_scalar(x_sparse, 2)

sparsevctrs documentation built on June 8, 2025, 1:48 p.m.