Module mici.errors

Exception types.

Expand source code Browse git
"""Exception types."""


class Error(RuntimeError):
    """Base class for errors."""


class IntegratorError(Error):
    """Error raised when integrator step fails."""


class NonReversibleStepError(IntegratorError):
    """Error raised when integrator step fails reversibility check."""


class ConvergenceError(IntegratorError):
    """Error raised when solver fails to converge within allowed iterations."""


class LinAlgError(Error):
    """Error raised when a matrix operation raises a linear algebra error."""


class HamiltonianDivergenceError(IntegratorError):
    """Error raised when integration of Hamiltonian dynamics diverges."""


class AdaptationError(Error):
    """Error raised when adaptation of transition parameters fails."""


class ReadOnlyStateError(Error):
    """Error raised when writing to attributes of read-only chain state."""

Classes

class Error (*args, **kwargs)

Base class for errors.

Expand source code Browse git
class Error(RuntimeError):
    """Base class for errors."""

Ancestors

  • builtins.RuntimeError
  • builtins.Exception
  • builtins.BaseException

Subclasses

class IntegratorError (*args, **kwargs)

Error raised when integrator step fails.

Expand source code Browse git
class IntegratorError(Error):
    """Error raised when integrator step fails."""

Ancestors

  • Error
  • builtins.RuntimeError
  • builtins.Exception
  • builtins.BaseException

Subclasses

class NonReversibleStepError (*args, **kwargs)

Error raised when integrator step fails reversibility check.

Expand source code Browse git
class NonReversibleStepError(IntegratorError):
    """Error raised when integrator step fails reversibility check."""

Ancestors

class ConvergenceError (*args, **kwargs)

Error raised when solver fails to converge within allowed iterations.

Expand source code Browse git
class ConvergenceError(IntegratorError):
    """Error raised when solver fails to converge within allowed iterations."""

Ancestors

class LinAlgError (*args, **kwargs)

Error raised when a matrix operation raises a linear algebra error.

Expand source code Browse git
class LinAlgError(Error):
    """Error raised when a matrix operation raises a linear algebra error."""

Ancestors

  • Error
  • builtins.RuntimeError
  • builtins.Exception
  • builtins.BaseException
class HamiltonianDivergenceError (*args, **kwargs)

Error raised when integration of Hamiltonian dynamics diverges.

Expand source code Browse git
class HamiltonianDivergenceError(IntegratorError):
    """Error raised when integration of Hamiltonian dynamics diverges."""

Ancestors

class AdaptationError (*args, **kwargs)

Error raised when adaptation of transition parameters fails.

Expand source code Browse git
class AdaptationError(Error):
    """Error raised when adaptation of transition parameters fails."""

Ancestors

  • Error
  • builtins.RuntimeError
  • builtins.Exception
  • builtins.BaseException
class ReadOnlyStateError (*args, **kwargs)

Error raised when writing to attributes of read-only chain state.

Expand source code Browse git
class ReadOnlyStateError(Error):
    """Error raised when writing to attributes of read-only chain state."""

Ancestors

  • Error
  • builtins.RuntimeError
  • builtins.Exception
  • builtins.BaseException