Solver Core Interface (i_solver_core)

class pypint.solvers.cores.i_solver_core.ISolverCore

Bases: builtins.object

Interface for the Solver’s Cores

compute_error(state, **kwargs)

Computes the error of the current state

Parameters:state (ISolverState) – Current state of the solver.

compute_residual(state, **kwargs)

Computes the residual of the current state

Parameters:state (ISolverState) – Current state of the solver.

run(state, **kwargs)

Apply the solver core to the current state

Parameters:state (ISolverState) – Current state of the solver.

__weakref__

list of weak references to the object (if defined)

name = 'Solver Core Interface'

Human readable name of the solver’s core