BisectionOptimizer

Class Arguments

Argument	Type	Default Value
actor_min	TFloat
actor_max	TFloat
actor_component	Parametrizable
actor_name	TStr
monitor_component	Measurable
monitor_name	TStr
timestep		0.000325
epsilon		0.01
max_steps		20
switch_actor	TBool	False

Bold arguments are mandatory. For more documentation on the listed arguments refer to the class definition below. If parameters appear in this list but not in the class definition below, please recursively check the linked base classes for the definition of the parameter.

Inheritance Diagram

Example Component Dictionary

   {
    "optimizers_example": {
        "classname": "atomiq.components.optimizers.BisectionOptimizer",
        "arguments": {
            "actor_min": "<mandatory parameter (TFloat)>",
            "actor_max": "<mandatory parameter (TFloat)>",
            "actor_component": "<mandatory parameter (Parametrizable)>",
            "actor_name": "<mandatory parameter (TStr)>",
            "monitor_component": "<mandatory parameter (Measurable)>",
            "monitor_name": "<mandatory parameter (TStr)>",
            "timestep": 0.000325,
            "epsilon": 0.01,
            "max_steps": 20,
            "switch_actor": false
        }
    }
}

Class Description

class atomiq.components.optimizers.BisectionOptimizer(timestep=0.000325, epsilon=0.01, max_steps=20, switch_actor=False, *args, **kwargs)

Bases: BoundOptimizer

An optimizer that uses bisection to achieve the optimization target on the monitor

Parameters:

• timestep -- The time the individual steps in the algorithm take

• epsilon -- Acceptable relative difference from the target value (default 0.01, i.e. 1% of the target value)

• switch_actor (TBool) -- If True, the actor (needs to be Switchable) is switched on before the measurement of the monitor and switched off after (default False)