SolverErrors

Abstract Types

RLinearAlgebra.SolverErrorType
SolverError

An abstract supertype for structures that track and/or evaluate the quality of a solution for a linear system or least squares.

source
RLinearAlgebra.SolverErrorRecipeType
SolverErrorRecipe

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.

source

SolverError Structures

RLinearAlgebra.FullResidualRecipeType
FullResidual <: SolverErrorRecipe

A SolverErrorResidual structure for computing the norm of the full residual, $b-Ax$

Fields

  • residual::AbstractVector, a container for the residual $b-Ax$.
source

Exported Functions

RLinearAlgebra.complete_errorFunction
complete_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.
source
RLinearAlgebra.compute_errorFunction
compute_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
source