qutip_qtrl.errors

Exception classes for the Quantum Control library

Exceptions

Error	Base class for all qutip control exceptions
FunctionalError(msg)	A function behaved in an unexpected way .
GoalAchievedTerminate(fid_err)	Exception raised to terminate execution when the goal has been reached during the optimisation algorithm
GradMinReachedTerminate(gradient)	Exception raised to terminate execution when the minimum gradient normal has been reached during the optimisation algorithm
MaxFidFuncCallTerminate()	Exception raised to terminate execution when the number of calls to the fidelity error function has exceeded the maximum
MaxWallTimeTerminate()	Exception raised to terminate execution when the optimisation time has exceeded the maximum set in the config
OptimizationTerminate	Superclass for all early terminations from the optimisation algorithm
UsageError(msg)	A function has been used incorrectly.

exception qutip_qtrl.errors.Error

Base class for all qutip control exceptions

exception qutip_qtrl.errors.FunctionalError(msg)

A function behaved in an unexpected way .. attribute:: funcname

function name where error occurred

msg

Explanation

exception qutip_qtrl.errors.GoalAchievedTerminate(fid_err)

Exception raised to terminate execution when the goal has been reached during the optimisation algorithm

exception qutip_qtrl.errors.GradMinReachedTerminate(gradient)

Exception raised to terminate execution when the minimum gradient normal has been reached during the optimisation algorithm

exception qutip_qtrl.errors.MaxFidFuncCallTerminate

Exception raised to terminate execution when the number of calls to the fidelity error function has exceeded the maximum

exception qutip_qtrl.errors.MaxWallTimeTerminate

Exception raised to terminate execution when the optimisation time has exceeded the maximum set in the config

exception qutip_qtrl.errors.OptimizationTerminate

Superclass for all early terminations from the optimisation algorithm

exception qutip_qtrl.errors.UsageError(msg)

A function has been used incorrectly. Most likely when a base class was used when a sub class should have been. .. attribute:: funcname

function name where error occurred

msg

Explanation