SetOf

(class from pyomo.core.base.set)

class pyomo.core.base.set.SetOf(*args, **kwds)[source]

Bases: SetData, Component

__init__(reference, **kwds)[source]

Methods

`__init__`(reference, **kwds)
`bounds`()
`check_values`()	DEPRECATED.
`clear_suffix_value`(suffix_or_name[, expand])	Set the suffix value for this component data
`cname`(args, *kwds)	DEPRECATED.
`construct`([data])	API definition for constructing components
`cross`(*args)	Return the cross-product between this set and one or more sets
`difference`(*args)	Return the difference between this set with one or more sets
`display`([ostream, verbose, prefix])
`get`(value[, default])
`get_interval`()	Return the interval for this Set as (start, end, step)
`get_suffix_value`(suffix_or_name[, default])	Get the suffix value for this component data
`getname`([fully_qualified, name_buffer, ...])	Return a string with the component name and index
`index`()	Returns the index of this ComponentData instance relative to the parent component index set.
`intersection`(*args)	Return the intersection of this set with one or more sets
`is_component_type`()	Return True if this class is a Pyomo component
`is_constructed`()	Return True if this class has been constructed
`is_expression_type`([expression_system])	Return True if this numeric value is an expression
`is_indexed`()	Return true if this component is indexed
`is_logical_type`()	Return True if this class is a Pyomo Boolean object.
`is_named_expression_type`()	Return True if this numeric value is a named expression
`is_numeric_type`()	Return True if this class is a Pyomo numeric object
`is_parameter_type`()	Return False unless this class is a parameter object
`is_reference`()	Return True if this object is a reference.
`is_variable_type`()	Return False unless this class is a variable object
`isdiscrete`()	Returns True if this set admits only discrete members
`isdisjoint`(other)	Test if this Set is disjoint from other
`isfinite`()	Returns True if this is a finite discrete (iterable) Set
`isordered`()	Returns True if this is an ordered finite discrete (iterable) Set
`issubset`(other)	Test if this Set is a subset of other
`issuperset`(other)	Test if this Set is a superset of other
`model`()	Return the model of the component that owns this data.
`parent_block`()	Return the parent of the component that owns this data.
`parent_component`()	Returns the component associated with this object.
`pprint`([ostream, verbose, prefix])	Print component information
`ranges`()
`reconstruct`([data])	REMOVED: reconstruct() was removed in Pyomo 6.0.
`root_block`()	Return self.model()
`set_suffix_value`(suffix_or_name, value[, expand])	Set the suffix value for this component data
`subsets`([expand_all_set_operators])
`symmetric_difference`(other)	Return the symmetric difference of this set with another set
`type`()	DEPRECATED.
`union`(*args)	Return the union of this set with one or more sets.
`valid_model_component`()	Return True if this can be used as a model component.

Attributes

`active`	Return the active attribute
`concrete`	DEPRECATED.
`ctype`	Return the class type for this component
`dimen`
`domain`
`filter`	DEPRECATED.
`local_name`	Get the component name only within the context of the immediate parent container.
`name`	Get the fully qualified component name.
`ordered`	DEPRECATED.
`virtual`	DEPRECATED.

Member Documentation

check_values()

DEPRECATED.

Verify that the values in this set are valid.

Deprecated since version 5.7: check_values() is deprecated: Sets only contain valid members

clear_suffix_value(suffix_or_name, expand=True): Set the suffix value for this component data

cname(*args, **kwds): DEPRECATED.

Deprecated since version 5.0: The cname() method has been renamed to getname(). The preferred method of obtaining a component name is to use the .name property, which returns the fully qualified component name. The .local_name property will return the component name only within the context of the immediate parent container.

construct(data=None)[source]: API definition for constructing components

cross(*args): Return the cross-product between this set and one or more sets

difference(*args): Return the difference between this set with one or more sets

get_interval()

Return the interval for this Set as (start, end, step)

