AbstractSuffix

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

class pyomo.core.base.suffix.AbstractSuffix(*args, **kwargs)

基础类：Suffix

__init__(**kwargs)

方法

__init__(**kwargs)
activate()	将活动属性设置为True
clear()
clear_all_values()	清除所有后缀数据。
clear_suffix_value(suffix_or_name[, expand])	清除此组件数据的后缀值
clear_value(component[, expand])	清除组件的后缀信息。
cname(*args, **kwds)	已弃用。
construct([data])	构建此组件，如果存在规则则应用规则。
deactivate()	将活动属性设置为False
display([ostream, verbose, prefix])
export_enabled()	当此后缀启用以导出到求解器时返回True。
get(k[,d])
get_datatype()	已弃用。
get_direction()	已弃用。
get_suffix_value(suffix_or_name[, default])	获取此组件数据的后缀值
getname([fully_qualified, name_buffer, ...])	返回与此对象关联的组件名称。
import_enabled()	当此后缀启用以从解决方案导入时返回True。
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()
keys()
model()	返回与此对象关联的模型。
parent_block()	返回此对象的父对象。
parent_component()	返回与此对象关联的组件。
pop(k[,d])	如果未找到键，则返回给定的d，否则会引发KeyError。
popitem()	作为一个2元组；但如果D为空，则引发KeyError。
pprint(*args, **kwds)	打印组件信息
reconstruct([data])	已移除：reconstruct() 在 Pyomo 6.0 中被移除。
root_block()	返回 self.model()
set_all_values(value)	在所有组件上设置此后缀的值。
set_datatype(datatype)	已弃用。
set_direction(direction)	已弃用。
set_suffix_value(suffix_or_name, value[, expand])	设置此组件数据的后缀值
set_value(component, value[, expand])	在指定的组件上设置此后缀的值。
setdefault(k[,d])
type()	已弃用。
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
update_values(data[, expand])	根据组件和值的元组列表更新后缀数据。
valid_model_component()	如果这可以用作模型组件，则返回True。
values()

属性

active	返回活动属性
ctype	返回此组件的类类型
datatype	返回后缀数据类型。
direction	返回后缀方向。
hasher
local_name	仅在直接父容器的上下文中获取组件名称。
name	获取完全限定的组件名称。

成员文档

activate()

将活动属性设置为True

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

clear_all_values()

清除所有后缀数据。

clear_suffix_value(suffix_or_name, expand=True)

清除此组件数据的后缀值

clear_value(component, expand=True)

清除组件的后缀信息。

cname(*args, **kwds)

已弃用。

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

construct(data=None)

构建此组件，如果存在规则则应用规则。

deactivate()

将活动属性设置为False

export_enabled()

当此后缀启用以导出到求解器时返回True。

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

get_datatype()

已弃用。

返回后缀数据类型。

自版本6.7.1起已弃用：Suffix.get_datatype已被Suffix.datatype属性取代

get_direction()

已弃用。

返回后缀方向。

自版本6.7.1起已弃用：Suffix.get_direction已被Suffix.direction属性取代

get_suffix_value(suffix_or_name, default=None)

获取此组件数据的后缀值

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

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

Parameters:

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

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

import_enabled()

当此后缀启用以从解决方案导入时返回True。

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

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(*args, **kwds)

打印组件信息

reconstruct(data=None)

已移除：reconstruct() 在 Pyomo 6.0 中被移除。

重新构建模型组件是脆弱的，并且不能正确更新在其他组件或上下文中使用的组件实例（这对于Var、Param和Set尤其成问题）。希望重现reconstruct()旧行为的用户，如果愿意操作非公开接口，并且愿意花时间验证他们的模型是否正确执行，可以通过以下方式近似实现reconstruct的旧行为：

component.clear() component._constructed = False component.construct()

root_block()

返回 self.model()

set_all_values(value)

在所有组件上设置此后缀的值。

set_datatype(datatype)

已弃用。

设置后缀数据类型。

自版本6.7.1起已弃用：Suffix.set_datatype已被Suffix.datatype属性取代

set_direction(direction)

已弃用。

设置后缀方向。

自版本6.7.1起已弃用：Suffix.set_direction已被Suffix.direction属性取代

set_suffix_value(suffix_or_name, value, expand=True)

设置此组件数据的后缀值

set_value(component, value, expand=True)

在指定的组件上设置此后缀的值。

当expand为True（默认）时，数组组件通过为每个索引存储引用和值来处理，而不存储数组组件本身的引用。当expand为False（这是__setitem__的情况）时，此行为被禁用，并保留对数组组件本身的引用。

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

type()

已弃用。

返回此组件的类类型

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

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

update_values(data, expand=True)

更新给定组件和值元组列表的后缀数据。相比于在每个组件上调用set_value，提供了效率上的改进。

valid_model_component()

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

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

property active

返回活动属性

property ctype

返回此组件的类类型

property datatype

返回后缀数据类型。

property direction

返回后缀方向。

property local_name

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

property name

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