自动链接布尔变量

(类来自 pyomo.gdp.disjunct)

class pyomo.gdp.disjunct.AutoLinkedBooleanVar(*args, **kwds)[source]

基础类: ScalarBooleanVar

一个布尔变量隐式地链接到其等效的二进制变量。

该类为GDP提供了一个弃用路径。最初，Disjunct的indicator_var是一个二进制变量。这简化了早期的转换。然而，随着引入一个适当的逻辑表达式系统，数学上正确的方法是使Disjunct的indicator_var属性成为一个适当的BooleanVar。作为过渡的一部分，indicator_var属性是AutoLinkedBooleanVar的实例，它允许indicator_var在逻辑表达式中使用，但也隐式转换（带有弃用警告）为等效的二进制变量。

设置值和固定/取消固定此变量的基本操作也会自动应用于关联的二进制变量。

由于此类仅旨在为Disjunct.indicator_var提供弃用路径，因此它仅支持Scalar实例，不支持索引。

__init__(*args, **kwd)

方法

`__init__`(args, *kwd)
`add`(index)	添加一个具有特定索引的变量。
`as_binary`()
`as_numeric`()	返回与此布尔变量关联的二进制变量。
`associate_binary_var`(binary_var)	将二进制 VarData 关联到此 BooleanVarData
`clear`()	清除此组件中的数据
`clear_suffix_value`(suffix_or_name[, expand])	设置此组件数据的后缀值
`cname`(args, *kwds)	已弃用。
`construct`([data])	构建此组件。
`dim`()	返回索引的维度
`display`([ostream, verbose, prefix])
`equivalent_to`(other)	在此布尔值与其操作数之间构建一个等价表达式。
`extract_values`([include_fixed_values])	返回一个索引-值对的字典。
`fix`([value, skip_validation])	将固定指示器设置为True。
`flag_as_stale`()	将每个变量数据对象的'stale'属性设置为True。
`free`()	`unfix()` 的别名
`get_associated_binary`()	获取与此 BooleanVarData 关联的二进制 VarData
`get_suffix_value`(suffix_or_name[, default])	获取此组件数据的后缀值
`get_units`()
`get_values`([include_fixed_values])	返回一个索引-值对的字典。
`getname`([fully_qualified, name_buffer, ...])	返回包含组件名称和索引的字符串
`has_lb`()
`has_ub`()
`id_index_map`()	返回所有ComponentData实例的字典id->索引。
`implies`(other)	使用“implies”方法构建一个ImplicationExpression
`index`()	返回此ComponentData实例相对于父组件索引集的索引。
`index_set`()	返回索引集
`is_binary`()
`is_component_type`()	如果此类是Pyomo组件，则返回True
`is_constant`()	返回 False，因为这不是表达式中的常量。
`is_constructed`()	如果这个类已经被构造，则返回True
`is_continuous`()
`is_expression_type`([expression_system])	如果此数值是一个表达式，则返回 True
`is_fixed`()	如果此变量是固定的，则返回True，否则返回False。
`is_indexed`()	如果此组件已索引，则返回true
`is_integer`()
`is_logical_type`()	如果此类是Pyomo布尔对象，则返回True。
`is_named_expression_type`()	如果此数值是一个命名表达式，则返回 True
`is_numeric_type`()	布尔值不是数字。
`is_parameter_type`()	除非此类是参数对象，否则返回 False
`is_potentially_variable`()	返回 True，因为这是一个变量。
`is_reference`()	如果此组件是引用，则返回True，其中“引用”被解释为任何不拥有自己数据的组件。
`is_relational`()	已弃用。
`is_variable_type`()	返回 True，因为这是一个变量。
`items`([sort, ordered])	返回一个包含(index, data)组件数据元组的迭代器
`iteritems`()	已弃用。
`iterkeys`()	已弃用。
`itervalues`()	已弃用。
`keys`([sort, ordered])	返回组件数据键的迭代器
`land`(other)	在此BooleanValue和other之间构建一个AndExpression（逻辑与）。
`lor`(other)	在此BooleanValue和other之间构造一个OrExpression（逻辑或）。
`model`()	返回拥有此数据的组件的模型。
`parent_block`()	返回拥有此数据的组件的父组件。
`parent_component`()	返回与此对象关联的组件。
`polynomial_degree`()
`pprint`([ostream, verbose, prefix])	打印组件信息
`reconstruct`([data])	已移除：reconstruct() 在 Pyomo 6.0 中被移除。
`root_block`()	返回 self.model()
`set_suffix_value`(suffix_or_name, value[, expand])	设置此组件数据的后缀值
`set_value`(val[, skip_validation, ...])	在验证其值后，设置此数值对象的值。
`set_values`(new_values[, skip_validation])	从字典中设置数据值。
`setlb`(arg)
`setub`(arg)
`to_dense_data`()	待办事项
`to_string`([verbose, labeler, smap, ...])	返回表达式树的字符串表示。
`type`()	已弃用。
`unfix`()	将固定指示器设置为False。
`valid_model_component`()	如果这可以用作模型组件，则返回True。
`values`([sort, ordered])	返回组件数据对象的迭代器
`xor`(other)	使用“xor”方法构造一个XorExpression

属性

`fixed`
`active`	返回活动属性
`bounds`
`ctype`	返回此组件的类类型
`domain`	此变量的域。
`lb`
`local_name`	仅在直接父容器的上下文中获取组件名称。
`name`	获取完全限定的组件名称。
`stale`	一个布尔值，指示此变量的值是否与最近的求解一致。
`ub`
`value`	此变量的当前值。

