IntervalData

(class from pyomo.contrib.mpc.data.interval_data)

class pyomo.contrib.mpc.data.interval_data.IntervalData(data, intervals, time_set=None, context=None)[source]

Bases: _DynamicDataBase

__init__(data, intervals, time_set=None, context=None)[source]

Processes keys of the data dict.

Methods

__init__(data, intervals[, time_set, context])

Processes keys of the data dict.

concatenate(other[, tolerance])

Extend interval list and variable data lists with the intervals and variable values in the provided IntervalData

contains_key(key[, context])

Returns whether this object's dict contains the given key.

extract_variables(variables[, context, ...])

Only keep variables specified.

get_cuid(key[, context])

Get the time-indexed CUID corresponding to the provided key

get_data()

Return a dictionary mapping CUIDs to values

get_data_at_interval_indices(indices)

get_data_at_time(time[, tolerance, prefer_left])

get_data_from_key(key[, context])

Returns the value associated with the given key.

get_intervals()

shift_time_points(offset)

Apply an offset to stored time points.

to_serializable()

Convert to json-serializable object.

update_data(other[, context])

Updates this object's data dict.

Member Documentation

concatenate(other, tolerance=0.0)[source]

Extend interval list and variable data lists with the intervals and variable values in the provided IntervalData

contains_key(key, context=None)

Returns whether this object’s dict contains the given key.

extract_variables(variables, context=None, copy_values=False)[source]

Only keep variables specified.

get_cuid(key, context=None)

Get the time-indexed CUID corresponding to the provided key

get_data()

Return a dictionary mapping CUIDs to values

get_data_from_key(key, context=None)

Returns the value associated with the given key.

shift_time_points(offset)[source]

Apply an offset to stored time points.

to_serializable()[source]

Convert to json-serializable object.

update_data(other, context=None)

Updates this object’s data dict.