参数

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

class pyomo.core.base.param.Param(*args, **kwds)[source]

基础类: IndexedComponent, IndexedComponent_NDArrayMixin

一个参数值，可能在一个索引上定义。

Constructor Arguments:

domain: 定义每个参数必须的值的类型的集合。
within: 定义每个参数必须的值的类型的一组。
validate: 用于验证此参数与模型中存在的数据的规则
default: 定义此参数默认值的标量、规则或字典
initialize: 用于使用现有模型数据设置此参数的字典或规则
unit: pyomo unit expression: 包含参数单位的表达式
mutable: boolean: 标志指示参数的值在调用求解器之间是否可能更改。默认为False
name: 此组件的名称。
doc: 描述此组件的文本。

__init__(*args, **kwd)[source]

方法

`__init__`(args, *kwd)
`clear`()	清除此组件中的数据
`clear_suffix_value`(suffix_or_name[, expand])	清除此组件数据的后缀值
`cname`(args, *kwds)	已弃用。
`construct`([data])	初始化此组件。
`default`()	返回参数默认值。
`dim`()	返回索引的维度
`display`([ostream, verbose, prefix])
`extract_values`()	一个实用工具，用于提取为此参数定义的所有索引-值对，返回为字典。
`extract_values_sparse`()	一个实用工具，用于提取所有使用非默认值定义的索引-值对，并以字典形式返回。
`get_suffix_value`(suffix_or_name[, default])	获取此组件数据的后缀值
`get_units`()	返回此ParamData的单位
`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`([排序, 有序])	返回一个包含(index, data)组件数据元组的迭代器
`iteritems`()	已弃用。
`iterkeys`()	已弃用。
`itervalues`()	已弃用。
`keys`([排序, 有序])	返回组件数据键的迭代器
`model`()	返回与此对象关联的模型。
`parent_block`()	返回此对象的父对象。
`parent_component`()	返回与此对象关联的组件。
`pprint`([ostream, verbose, prefix])	打印组件信息
`reconstruct`([data])	已移除：reconstruct() 在 Pyomo 6.0 中被移除。
`root_block`()	返回 self.model()
`set_default`(val)	执行错误检查，然后为此参数设置默认值。
`set_suffix_value`(suffix_or_name, value[, expand])	设置此组件数据的后缀值
`set_value`(value)	设置标量组件的值。
`sparse_items`()	返回定义参数的列表（索引，数据）元组
`sparse_iteritems`()	返回一个包含（索引，数据）元组的迭代器，用于定义的参数
`sparse_iterkeys`()	返回定义参数中键的迭代器
`sparse_itervalues`()	返回定义的参数数据对象的迭代器
`sparse_keys`()	返回定义参数中的键列表
`sparse_values`()	返回定义的参数数据对象的列表
`store_values`(new_values[, check])	一个用于使用字典或标量更新Param的实用工具。
`to_dense_data`()	待办事项
`type`()	已弃用。
`valid_model_component`()	如果这可以用作模型组件，则返回True。
`values`([排序, 有序])	返回组件数据对象的迭代器

属性

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

成员文档

class NoValue[source]

基础类：object

一个虚拟类型，它是pickle安全的，我们可以将其用作Params的默认值，以表示没有有效值存在。

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

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

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

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

construct(data=None)[source]

初始化此组件。

参数是使用初始数据或从外部源加载的数据构建的。我们首先根据self._rule设置所有值，然后允许数据字典覆盖任何内容。

请注意，我们允许构造一个未定义的Param值。如果用户尝试使用未初始化的Param，我们会抛出异常。

default()[source]

返回参数默认值。

Possible values:

Param.NoValue: 未提供默认值。
Numeric: 一个常量值，它是所有未定义参数的默认值。
Function: f(model, i) 返回参数 i 的默认值

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

extract_values()[source]

一个实用工具，用于提取为此参数定义的所有索引-值对，返回为字典。

在键迭代和重复的__getitem__调用过于昂贵以提取参数内容的情况下，此方法非常有用。

extract_values_sparse()[source]

一个实用工具，用于提取所有使用非默认值定义的索引-值对，并以字典形式返回。

在键迭代和重复的__getitem__调用过于昂贵以提取参数内容的情况下，此方法非常有用。

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

get_units()[source]: 返回此ParamData的单位

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(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()）。

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_default(val)[source]

执行错误检查，然后为此参数设置默认值。

注意：此测试不会验证函数返回值的值。

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

set_value(value): 设置标量组件的值。

sparse_items()[source]: 返回定义参数的列表（索引，数据）元组

sparse_iteritems()[source]: 返回一个包含（索引，数据）元组的迭代器，用于定义的参数

sparse_iterkeys()[source]: 返回定义参数中键的迭代器

sparse_itervalues()[source]: 返回定义的参数数据对象的迭代器

sparse_keys()[source]: 返回定义参数中的键列表

sparse_values()[source]: 返回定义的参数数据对象的列表

store_values(new_values, check=True)[source]

一个用于使用字典或标量更新Param的实用工具。

如果check=True，那么索引和值都会通过__getitem__方法进行检查。使用check=False应仅由开发人员使用！

to_dense_data(): 待办事项

type()

已弃用。

返回此组件的类类型

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

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

property active: 返回活动属性

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

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

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