参数

(类来自 pyomo.core.kernel.parameter)

class pyomo.core.kernel.parameter.parameter(value=None)

基础：IParameter

一个用于存储可变数值的对象，可用于构建符号表达式。

__init__(value=None)

方法

__init__([value])
activate()	激活此对象。
clone()	返回此对象的副本，并将父指针设置为None。
deactivate()	停用此对象。
getname([fully_qualified, name_buffer, ...])	动态生成此对象的名称。
is_component_type()	如果此类是Pyomo组件，则返回True
is_constant()	一个布尔值，表示此参数是常量。
is_expression_type([expression_system])	如果此数值是一个表达式，则返回 True
is_fixed()	一个布尔值，表示此参数是固定的。
is_indexed()	如果此数值是一个索引对象，则返回 True
is_logical_type()	如果此类是Pyomo布尔对象，则返回True。
is_named_expression_type()	如果此数值是一个命名表达式，则返回 True
is_numeric_type()	如果此类是Pyomo数值对象，则返回True
is_parameter_type()	一个布尔值，表示这是一个参数对象。
is_potentially_variable()	返回 False，因为此对象永远无法引用变量。
is_reference()	如果此对象是引用，则返回 True。
is_relational()	已弃用。
is_variable_type()	一个布尔值，表示这是一个变量对象。
polynomial_degree()	始终返回零，因为我们总是验证存储的表达式永远不能引用变量。
to_string([verbose, labeler, smap, ...])	返回表达式树的字符串表示。

属性

active	此对象的活动状态。
ctype	对象的类别类型。
local_name	对象在其父级上下文中的本地名称。
name	对象的完全限定名称。
parent	对象的父级（可能为None）。
storage_key	对象在其父级中的存储键
value	参数的值

成员文档

activate()

激活此对象。

clone()

返回此对象的副本，并将父指针设置为None。

克隆几乎等同于深拷贝，除了遇到的任何分类对象如果不是该对象的后代，将在克隆上引用相同的对象。

deactivate()

停用此对象。

getname(fully_qualified=False, name_buffer={}, convert=<class 'str'>, relative_to=None)

动态生成此对象的名称。

Parameters:

• fully_qualified (bool) – 通过迭代所有祖先容器生成完整名称。 默认值为 False。

• convert (function) – 一个将存储键转换为字符串表示的函数。默认是内置函数 str。

• relative_to (object) – 在生成完全限定名称时，生成相对于此块的名称。

Returns:

如果存在父对象，此方法返回一个字符串，表示该对象在其父对象上下文中的名称；否则（如果不存在父对象），此方法返回None。

is_component_type()

如果此类是Pyomo组件，则返回True

is_constant()

一个布尔值，表示此参数是常量。

is_expression_type(expression_system=None)

如果此数值是一个表达式，则返回 True

is_fixed()

一个布尔值，表示此参数是固定的。

is_indexed()

如果此数值是一个索引对象，则返回 True

is_logical_type()

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

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

is_named_expression_type()

如果此数值是一个命名表达式，则返回 True

is_numeric_type()

如果此类是Pyomo数值对象，则返回True

is_parameter_type()

一个布尔值，表示这是一个参数对象。

is_potentially_variable()

返回 False 因为此对象无法引用变量。

is_reference()

如果此对象是引用，则返回 True。

is_relational()

已弃用。

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

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

is_variable_type()

一个布尔值，表示这是一个变量对象。

polynomial_degree()

始终返回零，因为我们总是验证存储的表达式永远不能引用变量。

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

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

Parameters:

• verbose (bool) – 如果为 True，则字符串表示由嵌套函数组成。否则，字符串表示为一个中缀代数方程。默认为 False。

• labeler – 一个为表达式树中的非常量生成字符串标签的对象。默认为 None。

• smap – 一个SymbolMap实例，用于存储表达式树中非常量节点的字符串标签。默认为 None。

• compute_values (bool) – 如果 True，则固定表达式会被评估，并返回结果值的字符串表示。

Returns:

表达式树的字符串表示。

property active

此对象的活动状态。

property ctype

对象的类别类型。

property local_name

对象在其父级上下文中的本地名称。是 obj.getname(fully_qualified=False)的别名。

property name

对象的完全限定名称。obj.getname(fully_qualified=True)的别名。

property parent

对象的父级（可能为None）。

property storage_key

对象在其父级中的存储键

property value

参数的值