OutputArrayHeights
- class cubie.outputhandling.output_sizes.OutputArrayHeights(state: int = 1, observables: int = 1, state_summaries: int = 1, observable_summaries: int = 1, per_variable: int = 1)[source]
Bases:
ArraySizingClassHeights of time-series and summary outputs.
- state
Height of state output arrays, including a slot for time stamps when requested.
- Type:
int, default 1
- observables
Height of observable output arrays.
- Type:
int, default 1
- state_summaries
Height of state summary outputs.
- Type:
int, default 1
- observable_summaries
Height of observable summary outputs.
- Type:
int, default 1
- per_variable
Height reserved per tracked variable for summary outputs.
- Type:
int, default 1
- classmethod from_output_fns(output_fns: OutputFunctions) OutputArrayHeights[source]
Compute array heights from configured output functions.
- Parameters:
output_fns – Output function factory describing which values are saved and how summaries are aggregated.
- Returns:
Array heights derived from the output configuration.
- Return type:
OutputArrayHeights
Notes
The state output height reserves an extra row when time saving is enabled so that timestamps align with the saved states.
- observable_summaries: int
- observables: int
- per_variable: int
- state: int
- state_summaries: int