SetOf

(类来自 pyomo.core.base.set)

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

基础类：SetData, Component

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

方法

`__init__`(reference, **kwds)
`bounds`()
`check_values`()	已弃用。
`clear_suffix_value`(suffix_or_name[, expand])	设置此组件数据的后缀值
`cname`(args, *kwds)	已弃用。
`construct`([data])	用于构建组件的API定义
`cross`(*args)	返回此集合与一个或多个集合之间的笛卡尔积
`difference`(*args)	返回此集合与一个或多个集合之间的差异
`display`([ostream, verbose, prefix])
`get`(value[, default])
`get_interval`()	返回此集合的间隔为（开始，结束，步长）
`get_suffix_value`(suffix_or_name[, default])	获取此组件数据的后缀值
`getname`([fully_qualified, name_buffer, ...])	返回包含组件名称和索引的字符串
`index`()	返回此ComponentData实例相对于父组件索引集的索引。
`intersection`(*args)	返回此集合与一个或多个集合的交集
`is_component_type`()	如果此类是Pyomo组件，则返回True
`is_constructed`()	如果这个类已经被构造，则返回True
`is_expression_type`([expression_system])	如果此数值是一个表达式，则返回 True
`is_indexed`()	如果此组件已索引，则返回true
`is_logical_type`()	如果此类是Pyomo布尔对象，则返回True。
`is_named_expression_type`()	如果此数值是一个命名表达式，则返回 True
`is_numeric_type`()	如果此类是Pyomo数值对象，则返回True
`is_parameter_type`()	除非此类是参数对象，否则返回 False
`is_reference`()	如果此对象是引用，则返回 True。
`is_variable_type`()	除非此类是变量对象，否则返回 False
`isdiscrete`()	如果此集合仅包含离散成员，则返回 True
`isdisjoint`(other)	测试此集合是否与other不相交
`isfinite`()	如果这是一个有限离散（可迭代）集合，则返回 True
`isordered`()	如果这是一个有序的有限离散（可迭代）集合，则返回 True
`issubset`(other)	测试这个集合是否是other的子集
`issuperset`(other)	测试这个集合是否是other的超集
`model`()	返回拥有此数据的组件的模型。
`parent_block`()	返回拥有此数据的组件的父组件。
`parent_component`()	返回与此对象关联的组件。
`pprint`([ostream, verbose, prefix])	打印组件信息
`ranges`()
`reconstruct`([data])	已移除：reconstruct() 在 Pyomo 6.0 中被移除。
`root_block`()	返回 self.model()
`set_suffix_value`(suffix_or_name, value[, expand])	设置此组件数据的后缀值
`subsets`([expand_all_set_operators])
`symmetric_difference`(other)	返回此集合与另一个集合的对称差集
`type`()	已弃用。
`union`(*args)	返回此集合与一个或多个集合的并集。
`valid_model_component`()	如果这可以用作模型组件，则返回True。

属性

`active`	返回活动属性
`concrete`	已弃用。
`ctype`	返回此组件的类类型
`dimen`
`domain`
`filter`	已弃用。
`local_name`	仅在直接父容器的上下文中获取组件名称。
`name`	获取完全限定的组件名称。
`ordered`	已弃用。
`virtual`	已弃用。

成员文档

check_values()

已弃用。

验证此集合中的值是否有效。

自版本5.7起已弃用：check_values() 已弃用：集合仅包含有效成员

clear_suffix_value(suffix_or_name, expand=True): 设置此组件数据的后缀值

cname(*args, **kwds): 已弃用。

自版本5.0起已弃用：cname() 方法已重命名为 getname()。获取组件名称的首选方法是使用 .name 属性，该属性返回完全限定的组件名称。 .local_name 属性将仅在直接父容器的上下文中返回组件名称。

construct(data=None)[source]: 用于构建组件的API定义

cross(*args): 返回此集合与一个或多个集合之间的笛卡尔积

difference(*args): 返回此集合与一个或多个集合之间的差异

get_interval()

返回此集合的间隔为（开始，结束，步长）

