get_controller

cubie.integrators.get_controller(precision: type[float16] | type[float32] | type[float64] | dtype[float16] | dtype[float32] | dtype[float64], settings: Mapping[str, Any] | None = None, warn_on_unused: bool = False, **kwargs: Any) → BaseStepController[source]

Return a controller instance from a settings mapping.

Parameters:

  • precision – Floating-point dtype used when compiling the controller.

  • settings – Mapping of step control keyword arguments supplied by the caller. Values in settings are merged with kwargs. The mapping must include "step_controller" to identify the controller factory.

  • warn_on_unused – Emit a warning when unused settings remain after filtering.

  • **kwargs – Additional keyword arguments that override entries in settings.

Returns:

Instance of the requested controller.

Return type:

BaseStepController

Raises:

ValueError – Raised when step_controller does not match a known controller type or when required configuration keys are missing.