Skip to content

HaltReason

Bases: Enum

The reason for halting

Source code in q3as/algo/types.py 
 6
 7
 8
 9
10
11
12
13
14
15
16
class HaltReason(Enum):
    """
    The reason for halting
    """

    TOLERANCE = "tolerance"
    "The tolerance was reached"
    INTERRUPT = "interrupt"
    "The process was interrupted"
    MAXITER = "maxiter"
    "The maximum number of iterations was reached"

INTERRUPT = 'interrupt' class-attribute instance-attribute

The process was interrupted

MAXITER = 'maxiter' class-attribute instance-attribute

The maximum number of iterations was reached

TOLERANCE = 'tolerance' class-attribute instance-attribute

The tolerance was reached