energia.components.temporal.lag

energia.components.temporal.lag#

Temporal Lag

Functions

is_(a, b, /)

Same as a is b.

Classes

Lag([of, periods])

A number of temporal Periods.

cached_property(func)

class Lag(of: Periods | None = None, periods: int | float = 1)[source]#

Bases: _Name

A number of temporal Periods.

Variables:

  • label (str) – Label of the component, used for plotting. Defaults to None.

  • of (Periods) – Periods to lag. Defaults to None.

  • periods (int | float) – Number of periods to lag. Defaults to 1.

  • name (str) – Name of the component, generated based on the number of periods.

  • domains (list[Domain]) – List of Domains the lag features belong to. Defaults to [].

Note

  • Name is generated post init.

  • Domains are set as the program is built.

property I: Idx[source]#

Index set of periods - periods Basically, if t is set of hours and lag is 5 this returns the set of t - 5 i.e. an offset of 5 hours

property i: Idx[source]#
property horizon: Periods#

Horizon of the lag

Contents