参数数据

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

class pyomo.core.base.param.ParamData(component)[source]

基础类: ComponentData, NumericValue

此类定义了可变参数的数据。

Constructor Arguments:: owner 拥有此数据的Param对象。 value 此参数的值。
Public Class Attributes:: value 此变量的数值。

__init__(component)[源代码]

方法

`__init__`(component)
`clear`()	清除此组件中的数据
`clear_suffix_value`(suffix_or_name[, expand])	设置此组件数据的后缀值
`cname`(args, *kwds)	已弃用。
`get_suffix_value`(suffix_or_name[, default])	获取此组件数据的后缀值
`get_units`()	返回此ParamData的单位
`getname`([fully_qualified, name_buffer, ...])	返回包含组件名称和索引的字符串
`index`()	返回此ComponentData实例相对于父组件索引集的索引。
`is_component_type`()	如果此类是Pyomo组件，则返回True
`is_constant`()	返回 False，因为这不是表达式中的常量。
`is_expression_type`([expression_system])	如果此数值是一个表达式，则返回 True
`is_fixed`()	返回True，因为此值是固定的。
`is_indexed`()	如果此组件已索引，则返回true
`is_logical_type`()	如果此类是Pyomo布尔对象，则返回True。
`is_named_expression_type`()	如果此数值是一个命名表达式，则返回 True
`is_numeric_type`()	如果此类是Pyomo数值对象，则返回True
`is_parameter_type`()	返回 True，因为这是一个参数对象。
`is_potentially_variable`()	如果变量可以出现在此表达式中，则返回 True
`is_reference`()	如果此对象是引用，则返回 True。
`is_relational`()	已弃用。
`is_variable_type`()	除非此类是变量对象，否则返回 False
`model`()	返回拥有此数据的组件的模型。
`parent_block`()	返回拥有此数据的组件的父组件。
`parent_component`()	返回与此对象关联的组件。
`polynomial_degree`()	返回表达式的多项式次数。
`pprint`([ostream, verbose, prefix])	打印组件信息
`set_suffix_value`(suffix_or_name, value[, expand])	设置此组件数据的后缀值
`set_value`(value[, idx])	设置此ParamData对象的值，必要时执行单位转换和验证。
`to_string`([详细, 标签器, smap, ...])	返回表达式树的字符串表示。
`type`()	已弃用。

属性

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

成员文档

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

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

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

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

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

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

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

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

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

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

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

is_fixed()[source]: 返回True，因为此值是固定的。

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

is_logical_type()

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

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

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

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

is_parameter_type()[source]: 返回 True，因为这是一个参数对象。

is_potentially_variable(): 如果变量可以出现在此表达式中，则返回 True

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

is_relational()

已弃用。

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

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

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

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

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

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

polynomial_degree()

返回表达式的多项式次数。

Returns:: None

pprint(ostream=None, verbose=False, prefix='')

打印组件信息

请注意，此方法通常只能通过IndexedComponent容器中的ComponentData对象访问。组件，包括未索引的Component派生类以及标量和索引的IndexedComponent派生类，将会看到Component.pprint()

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

set_value(value, idx=NOTSET)[source]: 设置此ParamData对象的值，必要时执行单位转换和验证。

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:

表达式树的字符串表示。

type()

已弃用。

返回此组件的类类型

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

property active: 返回活动属性

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

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

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

property value: 返回此变量的值。