conatus.expert.SecantRoot

class conatus.expert.SecantRoot(mu, converged, residual, iterations, last_step, tol, reasons=<factory>)

Bases: object

Result of conatus.floquet.hill_general.secant_root().

mu: the last iterate; converged: the last secant step is below tol; residual: the scaled determinant |det M(mu) / det M(start)| at mu (what the secant drives to zero); iterations: secant steps taken (none for a stop on equal determinants); last_step: |mu_k - mu_(k-1)|; reasons: why it is not converged (empty when converged).

v0.1 returned the tuple (mu, reasons); unpacking mu, why = secant_root(...) and indexing [0]/[1] keep working through v0.1 with a DeprecationWarning; use r.mu and r.reasons.

Parameters:

• mu (complex)

• converged (bool)

• residual (float)

• iterations (int)

• last_step (float)

• tol (float)

• reasons (list[str])

mu: complex

converged: bool

residual: float

iterations: int

last_step: float

tol: float

reasons: list[str]

explain()

The root, whether it converged (last step vs tol), iterations and scaled determinant.

Return type:

str