dual_power
(class from pyomo.core.kernel.conic
)
- class pyomo.core.kernel.conic.dual_power(r1, r2, x, alpha)[source]
Bases:
_ConicBase
A dual power conic constraint of the form:
\[sqrt(x[0]^2 + ... + x[n-1]^2) <= ((r1/alpha)^alpha) * ((r2/(1-alpha))^(1-alpha))\]which is recognized as convex for r1,r2 >= 0 and 0 < alpha < 1.
- Parameters:
r1 (
variable
) – A variable.r2 (
variable
) – A variable.x (list[
variable
]) – An iterable of variables.alpha (float,
parameter
, etc.) – A constant term.
Methods
__init__
(r1, r2, x, alpha)activate
()Activate this object.
as_domain
(r1, r2, x, alpha)Builds a conic domain.
check_convexity_conditions
([relax])Returns True if all convexity conditions for the conic constraint are satisfied.
clone
()Returns a copy of this object with the parent pointer set to
None
.Deactivate this object.
getname
([fully_qualified, name_buffer, ...])Dynamically generates a name for this object.
has_lb
()Returns
False
when the lower bound isNone
or negative infinityhas_ub
()Returns
False
when the upper bound isNone
or positive infinityto_bounded_expression
([evaluate_bounds])Attributes
The active status of this object.
alpha
The body of the constraint
The bounds of the constraint as a tuple (lb, ub)
The object's category type.
A boolean indicating whether this is an equality constraint
Get the expression on this constraint.
The value of the lower bound of the constraint
The object's local name within the context of its parent.
The expression for the lower bound of the constraint
Lower slack (body - lb).
The object's fully qualified name.
The object's parent (possibly None).
r1
r2
The right-hand side of the constraint
min(lslack, uslack).
The object's storage key within its parent
The value of the upper bound of the constraint
The expression for the upper bound of the constraint
Upper slack (ub - body).
x
Member Documentation
- activate()
Activate this object.
- classmethod as_domain(r1, r2, x, alpha)[source]
Builds a conic domain. Input arguments take the same form as those of the conic constraint, but in place of each variable, one can optionally supply a constant, linear expression, or None.
- Returns:
A block object with the core conic constraint (block.q) expressed using auxiliary variables (block.r1, block.r2, block.x) linked to the input arguments through auxiliary constraints (block.c).
- Return type:
- check_convexity_conditions(relax=False)[source]
Returns True if all convexity conditions for the conic constraint are satisfied. If relax is True, then variable domains are ignored and it is assumed that all variables are continuous.
- clone()
Returns a copy of this object with the parent pointer set to
None
.A clone is almost equivalent to deepcopy except that any categorized objects encountered that are not descendents of this object will reference the same object on the clone.
- deactivate()
Deactivate this object.
- getname(fully_qualified=False, name_buffer={}, convert=<class 'str'>, relative_to=None)
Dynamically generates a name for this object.
- Parameters:
fully_qualified (bool) – Generate a full name by iterating through all ancestor containers. Default is
False
.convert (function) – A function that converts a storage key into a string representation. Default is the built-in function str.
relative_to (object) – When generating a fully qualified name, generate the name relative to this block.
- Returns:
If a parent exists, this method returns a string representing the name of the object in the context of its parent; otherwise (if no parent exists), this method returns
None
.
- has_lb()
Returns
False
when the lower bound isNone
or negative infinity
- has_ub()
Returns
False
when the upper bound isNone
or positive infinity
- property active
The active status of this object.
- property body
The body of the constraint
- property bounds
The bounds of the constraint as a tuple (lb, ub)
- property ctype
The object’s category type.
- property equality
A boolean indicating whether this is an equality constraint
- property expr
Get the expression on this constraint.
- property lb
The value of the lower bound of the constraint
- property local_name
The object’s local name within the context of its parent. Alias for obj.getname(fully_qualified=False).
- property lower
The expression for the lower bound of the constraint
- property lslack
Lower slack (body - lb). Returns
None
if a value for the body can not be computed.
- property name
The object’s fully qualified name. Alias for obj.getname(fully_qualified=True).
- property parent
The object’s parent (possibly None).
- property rhs
The right-hand side of the constraint
- property slack
min(lslack, uslack). Returns
None
if a value for the body can not be computed.
- property storage_key
The object’s storage key within its parent
- property ub
The value of the upper bound of the constraint
- property upper
The expression for the upper bound of the constraint
- property uslack
Upper slack (ub - body). Returns
None
if a value for the body can not be computed.