VarDict

(类来自 pyomo.core.beta.dict_objects)

class pyomo.core.beta.dict_objects.VarDict(*args, **kwargs)

基础类：ComponentDict, IndexedVar

__init__(*args, **kwds)

方法

__init__(*args, **kwds)
add(index)	添加一个具有特定索引的变量。
clear()
clear_suffix_value(suffix_or_name[, expand])	清除此组件数据的后缀值
cname(*args, **kwds)	已弃用。
construct([data])	为此变量构建VarData对象
dim()	返回索引的维度
display([ostream, verbose, prefix])
extract_values([include_fixed_values])	返回一个索引-值对的字典。
fix([value, skip_validation])	修复此IndexedVar中的所有变量（视为非变量）
flag_as_stale()	将每个变量数据对象的'stale'属性设置为True。
free()	unfix() 的别名
get(k[,d])
get_suffix_value(suffix_or_name[, default])	获取此组件数据的后缀值
get_units()	返回此变量的单位表达式。
get_values([include_fixed_values])	返回一个索引-值对的字典。
getname([fully_qualified, name_buffer, ...])	返回与此对象关联的组件名称。
id_index_map()	返回所有ComponentData实例的字典id->索引。
index_set()	返回索引集
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
items()
iteritems()	已弃用。
iterkeys()	已弃用。
itervalues()	已弃用。
keys()
model()	返回与此对象关联的模型。
parent_block()	返回此对象的父对象。
parent_component()	返回与此对象关联的组件。
pop(k[,d])	如果未找到键，则返回给定的d，否则会引发KeyError。
popitem()	作为一个2元组；但如果D为空，则引发KeyError。
pprint([ostream, verbose, prefix])	打印组件信息
reconstruct([data])	已移除：reconstruct() 在 Pyomo 6.0 中被移除。
root_block()	返回 self.model()
set_suffix_value(suffix_or_name, value[, expand])	设置此组件数据的后缀值
set_value(value)	设置标量组件的值。
set_values(new_values[, skip_validation])	设置字典的值。
setdefault(k[,d])
setlb(val)	设置此变量的下限。
setub(val)	设置此变量的上限。
to_dense_data()	待办事项
type()	已弃用。
unfix()	解除此IndexedVar中的所有变量的固定（视为变量）
update([E, ]**F)	如果E存在并且具有.keys()方法，则执行： for k in E: D[k] = E[k] 如果E存在但缺少.keys()方法，则执行： for (k, v) in E: D[k] = v 无论哪种情况，接下来都会执行： for k, v in F.items(): D[k] = v
valid_model_component()	如果这可以用作模型组件，则返回True。
values()

属性

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

成员文档

add(index)

添加一个具有特定索引的变量。

clear() → None.  Remove all items from D.

clear_suffix_value(suffix_or_name, expand=True)

清除此组件数据的后缀值

cname(*args, **kwds)

已弃用。

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

construct(data=None)

为此变量构建VarData对象

dim()

返回索引的维度

extract_values(include_fixed_values=True)

返回一个索引-值对的字典。

fix(value=NOTSET, skip_validation=False)

修复此IndexedVar中的所有变量（视为非变量）

这将为此IndexedVar中的每个变量设置fixed指示器为True。如果提供了value，则首先将值（以及skip_validation标志）传递给set_value()。

flag_as_stale()

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

free()

unfix() 的别名

get(k[, d]) → D[k] if k in D, else d.  d defaults to None.

get_suffix_value(suffix_or_name, default=None)

获取此组件数据的后缀值

get_units()

返回此变量的单位表达式。

get_values(include_fixed_values=True)

返回一个索引-值对的字典。

getname(fully_qualified=False, name_buffer=None, relative_to=None)

返回与此对象关联的组件名称。

Parameters:

• fully_qualified (bool) – 从嵌套的块名称生成全名

• relative_to (Block) – 生成相对于指定块的完全限定名称。

id_index_map()

返回所有ComponentData实例的字典id->索引。

index_set()

返回索引集

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

items() → a set-like object providing a view on D's items

iteritems()

已弃用。

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

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

iterkeys()

已弃用。

返回字典中的键列表

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

itervalues()

已弃用。

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

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

keys() → a set-like object providing a view on D's keys

model()

返回与此对象关联的模型。

parent_block()

返回此对象的父对象。

parent_component()

返回与此对象关联的组件。

pop(k[, d]) → v, remove specified key and return the corresponding value.

如果未找到键，则返回给定的d，否则会引发KeyError。

popitem() → (k, v), remove and return some (key, value) pair

作为一个2元组；但如果D为空，则引发KeyError。

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(value)

设置标量组件的值。

set_values(new_values, skip_validation=False)

设置字典的值。

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

setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D

setlb(val)

设置此变量的下限。

setub(val)

设置此变量的上限。

to_dense_data()

待办事项

type()

已弃用。

返回此组件的类类型

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

unfix()

解除此IndexedVar中的所有变量的固定（视为变量）

这将为这个IndexedVar中的每个变量将VarData.fixed指示器设置为False。

update([E, ]**F) → None.  Update D from mapping/iterable E and F.

如果 E 存在并且有 .keys() 方法，则执行： for k in E: D[k] = E[k] 如果 E 存在但没有 .keys() 方法，则执行： for (k, v) in E: D[k] = v 无论哪种情况，接下来都会执行： for k, v in F.items(): D[k] = v

valid_model_component()

如果这可以用作模型组件，则返回True。

values() → an object providing a view on D's values

property active

返回活动属性

property ctype

返回此组件的类类型

property local_name

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

property name

获取完全限定的组件名称。