polykin.math.roots

RootResult dataclass

Dataclass with root solution results.

ATTRIBUTE	DESCRIPTION
success	If True, the root 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	Root value. TYPE: float
f	Function value at root. TYPE: float

Source code in src/polykin/math/roots.py

@dataclass
class RootResult():
    """Dataclass with root solution results.

    Attributes
    ----------
    success: bool
        If `True`, the root was found.
    message: str
        Description of the exit status.
    nfeval: int
        Number of function evaluations.
    niter: int
        Number of iterations.
    x: float
        Root value.
    f: float
        Function value at root.
    """
    success: bool
    message: str
    nfeval: int
    niter: int
    x: float
    f: float