CVXR (version 1.0)

Constant-class: The Constant class.

Description

This class represents a constant.

Coerce an R object or expression into the '>Constant class.

Usage

Constant(value)
# S4 method for Constant
show(object)
# S4 method for Constant
name(x)
# S4 method for Constant
constants(object)
# S4 method for Constant
value(object)
# S4 method for Constant
is_pos(object)
# S4 method for Constant
grad(object)
# S4 method for Constant
dim(x)
# S4 method for Constant
canonicalize(object)
# S4 method for Constant
is_nonneg(object)
# S4 method for Constant
is_nonpos(object)
# S4 method for Constant
is_imag(object)
# S4 method for Constant
is_complex(object)
# S4 method for Constant
is_symmetric(object)
# S4 method for Constant
is_hermitian(object)
# S4 method for Constant
is_psd(object)
# S4 method for Constant
is_nsd(object)
as.Constant(expr)

Arguments

value

A numeric element, vector, matrix, or data.frame. Vectors are automatically cast into a matrix column.

x, object

A '>Constant object.

expr

An '>Expression, numeric element, vector, matrix, or data.frame.

Value

A '>Constant representing the input as a constant.

Methods (by generic)

• name: The name of the constant.

• constants: Returns itself as a constant.

• value: The value of the constant.

• is_pos: A logical value indicating whether all elements of the constant are positive.

• grad: An empty list since the gradient of a constant is zero.

• dim: The c(row, col) dimensions of the constant.

• canonicalize: The canonical form of the constant.

• is_nonneg: A logical value indicating whether all elements of the constant are non-negative.

• is_nonpos: A logical value indicating whether all elements of the constant are non-positive.

• is_imag: A logical value indicating whether the constant is imaginary.

• is_complex: A logical value indicating whether the constant is complex-valued.

• is_symmetric: A logical value indicating whether the constant is symmetric.

• is_hermitian: A logical value indicating whether the constant is a Hermitian matrix.

• is_psd: A logical value indicating whether the constant is a positive semidefinite matrix.

• is_nsd: A logical value indicating whether the constant is a negative semidefinite matrix.

Slots

value

A numeric element, vector, matrix, or data.frame. Vectors are automatically cast into a matrix column.

sparse

(Internal) A logical value indicating whether the value is a sparse matrix.

is_pos

(Internal) A logical value indicating whether all elements are non-negative.

is_neg

(Internal) A logical value indicating whether all elements are non-positive.

Examples

# NOT RUN {
x <- Constant(5)
y <- Constant(diag(3))
get_data(y)
value(y)
is_nonneg(y)
size(y)
as.Constant(y)
# }