Constraint-class {CVXR} | R Documentation |
The Constraint class.
Description
This virtual class represents a mathematical constraint.
Usage
## S4 method for signature 'Constraint'
as.character(x)
## S4 method for signature 'Constraint'
dim(x)
## S4 method for signature 'Constraint'
size(object)
## S4 method for signature 'Constraint'
is_real(object)
## S4 method for signature 'Constraint'
is_imag(object)
## S4 method for signature 'Constraint'
is_complex(object)
## S4 method for signature 'Constraint'
is_dcp(object)
## S4 method for signature 'Constraint'
is_dgp(object)
## S4 method for signature 'Constraint'
residual(object)
## S4 method for signature 'Constraint'
violation(object)
## S4 method for signature 'Constraint'
constr_value(object, tolerance = 1e-08)
## S4 method for signature 'Constraint'
get_data(object)
## S4 method for signature 'Constraint'
dual_value(object)
## S4 replacement method for signature 'Constraint'
dual_value(object) <- value
## S4 method for signature 'ZeroConstraint'
size(object)
Arguments
x , object |
A Constraint object. |
tolerance |
The tolerance for checking if the constraint is violated. |
value |
A numeric scalar, vector, or matrix. |
Methods (by generic)
-
dim(Constraint)
: The dimensions of the constrained expression. -
size(Constraint)
: The size of the constrained expression. -
is_real(Constraint)
: Is the constraint real? -
is_imag(Constraint)
: Is the constraint imaginary? -
is_complex(Constraint)
: Is the constraint complex? -
is_dcp(Constraint)
: Is the constraint DCP? -
is_dgp(Constraint)
: Is the constraint DGP? -
residual(Constraint)
: The residual of a constraint -
violation(Constraint)
: The violation of a constraint. -
constr_value(Constraint)
: The value of a constraint. -
get_data(Constraint)
: Information needed to reconstruct the object aside from the args. -
dual_value(Constraint)
: The dual values of a constraint. -
dual_value(Constraint) <- value
: Replaces the dual values of a constraint.. -
size(ZeroConstraint)
: The size of the constrained expression.