成员文档

add(index): 添加一个具有特定索引的变量。

as_numeric()[source]

返回与此布尔变量关联的二进制变量。

此方法返回关联的二进制变量，并附带一个关于在数值上下文中使用布尔变量的弃用警告。

associate_binary_var(binary_var): 将二进制 VarData 关联到此 BooleanVarData

clear(): 清除此组件中的数据

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

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

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

construct(data=None): 构建此组件。

dim(): 返回索引的维度

equivalent_to(other): 在此布尔值与其操作数之间构建一个等价表达式。

extract_values(include_fixed_values=True): 返回一个索引-值对的字典。

fix(value=NOTSET, skip_validation=False)[源代码]: 将固定指示器设置为True。值参数是可选的，表示变量应固定在其当前值。

flag_as_stale(): 将每个变量数据对象的‘stale’属性设置为True。

free(): unfix() 的别名

get_associated_binary(): 获取与此BooleanVarData关联的二进制VarData

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

get_values(include_fixed_values=True): 返回一个索引-值对的字典。

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

id_index_map(): 返回所有ComponentData实例的字典id->索引。

implies(other): 使用“implies”方法构建一个ImplicationExpression

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

index_set(): 返回索引集

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

is_constant(): 返回 False，因为这不是表达式中的常量。

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

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

is_fixed(): 如果此变量是固定的，则返回True，否则返回False。

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

is_logical_type()

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

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

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

is_numeric_type(): 布尔值不是数字。

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

is_potentially_variable(): 返回 True，因为这是一个变量。

is_reference(): 如果此组件是引用，则返回True，其中“引用”被解释为不拥有自己数据的任何组件。

is_relational()

已弃用。

如果此逻辑值表示一个关系表达式，则返回True。

自版本6.4.3起已弃用：is_relational() 已被弃用，推荐使用 is_expression_type(ExpressionType.RELATIONAL)

is_variable_type(): 返回 True，因为这是一个变量。

items(sort=<SortComponents.UNSORTED: 0>, ordered=NOTSET)

返回一个包含(index, data)组件数据元组的迭代器

Parameters:

sort (bool 或 SortComponents) – 以指定的排序顺序迭代声明的组件项。有关有效选项和描述，请参见 SortComponents。
ordered (bool) – 已弃用：请使用 sort=SortComponents.ORDERED_INDICES。如果为 True，则项目将以确定性顺序返回（使用底层集合的 ordered_iter()。

iteritems()

已弃用。

从字典返回一个包含（索引，数据）元组的列表

自版本6.0起已弃用：iteritems方法已被弃用。请使用dict.items()。

iterkeys()

已弃用。

返回字典中的键列表

自版本6.0起已弃用：iterkeys方法已被弃用。请使用dict.keys()。

itervalues()

已弃用。

返回字典中组件数据对象的列表

自版本6.0起已弃用：itervalues方法已被弃用。请使用dict.values()。

keys(sort=<SortComponents.UNSORTED: 0>, ordered=NOTSET)

返回组件数据键的迭代器

此方法设置此IndexedComponent容器内组件数据对象的排序。为了保持一致性， __init__(), values(), 和 items() 都利用此方法来确保一致的排序。

Parameters:

sort (bool 或 SortComponents) – 以指定的排序顺序迭代声明的组件键。有关有效选项和描述，请参见 SortComponents。
ordered (bool) – 已弃用：请使用 sort=SortComponents.ORDERED_INDICES。如果为 True，则键将以确定性顺序返回（使用底层集合的 ordered_iter()）。

land(other): 在此BooleanValue和other之间构建一个AndExpression（逻辑与）。

lor(other): 在此BooleanValue和other之间构造一个OrExpression（逻辑或）。

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): 设置此组件数据的后缀值

set_value(val, skip_validation=False, _propagate_value=True)[source]: 设置此数值对象的值，在验证其值之后。如果‘valid’标志为True，则跳过验证步骤。

set_values(new_values, skip_validation=False)

从字典中设置数据值。

默认行为是验证字典中的值。

to_dense_data(): 待办事项

to_string(verbose=None, labeler=None, smap=None, compute_values=False)

返回表达式树的字符串表示。

Parameters:

verbose (bool) – 如果 True，则字符串表示由嵌套函数组成。否则，字符串表示是一个代数方程。默认为 False。
labeler – 一个为表达式树中的变量生成字符串标签的对象。默认为 None。

Returns:

表达式树的字符串表示。

type()

已弃用。

返回此组件的类类型

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

unfix()[source]: 将固定指示器设置为False。

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

values(sort=<SortComponents.UNSORTED: 0>, ordered=NOTSET)

返回组件数据对象的迭代器

Parameters:

sort (bool 或 SortComponents) – 以指定的排序顺序迭代声明的组件值。有关有效选项和描述，请参见 SortComponents。
ordered (bool) – 已弃用：请使用 sort=SortComponents.ORDERED_INDICES。如果为 True，则值将以确定性顺序返回（使用底层集合的 ordered_iter()。

xor(other): 使用“xor”方法构造一个XorExpression

property active: 返回活动属性

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

property domain

此变量的域。

Type:: BooleanSet

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

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

property stale

一个布尔值，指示此变量的值是否与最近的求解一致。True 表示此变量的值在最近的求解之前已设置，并且未通过求解返回的结果进行更新。

Type:: bool

property value

此变量的当前值。

Type:: bool