OutputFunctions

Bases: CUDAFactory

Factory that compiles and caches output management functions.

Parameters:

max_states – Maximum number of state variables in the system.
max_observables – Maximum number of observable variables in the system.
output_types – Types of output to generate. Defaults to [“state”].
saved_state_indices – Indices of state variables to save in time-domain output.
saved_observable_indices – Indices of observable variables to save in time-domain output.
summarised_state_indices – Indices of state variables to include in summary calculations.
summarised_observable_indices – Indices of observable variables to include in summary calculations.
sample_summaries_every – Time interval between summary metric samples. Used by derivative metrics to scale finite differences. Defaults to None.
precision – Numerical precision for output calculations. Defaults to np.float32.

Notes

The constructor converts the provided options into an OutputConfig instance and installs it as the compile settings. CUDA callables are only built once per configuration and cached by cubie.CUDAFactory.

property buffer_sizes_dict: dict[str, int]: Dictionary of buffer sizes for each output type.

build() → OutputFunctionCache[source]

Compile output functions and calculate memory requirements.

Returns:: Container with compiled functions that target the current configuration.
Return type:: OutputFunctionCache

Notes

This method is invoked lazily by cubie.CUDAFactory the first time a compiled function is requested. The resulting cache is reused until configuration settings change.

property compile_flags: OutputCompileFlags: Compile flags for the active configuration.

property has_summary_outputs: bool: Whether any summary output is enabled.

property has_time_domain_outputs: bool: Whether any time-domain output is enabled.

property n_saved_observables: int: Number of observable variables saved in time-domain output.

property n_saved_states: int: Number of state variables saved in time-domain output.

property n_summarised_observables: int: Number of observables included in summary calculations.

property n_summarised_states: int: Number of states included in summary calculations.

property observable_summaries_buffer_height: int: Total height of the buffer for observable summary calculations.

property observable_summaries_output_height: int: Height of the observable summary output array.

property output_array_heights: OutputArrayHeights: Output array height helper built from the active configuration.

property output_types: set[str]: Configured output types.

property save_state_func: Callable: Compiled state saving function.

property save_summary_metrics_func: Callable: Compiled summary saving function.

property save_time: bool: Whether time samples are saved alongside states.

property saved_observable_indices: ndarray[Any, dtype[int64]]: Indices of observables saved in time-domain output.

property saved_state_indices: ndarray[Any, dtype[int64]]: Indices of states saved in time-domain output.

property state_summaries_buffer_height: int: Total height of the buffer for state summary calculations.

property state_summaries_output_height: int: Height of the state summary output array.

property summaries_buffer_height_per_var: int: Height of the summary buffer required per variable.

property summaries_output_height_per_var: int: Height of the summary output array per variable.

property summarised_observable_indices: ndarray[Any, dtype[int64]]: Indices of observables tracked by summary metrics.

property summarised_state_indices: ndarray[Any, dtype[int64]]: Indices of states tracked by summary metrics.

property summary_legend_per_variable: dict[str, int]: Mapping of summary metric names to their per-variable heights.

property summary_unit_modifications: dict[int, str]: Mapping of summary indices to unit modification strings.

property total_summary_buffer_size: int: Total size required for all summary buffers combined.

update(updates_dict: dict[str, object] | None = None, silent: bool = False, **kwargs: object) → set[str][source]

Update compile settings through the factory interface.

Parameters:

updates_dict – Dictionary of parameter updates to apply.
silent – When True, suppress warnings about unrecognised parameters.
**kwargs – Additional parameter updates to apply.

Returns:

Recognised parameter names that were successfully updated.

Return type:

set[str]

Raises:

KeyError – If unrecognised parameters are provided and silent is False.

Notes

Use this method for coordinated configuration updates alongside other components by passing silent=True so unrelated keys fall through without raising.

property update_summaries_func: Callable: Compiled summary update function.