polykin.math.optimization

OptimumResult dataclass

Dataclass with the results of the optimization.

ATTRIBUTE	DESCRIPTION
method	Method used to find the optimum. TYPE: str
success	If True, the optimum was found. TYPE: bool
message	Description of the exit status. TYPE: str
nfeval	Number of function evaluations. TYPE: int
niter	Number of iterations. TYPE: int
x	Optimum value. TYPE: float
f	Function value at the optimum. TYPE: float
df	Derivative at the optimum (if available). TYPE: float | None

Source code in src/polykin/math/optimization/results.py

@dataclass(frozen=True, slots=True)
class OptimumResult:
    """Dataclass with the results of the optimization.

    Attributes
    ----------
    method: str
        Method used to find the optimum.
    success: bool
        If `True`, the optimum was found.
    message: str
        Description of the exit status.
    nfeval: int
        Number of function evaluations.
    niter: int
        Number of iterations.
    x: float
        Optimum value.
    f: float
        Function value at the optimum.
    df: float | None
        Derivative at the optimum (if available).
    """

    method: str
    success: bool
    message: str
    nfeval: int
    niter: int
    x: float
    f: float
    df: float | None = None

    def __repr__(self) -> str:
        """Return a string representation of the optimum result."""
        result = (
            f" method: {self.method}\n"
            f"success: {colored_bool(self.success)}\n"
            f"message: {self.message}\n"
            f" nfeval: {self.nfeval}\n"
            f"  niter: {self.niter}\n"
            f"      x: {self.x:.8e}\n"
            f"      f: {self.f:.8e}"
        )
        if self.df is not None:
            result += f"\n     df: {self.df:.8e}"

        return result

__repr__

__repr__() -> str

Return a string representation of the optimum result.

Source code in src/polykin/math/optimization/results.py

def __repr__(self) -> str:
    """Return a string representation of the optimum result."""
    result = (
        f" method: {self.method}\n"
        f"success: {colored_bool(self.success)}\n"
        f"message: {self.message}\n"
        f" nfeval: {self.nfeval}\n"
        f"  niter: {self.niter}\n"
        f"      x: {self.x:.8e}\n"
        f"      f: {self.f:.8e}"
    )
    if self.df is not None:
        result += f"\n     df: {self.df:.8e}"

    return result