Skip to main contentIBM Quantum Documentation
This page is from an old version of Qiskit SDK and does not exist in the latest version. We recommend you migrate to the latest version. See the release notes for more information.

OptimizerState

class OptimizerState(x, fun, jac, nfev, njev, nit)

GitHub

Bases: object

Base class representing the state of the optimizer.

This class stores the current state of the optimizer, given by the current point and (optionally) information like the function value, the gradient or the number of function evaluations. This dataclass can also store any other individual variables that change during the optimization.


Attributes

x

Type: Union[float, numpy.ndarray]

Current optimization parameters.

fun

Type: Optional[Callable[[Union[float, numpy.ndarray]], float]]

Function being optimized.

jac

Type: Optional[Callable[[Union[float, numpy.ndarray]], Union[float, numpy.ndarray]]]

Jacobian of the function being optimized.

nfev

Type: Optional[int]

Number of function evaluations so far in the optimization.

njev

Type: Optional[int]

Number of jacobian evaluations so far in the opimization.

nit

Type: Optional[int]

Number of optmization steps performed so far in the optimization.

Was this page helpful?
Report a bug or request content on GitHub.