CVXR: Expression-class – R documentation

Pricing

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

Get Started for Free

Documentation

CVXR

Expression-class

The Expression class.

Description

This class represents a mathematical expression.

Usage

## S4 method for signature 'Expression'
value(object)

## S4 method for signature 'Expression'
grad(object)

## S4 method for signature 'Expression'
domain(object)

## S4 method for signature 'Expression'
as.character(x)

## S4 method for signature 'Expression'
name(x)

## S4 method for signature 'Expression'
expr(object)

## S4 method for signature 'Expression'
is_constant(object)

## S4 method for signature 'Expression'
is_affine(object)

## S4 method for signature 'Expression'
is_convex(object)

## S4 method for signature 'Expression'
is_concave(object)

## S4 method for signature 'Expression'
is_dcp(object)

## S4 method for signature 'Expression'
is_log_log_constant(object)

## S4 method for signature 'Expression'
is_log_log_affine(object)

## S4 method for signature 'Expression'
is_log_log_convex(object)

## S4 method for signature 'Expression'
is_log_log_concave(object)

## S4 method for signature 'Expression'
is_dgp(object)

## S4 method for signature 'Expression'
is_hermitian(object)

## S4 method for signature 'Expression'
is_psd(object)

## S4 method for signature 'Expression'
is_nsd(object)

## S4 method for signature 'Expression'
is_quadratic(object)

## S4 method for signature 'Expression'
is_symmetric(object)

## S4 method for signature 'Expression'
is_pwl(object)

## S4 method for signature 'Expression'
is_qpwa(object)

## S4 method for signature 'Expression'
is_zero(object)

## S4 method for signature 'Expression'
is_nonneg(object)

## S4 method for signature 'Expression'
is_nonpos(object)

## S4 method for signature 'Expression'
dim(x)

## S4 method for signature 'Expression'
is_real(object)

## S4 method for signature 'Expression'
is_imag(object)

## S4 method for signature 'Expression'
is_complex(object)

## S4 method for signature 'Expression'
size(object)

## S4 method for signature 'Expression'
ndim(object)

## S4 method for signature 'Expression'
flatten(object)

## S4 method for signature 'Expression'
is_scalar(object)

## S4 method for signature 'Expression'
is_vector(object)

## S4 method for signature 'Expression'
is_matrix(object)

## S4 method for signature 'Expression'
nrow(x)

## S4 method for signature 'Expression'
ncol(x)

Arguments

x, object

An Expression object.

Methods (by generic)

value: The value of the expression.
grad: The (sub/super)-gradient of the expression with respect to each variable.
domain: A list of constraints describing the closure of the region where the expression is finite.
as.character: The string representation of the expression.
name: The name of the expression.
expr: The expression itself.
is_constant: The expression is constant if it contains no variables or is identically zero.
is_affine: The expression is affine if it is constant or both convex and concave.
is_convex: A logical value indicating whether the expression is convex.
is_concave: A logical value indicating whether the expression is concave.
is_dcp: The expression is DCP if it is convex or concave.
is_log_log_constant: Is the expression log-log constant, i.e., elementwise positive?
is_log_log_affine: Is the expression log-log affine?
is_log_log_convex: Is the expression log-log convex?
is_log_log_concave: Is the expression log-log concave?
is_dgp: The expression is DGP if it is log-log DCP.
is_hermitian: A logical value indicating whether the expression is a Hermitian matrix.
is_psd: A logical value indicating whether the expression is a positive semidefinite matrix.
is_nsd: A logical value indicating whether the expression is a negative semidefinite matrix.
is_quadratic: A logical value indicating whether the expression is quadratic.
is_symmetric: A logical value indicating whether the expression is symmetric.
is_pwl: A logical value indicating whether the expression is piecewise linear.
is_qpwa: A logical value indicating whether the expression is quadratic of piecewise affine.
is_zero: The expression is zero if it is both nonnegative and nonpositive.
is_nonneg: A logical value indicating whether the expression is nonnegative.
is_nonpos: A logical value indicating whether the expression is nonpositive.
dim: The c(row, col) dimensions of the expression.
is_real: A logical value indicating whether the expression is real.
is_imag: A logical value indicating whether the expression is imaginary.
is_complex: A logical value indicating whether the expression is complex.
size: The number of entries in the expression.
ndim: The number of dimensions of the expression.
flatten: Vectorizes the expression.
is_scalar: A logical value indicating whether the expression is a scalar.
is_vector: A logical value indicating whether the expression is a row or column vector.
is_matrix: A logical value indicating whether the expression is a matrix.
nrow: Number of rows in the expression.
ncol: Number of columns in the expression.

CVXR

Disciplined Convex Optimization

v1.0-10

Apache License 2.0 | file LICENSE

Authors

Anqi Fu [aut, cre], Balasubramanian Narasimhan [aut], David W Kang [aut], Steven Diamond [aut], John Miller [aut], Stephen Boyd [ctb], Paul Kunsberg Rosenfield [ctb]

Initial release

Expression-class

Description

Usage

Arguments

Methods (by generic)

CVXR

We don't support your browser anymore