reno.components.TimeRef

class reno.components.TimeRef

Bases: Reference

A reference to the current simulation timestep that can be used in equations.

Example

>>> from reno.components import TimeRef
>>> t = TimeRef()

>>> t + 3
(+ t 3)

>>> (t + 3).eval(4)
7

Methods

__init__()	Create an instance of a time reference for use in other equations.
astype(dtype)	Returns a symbolic operation to convert the output of this equation to the specified type.
clip(min, max)	Returns a symbolic operation for enforcing the output is between the passed min and max.
equal(obj)	Returns a symbolic operation for checking equality with passed object.
eval([t, save, force])	Return the current timestep.
find_parts_of_type(search_type[, ...])	Recursively search for all EquationParts in the tree of the specified type.
get_shape()	Get the size of the additional "data" dimension.
get_type()	Get the type of the target output of this equation expression.
is_static()	Convenience shortcut for reno.utils.is_static() - True if this equation doesn't rely on any dynamic values (thus constant), False if it does.
latex(**kwargs)	Get latex string representation.
mean([axis])	Returns a symbolic operation to find the series-wise mean of the array.
not_equal(obj)	Returns a symbolic operation for checking inequality with passed object.
pt(**refs)	Get a pytensor graph representing this piece of an equation.
pt_str(**refs)	Construct a string containing relevant pytensor code for this piece of the equation.
seek_refs([include_ref_types])	Recursively find a list of all References immediately underneath this part.
series_max()	Returns a symbolic operation to find the series-wise maximum of the array.
series_min()	Returns a symbolic operation to find the series-wise minimum of the array.
sum([axis])	Returns a symbolic operation to find the series-wise sum of the array.

Attributes

dtype	The type of each underlying value.
shape	The size of the data dimension, 1 by default.
timeseries	Returns symbolic operation for getting a timeseries view of the data.
label	Label is what's used in any visual representation (e.g. allows spaces where name does not.).
doc	A docstring to explain/describe the reference.

__annotations__ = {}

__module__ = 'reno.components'

__repr__()

Return repr(self).

Return type:

str

eval(t=0, save=False, force=False, **kwargs)

Return the current timestep.

Args have no effect but are accepted from recursive calls.

Parameters:

• t (int)

• save (bool)

• force (bool)

• kwargs (dict)

Return type:

int

latex(**kwargs)

Get latex string representation.

Parameters:

kwargs (dict)

Return type:

str

pt(**refs)

Get a pytensor graph representing this piece of an equation.

Parameters:

refs (dict[str, TensorVariable])

Return type:

TensorVariable

pt_str(**refs)

Construct a string containing relevant pytensor code for this piece of the equation. This is useful for “compiling” into pymc code.

Parameters:

refs (dict[str, str])

Return type:

str