分段线性函数

(类来自 pyomo.contrib.piecewise.piecewise_linear_function)

class pyomo.contrib.piecewise.piecewise_linear_function.PiecewiseLinearFunction(*args, **kwds)[源代码]

基础类: Block

分段线性函数，可以定义在索引上。

Can be specified in one of several ways:

点的列表和一个用于近似的非线性函数。在这种情况下，这些点将用于推导感兴趣域的部分的三角剖分，并且将为三角剖分中的每个单纯形计算一个近似给定函数的线性函数。在这种情况下，需要scipy（用于多元函数）。
单纯形列表和要逼近的非线性函数。在这种情况下，将为每个单纯形计算逼近给定函数的线性函数。对于多元函数，需要numpy。
单纯形列表和返回线性函数表达式的函数列表。这些是对应于每个单纯形的所需分段函数。
将函数值映射到定义域的点，允许从表格数据构建分段线性函数。

Parameters:

function – 用于近似的非线性函数：必须是可调用的
function_rule – 返回一个非线性函数的函数，用于近似IndexedPiecewiseLinearFunction中每个索引的函数
points – 与近似函数的定义域维度相同的点列表。请注意，如果函数的片段以这种方式指定，我们需要使用scipy。
simplices – 一个点的列表的列表，其中每个列表指定了一个单纯形的极点，非线性函数将在这些单纯形上被近似为线性函数。
linear_functions – 一个函数列表，每个函数返回一个关于参数的线性函数的表达式。
tabular_data – 一个将非线性函数的值映射到定义域中的点的字典
三角剖分 (可选) – 一个类型为 Triangulation 的枚举值，指定 Pyomo 应如何对函数域进行三角剖分，或为 None。行为取决于如何构造此分段线性函数：当使用上述方法 (1) 或 (4) 构造时，有效参数是 Triangulation 的成员，除了 Unknown 或 AssumeValid，Pyomo 将使用该方法对域进行三角剖分并标记生成的 PWLF。如果未传递参数或传递 None，则默认为 Triangulation.Delaunay。当使用上述方法 (2) 或 (3) 构造时，有效参数仅为 Triangulation.Unknown 和 Triangulation.AssumeValid。Pyomo 将按照指定的方式标记构造的 PWLF，在 AssumeValid 的情况下信任用户。当未传递参数或传递 None 时，默认为 Triangulation.Unknown

__init__(*args, **kwargs)[source]: 构造函数

方法

`__init__`(args, *kwargs)	构造函数
`activate`()	将活动属性设置为True
`clear`()	清除此组件中的数据
`clear_suffix_value`(suffix_or_name[, expand])	清除此组件数据的后缀值
`cname`(args, *kwds)	已弃用。
`construct`([data])	初始化块
`deactivate`()	将活动属性设置为False
`dim`()	返回索引的维度
`display`([filename, ostream, prefix])	在块中显示值
`get_suffix_value`(suffix_or_name[, default])	获取此组件数据的后缀值
`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`([sort, ordered])	返回组件数据键的迭代器
`model`()	返回与此对象关联的模型。
`parent_block`()	返回此对象的父对象。
`parent_component`()	返回与此对象关联的组件。
`pprint`([ostream, verbose, prefix])	打印组件信息
`reconstruct`([data])	已移除：reconstruct() 在 Pyomo 6.0 中被移除。
`register_private_data_initializer`(initializer)
`root_block`()	返回 self.model()
`set_suffix_value`(suffix_or_name, value[, expand])	设置此组件数据的后缀值
`set_value`(value)	设置标量组件的值。
`to_dense_data`()	待办事项
`type`()	已弃用。
`valid_model_component`()	如果这可以用作模型组件，则返回True。
`values`([sort, ordered])	返回组件数据对象的迭代器

属性

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

成员文档

activate(): 将活动属性设置为True

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

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

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

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

construct(data=None): 初始化块

deactivate(): 将活动属性设置为False

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

display(filename=None, ostream=None, prefix=''): 在块中显示值

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) – 生成相对于指定块的完全限定名称。

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_suffix_value(suffix_or_name, value, expand=True): 设置此组件数据的后缀值

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

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: 获取完全限定的组件名称。