表达数据
(类来自 pyomo.core.base.expression)
- class pyomo.core.base.expression.ExpressionData(expr=None, component=None)[source]
基础类:
NamedExpressionData,ComponentData一个定义从不克隆的表达式的对象
- Parameters:
expr (NumericValue) – 存储在此表达式中的Pyomo表达式。
component (Expression) – 拥有此数据的Expression对象。
方法
__init__([expr, component])arg(索引)clear_suffix_value(suffix_or_name[, expand])设置此组件数据的后缀值
clone()返回此表达式的克隆(无操作)。
cname(*args, **kwds)已弃用。
create_node_with_local_data(values[, classtype])在构造包含的表达式后,构造一个简单的表达式。
get_suffix_value(suffix_or_name[, default])获取此组件数据的后缀值
getname(*args, **kwargs)如果这是一个组件,返回所属块上的组件名称;否则返回转换为字符串的值
index()返回此ComponentData实例相对于父组件索引集的索引。
如果此类是Pyomo组件,则返回True
一个布尔值,指示此表达式是否为常量。
is_expression_type([expression_system])一个布尔值,指示这是否是一个表达式。
is_fixed()一个布尔值,指示此表达式是否固定。
如果此数值是一个索引对象,则返回 True
如果此类是Pyomo布尔对象,则返回True。
一个布尔值,指示这是否是一个命名表达式。
如果此类是Pyomo数值对象,则返回True
除非此类是参数对象,否则返回 False
如果变量可以出现在此表达式中,则返回 True
如果此对象是引用,则返回 True。
已弃用。
除非此类是变量对象,否则返回 False
model()返回拥有此数据的组件的模型。
nargs()返回拥有此数据的组件的父组件。
返回与此对象关联的组件。
涉及此表达式操作的子表达式的元组。
pprint([ostream, verbose, prefix])打印组件信息
set_suffix_value(suffix_or_name, value[, expand])设置此组件数据的后缀值
set_value(expr)在此表达式上设置表达式。
to_string([verbose, labeler, smap, ...])返回表达式树的字符串表示。
type()已弃用。
属性
PRECEDENCE返回活动属性
args返回此组件的类类型
expr仅在直接父容器的上下文中获取组件名称。
获取完全限定的组件名称。
成员文档
- clear_suffix_value(suffix_or_name, expand=True)
设置此组件数据的后缀值
- clone()
返回此表达式的克隆(无操作)。
- cname(*args, **kwds)
已弃用。
自版本5.0起已弃用:cname() 方法已重命名为 getname()。 获取组件名称的首选方法是使用 .name 属性,该属性返回完全限定的组件名称。 .local_name 属性将仅在直接父容器的上下文中返回组件名称。
- create_node_with_local_data(values, classtype=None)
在构造包含的表达式之后,构造一个简单的表达式。
该类提供了一个一致的接口,用于构建节点,该节点用于树访问者脚本中。
- get_suffix_value(suffix_or_name, default=None)
获取此组件数据的后缀值
- getname(*args, **kwargs)
如果这是一个组件,返回组件在所属块上的名称;否则返回转换为字符串的值
- index()
返回此ComponentData实例相对于父组件索引集的索引。如果此实例没有父组件,或者由于某些未知原因此实例不属于父组件的索引集,则返回None。
- is_component_type()
如果此类是Pyomo组件,则返回True
- is_constant()
一个布尔值,指示此表达式是否为常量。
- is_expression_type(expression_system=None)
一个布尔值,指示这是否是一个表达式。
- is_fixed()
一个布尔值,指示此表达式是否固定。
- is_indexed()
如果此数值是一个索引对象,则返回 True
- is_logical_type()
如果此类是Pyomo布尔对象,则返回True。
布尔对象包括常量、变量或逻辑表达式。
- is_named_expression_type()
一个布尔值,指示这是否是一个命名表达式。
- is_numeric_type()
如果此类是Pyomo数值对象,则返回True
- 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()
除非此类是变量对象,否则返回 False
- model()
返回拥有此数据的组件的模型。
- parent_block()
返回拥有此数据的组件的父组件。
- parent_component()
返回与此对象关联的组件。
- polynomial_degree()
涉及此表达式操作的子表达式的元组。
- pprint(ostream=None, verbose=False, prefix='')
打印组件信息
请注意,此方法通常只能通过IndexedComponent容器中的ComponentData对象访问。组件,包括未索引的Component派生类以及标量和索引的IndexedComponent派生类,将会看到
Component.pprint()
- set_suffix_value(suffix_or_name, value, expand=True)
设置此组件数据的后缀值
- set_value(expr)
在此表达式上设置表达式。
- to_string(verbose=None, labeler=None, smap=None, compute_values=False)
返回表达式树的字符串表示。
- type()
已弃用。
返回此组件的类类型
自版本5.7起已弃用:Component.type() 方法已被 .ctype 属性取代。
- property active
返回活动属性
- property ctype
返回此组件的类类型
- property local_name
仅在直接父容器的上下文中获取组件名称。
- property name
获取完全限定的组件名称。