get_algorithm_step

cubie.integrators.get_algorithm_step(precision: type, settings: Mapping[str, Any] | None = None, warn_on_unused: bool = False, **kwargs: Any) → BaseAlgorithmStep[source]

Thin factory which filters arguments and instantiates an algorithm.

Parameters:

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

  • settings – Mapping of settings applied to the algorithm. Must include "algorithm" and can contain any keywords from ALL_ALGORITHM_STEP_PARAMETERS.

  • warn_on_unused – If True, issue a warning for settings that the selected algorithm does not accept.

  • **kwargs – Additional keywords from ALL_ALGORITHM_STEP_PARAMETERS. These override entries provided in settings.

Returns:

The requested step instance.

Return type:

BaseAlgorithmStep

Raises:

ValueError – Raised when settings[‘algorithm’] does not match a known algorithm type or when required configuration keys are missing.