sos
(class from pyomo.core.kernel.sos
)
- class pyomo.core.kernel.sos.sos(variables, weights=None, level=1)[source]
Bases:
ISOS
A Special Ordered Set of type n.
Methods
__init__
(variables[, weights, level])activate
()Activate this object.
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.
items
()Iterator over the sos variables and weights as tuples
Attributes
The active status of this object.
The object's category type.
The sos level (e.g., 1,2,...)
The object's local name within the context of its parent.
The object's fully qualified name.
The object's parent (possibly None).
The object's storage key within its parent
The sos variables
The sos variables
Member Documentation
- activate()
Activate this object.
- 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
.
- items()
Iterator over the sos variables and weights as tuples
- property active
The active status of this object.
- property ctype
The object’s category type.
- property level
The sos level (e.g., 1,2,…)
- property local_name
The object’s local name within the context of its parent. Alias for obj.getname(fully_qualified=False).
- property name
The object’s fully qualified name. Alias for obj.getname(fully_qualified=True).
- property parent
The object’s parent (possibly None).
- property storage_key
The object’s storage key within its parent
- property variables
The sos variables
- property weights
The sos variables