Returns the effective interval for this Set as a (start, end, step) tuple. Start and End are the same as returned by bounds(). Step is 0 for continuous ranges, a positive value for regular discrete sets (e.g., 1 for Integers), or None for Sets that do not have a regular interval (e.g., semicontinuous sets, mixed type sets, sets with dimen != 1, etc).

get_suffix_value(suffix_or_name, default=None): Get the suffix value for this component data

getname(fully_qualified=False, name_buffer=None, relative_to=None): Return a string with the component name and index

index(): Returns the index of this ComponentData instance relative to the parent component index set. None is returned if this instance does not have a parent component, or if - for some unknown reason - this instance does not belong to the parent component’s index set.

intersection(*args): Return the intersection of this set with one or more sets

is_component_type(): Return True if this class is a Pyomo component

is_constructed(): Return True if this class has been constructed

is_expression_type(expression_system=None): Return True if this numeric value is an expression

is_indexed(): Return true if this component is indexed

is_logical_type()

Return True if this class is a Pyomo Boolean object.

Boolean objects include constants, variables, or logical expressions.

is_named_expression_type(): Return True if this numeric value is a named expression

is_numeric_type(): Return True if this class is a Pyomo numeric object

is_parameter_type(): Return False unless this class is a parameter object

is_reference(): Return True if this object is a reference.

is_variable_type(): Return False unless this class is a variable object

isdiscrete(): Returns True if this set admits only discrete members

isdisjoint(other)

Test if this Set is disjoint from other

Parameters:: other (Set or iterable) – The Set or iterable object to compare this Set against
Returns:: bool
Return type:: True if this set is disjoint from other

isfinite(): Returns True if this is a finite discrete (iterable) Set

isordered(): Returns True if this is an ordered finite discrete (iterable) Set

issubset(other)

Test if this Set is a subset of other

Parameters:: other (Set or iterable) – The Set or iterable object to compare this Set against
Returns:: bool
Return type:: True if this set is a subset of other

issuperset(other)

Test if this Set is a superset of other

Parameters:: other (Set or iterable) – The Set or iterable object to compare this Set against
Returns:: bool
Return type:: True if this set is a superset of other

model(): Return the model of the component that owns this data.

parent_block(): Return the parent of the component that owns this data.

parent_component(): Returns the component associated with this object.

pprint(ostream=None, verbose=False, prefix=''): Print component information

reconstruct(data=None)

REMOVED: reconstruct() was removed in Pyomo 6.0.

Re-constructing model components was fragile and did not correctly update instances of the component used in other components or contexts (this was particularly problemmatic for Var, Param, and Set). Users who wish to reproduce the old behavior of reconstruct(), are comfortable manipulating non-public interfaces, and who take the time to verify that the correct thing happens to their model can approximate the old behavior of reconstruct with:

component.clear() component._constructed = False component.construct()

root_block(): Return self.model()

set_suffix_value(suffix_or_name, value, expand=True): Set the suffix value for this component data

symmetric_difference(other): Return the symmetric difference of this set with another set

type()

DEPRECATED.

Return the class type for this component

Deprecated since version 5.7: Component.type() method has been replaced by the .ctype property.

union(*args): Return the union of this set with one or more sets.

valid_model_component(): Return True if this can be used as a model component.

property active: Return the active attribute

property concrete: DEPRECATED.

Deprecated since version 5.7: The ‘concrete’ attribute is no longer supported. Use isdiscrete() or isfinite()

property ctype: Return the class type for this component

property filter: DEPRECATED.

Deprecated since version 5.7: ‘filter’ is no longer a public attribute.

property local_name: Get the component name only within the context of the immediate parent container.

property name: Get the fully qualified component name.

property ordered: DEPRECATED.

Deprecated since version 5.7: The ‘ordered’ attribute is no longer supported. Use isordered()

property virtual: DEPRECATED.

Deprecated since version 5.7: The ‘virtual’ attribute is no longer supported