时序数据

(类来自 pyomo.contrib.pyros.util)

class pyomo.contrib.pyros.util.TimingData

基础类：object

PyROS 求解器计时数据对象。

作为common.timing.HierarchicalTimer的封装实现， 增加了强制执行标准化标识符层次结构的功能。

hierarchical_timer_full_ids

（类属性。）用于封装层次计时器的有效标识符。

Type:

set 的 str

__init__()

初始化自身（参见类文档字符串）。

方法

__init__()	初始化自身（参见类文档字符串）。
get_main_elapsed_time()	获取包含在self中的HierarchicalTimer的主计时器的总经过时间。
get_total_time(full_identifier)	获取标识符处于活动状态的总时间。
start_timer(full_identifier)	为self.hierarchical_timer启动计时器。
stop_timer(full_identifier)	停止计时器 self.hierarchical_timer。

属性

hierarchical_timer_full_ids

成员文档

get_main_elapsed_time()

获取包含在self中的HierarchicalTimer的主计时器的总经过时间。

Returns:

总耗时。

Return type:

float

注意

此方法适用于主计时器处于活动状态时使用。 否则，请使用 self.get_total_time("main")。

get_total_time(full_identifier)

获取标识符处于活动状态的总时间。

Parameters:

full_identifier (str) – 感兴趣计时器的完整标识符。

Returns:

标识符处于活动状态的总时间。

Return type:

float

start_timer(full_identifier)

为self.hierarchical_timer启动计时器。

Parameters:

full_identifier (str) – 要启动的计时器的完整标识符。 必须是 TimingData.hierarchical_timer_full_ids 的一个条目。

stop_timer(full_identifier)

停止计时器 self.hierarchical_timer。

Parameters:

full_identifier (str) – 要停止的计时器的完整标识符。 必须是 TimingData.hierarchical_timer_full_ids 的一个条目。