Standard R Functions for CVXR Expressions

CVXR registers methods so that standard R functions create the appropriate atoms when applied to Expression objects.

For CVXR expressions, computes the matrix/vector norm atom. For other inputs, falls through to Matrix::norm which dispatches via S4 for both Matrix and base matrix objects.

For CVXR expressions, computes the standard deviation atom (ddof=0 by default, matching CVXPY/numpy convention). For numeric inputs, falls through to sd.

For CVXR expressions, computes the variance atom (ddof=0 by default). For numeric inputs, falls through to var.

For CVXR expressions, computes the outer product of two vectors. For other inputs, falls through to outer.

For CVXR expressions, dispatches to DiagVec (vector to diagonal matrix) or DiagMat (extract diagonal from matrix), matching CVXPY's cp.diag() behavior. For other inputs, falls through to Matrix::diag which dispatches via S4 for both Matrix and base matrix objects.

Usage

norm(x, type = "2", ...)

sd(x, ...)

var(x, ...)

outer(X, Y, ...)

diag(x, nrow, ncol, names = TRUE, k = 0L)

Arguments

x: An Expression, matrix, vector, or scalar.
type: Norm type: "1", "2" (default), "I"/"i" (infinity), "F"/"f" (Frobenius).
...: For non-Expression inputs: passed to outer.
X: An Expression or numeric.
Y: An Expression or numeric.
nrow: For non-Expression: passed to Matrix::diag.
ncol: For non-Expression: passed to Matrix::diag.
names: For non-Expression: passed to Matrix::diag.
k: Integer diagonal offset for Expressions only. k = 0 (default) is the main diagonal.

Value

An Expression or numeric value.

An Expression or matrix.

An Expression, matrix, or vector.

Details

The k parameter (off-diagonal offset) is only available for Expression inputs. For the full-featured version with k on non-Expression inputs, use DiagVec or DiagMat directly.

Math group (elementwise, via S3 group generic)

abs(x): Absolute value (convex, nonneg)
exp(x): Exponential (convex, positive)
log(x): Natural logarithm (concave, domain x >= 0)
sqrt(x): Square root via power(x, 0.5) (concave)
log1p(x): log(1+x) compound expression (concave)
log2(x), log10(x): Base-2/10 logarithm
cumsum(x): Cumulative sum (affine)
cummax(x): Cumulative max (convex)
cumprod(x): Cumulative product
ceiling(x), floor(x): Round up/down (MIP)

Summary group (via S3 group generic)

sum(x): Sum all entries (affine)
max(x): Maximum entry (convex)
min(x): Minimum entry (concave)

S3 generic methods

mean(x): Arithmetic mean; pass axis/keepdims via ...
diff(x): First-order differences; also cvxr_diff

Masking wrappers

These mask the base/stats versions and dispatch on argument type:

norm(x): 2-norm; use type for "1", "I" (infinity), "F" (Frobenius)
sd(x): Standard deviation (ddof=0 for expressions)
var(x): Variance (ddof=0 for expressions)
outer(X, Y): Outer product of two vector expressions

Advanced usage

For axis-aware reductions, keepdims, or other options not available through the standard interface, use the explicit functions: cvxr_norm, cvxr_mean, cvxr_diff, cvxr_std, cvxr_var, cvxr_outer.