返回此集合的有效区间作为一个（开始，结束，步长）元组。开始和结束与bounds()返回的相同。对于连续范围，步长为0；对于常规离散集合（例如，整数为1），步长为正值；对于没有常规间隔的集合（例如，半连续集合、混合类型集合、维度不为1的集合等），步长为None。

get_suffix_value(suffix_or_name, default=None): 获取此组件数据的后缀值

getname(fully_qualified=False, name_buffer=None, relative_to=None): 返回包含组件名称和索引的字符串

index(): 返回此ComponentData实例相对于父组件索引集的索引。如果此实例没有父组件，或者由于某些未知原因此实例不属于父组件的索引集，则返回None。

intersection(*args): 返回此集合与一个或多个集合的交集

is_component_type(): 如果此类是Pyomo组件，则返回True

is_constructed(): 如果这个类已经被构造，则返回True

is_expression_type(expression_system=None): 如果此数值是一个表达式，则返回 True

is_indexed(): 如果此组件已索引，则返回true

is_logical_type()

如果此类是Pyomo布尔对象，则返回True。

布尔对象包括常量、变量或逻辑表达式。

is_named_expression_type(): 如果此数值是一个命名表达式，则返回 True

is_numeric_type(): 如果此类是Pyomo数值对象，则返回True

is_parameter_type(): 除非此类是参数对象，否则返回 False

is_reference(): 如果此对象是引用，则返回 True。

is_variable_type(): 除非此类是变量对象，否则返回 False

isdiscrete(): 如果此集合仅包含离散成员，则返回 True

isdisjoint(other)

测试此集合是否与other不相交

Parameters:: 其他 (Set 或 iterable) – 要与此集合进行比较的集合或可迭代对象
Returns:: bool
Return type:: 如果此集合与other不相交，则为True

isfinite(): 如果这是一个有限离散（可迭代）集合，则返回 True

isordered(): 如果这是一个有序的有限离散（可迭代）集合，则返回 True

issubset(other)

测试这个集合是否是other的子集

Parameters:: 其他 (Set 或 iterable) – 要与此集合进行比较的集合或可迭代对象
Returns:: bool
Return type:: 如果此集合是other的子集，则为True

issuperset(other)

测试这个集合是否是other的超集

Parameters:: 其他 (Set 或 iterable) – 要与此集合进行比较的集合或可迭代对象
Returns:: bool
Return type:: 如果此集合是other的超集，则为True

model(): 返回拥有此数据的组件的模型。

parent_block(): 返回拥有此数据的组件的父组件。

parent_component(): 返回与此对象关联的组件。

pprint(ostream=None, verbose=False, prefix=''): 打印组件信息

reconstruct(data=None)

已移除：reconstruct() 在 Pyomo 6.0 中被移除。

重新构建模型组件是脆弱的，并且不能正确更新在其他组件或上下文中使用的组件实例（这对于Var、Param和Set尤其成问题）。希望重现reconstruct()旧行为的用户，如果愿意操作非公开接口，并且愿意花时间验证他们的模型是否正确执行，可以通过以下方式近似实现reconstruct的旧行为：

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

root_block(): 返回 self.model()

set_suffix_value(suffix_or_name, value, expand=True): 设置此组件数据的后缀值

symmetric_difference(other): 返回此集合与另一个集合的对称差集

type()

已弃用。

返回此组件的类类型

自版本5.7起已弃用：Component.type() 方法已被 .ctype 属性取代。

union(*args): 返回此集合与一个或多个集合的并集。

valid_model_component(): 如果这可以用作模型组件，则返回True。

property active: 返回活动属性

property concrete: 已弃用。

自版本5.7起已弃用：不再支持‘concrete’属性。请使用isdiscrete()或isfinite()

property ctype: 返回此组件的类类型

property filter: 已弃用。

自版本5.7起已弃用：‘filter’ 不再是公共属性。

property local_name: 仅在直接父容器的上下文中获取组件名称。

property name: 获取完全限定的组件名称。

property ordered: 已弃用。

自版本5.7起已弃用：不再支持‘ordered’属性。请使用isordered()

property virtual: 已弃用。

自版本5.7起已弃用：不再支持‘virtual’属性