SolverErrors
Abstract Types
RLinearAlgebra.SolverError
— TypeSolverError
An abstract supertype for structures that track and/or evaluate the quality of a solution for a linear system or least squares.
RLinearAlgebra.SolverErrorRecipe
— TypeSolverErrorRecipe
An abstract supertype for structures that contain the user-controlled parameters, linear system dependent parameters, and preallocated memory for techniques that evaluate the solution to a linear solver.
SolverError Structures
RLinearAlgebra.FullResidual
— TypeFullResidual <: SolverError
A SolverError
structure for computing the norm of the full residual, $b-Ax$.
Fields
- None
RLinearAlgebra.FullResidualRecipe
— TypeFullResidual <: SolverErrorRecipe
A SolverErrorResidual
structure for computing the norm of the full residual, $b-Ax$
Fields
residual::AbstractVector
, a container for the residual $b-Ax$.
Exported Functions
RLinearAlgebra.complete_error
— Functioncomplete_error(
error::SolverError,
solver::Solver,
A::AbstractMatrix,
b::AbstractVector
)
A function that generates a SolverErrorRecipe
given the arguments.
Arguments
error::SolverError
, a user-specified solver error method.solver::Solver
, a user-specified solver method.A::AbstractMatrix
, a coefficient matrix.b::AbstractVector
, a constant vector.
Returns
- A
SolverErrorRecipe
object.
RLinearAlgebra.compute_error
— Functioncompute_error(
error::SolverErrorRecipe,
solver::SolverRecipe,
x::AbstractVector,
A::AbstractMatrix,
b::AbstractVector
)
A function that evaluates the error for a proposed solution vector.
Arguments
error::SolverErrorRecipe
, a fully initialized realization for a solver error method for a specific linear system or least squares problem.solver::SolverRecipe
, a fully initialized realization for a solver method for a specific linear system.x::AbstractVector
, a vector for the proposed solution.A::AbstractMatrix
, a coefficient matrix.b::AbstractVector
, a constant vector.
Returns
- Returns
nothing