Minimum Residual Solver<T> Class
Definition
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 10.9.0
public sealed class MinimumResidualSolver<T> : IterativeSparseSolver<T>
- Inheritance
- Object → ManagedIterativeAlgorithm<DenseVector<T>, T, SolutionReport<DenseVector<T>, T>> → IterativeSparseSolver<T> → MinimumResidualSolver<T>
Type Parameters
- T
- The real or complex floating-point scalar type.
Remarks
The operator may be indefinite. Explicit matrices must be Hermitian; callers must ensure that matrix-free operators are Hermitian. Identity preconditioning is used by default. A supplied Preconditioner must remain a fixed linear, Hermitian positive-definite operator throughout each solve. The inherited LeftPreconditioner is not applied.
With a supplied preconditioner, residual minimization uses its induced norm. Stopping criteria still use the residual of the original system.
Convergence uses the true residual of the original system. Compatible singular systems can converge, but no minimum-length solution is promised. Lanczos breakdown with an unsatisfied residual, or an observed invalid preconditioner metric, reports RoundOffError. Arbitrary operator and preconditioner symmetry or definiteness is not certified.
Constructors
| Minimum | Constructs a MINRES solver for a symmetric or Hermitian linear operator. |
Properties
| Convergence |
Gets the collection of convergence tests for the algorithm.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |
| Estimated | Gets the Euclidean norm of the true residual at termination. (Inherited from IterativeSparseSolver<T>) |
| Evaluations |
Gets the number of evaluations needed to execute the algorithm.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |
| Has |
Indicates whether the degree of parallelism is a property that is shared
across instances.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |
| Initial |
Gets or sets the initial guess for the solution.
(Inherited from IterativeSparseSolver<T>) |
| Iterations |
Gets the number of iterations needed by the
algorithm to reach the desired accuracy.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |
| Last |
Gets the most recent correction to the solution.
(Inherited from IterativeSparseSolver<T>) |
| Left |
Gets or sets the Preconditioner<T>.
(Inherited from IterativeSparseSolver<T>) |
| Linear |
Gets the sparse matrix of the system of equations.
(Inherited from IterativeSparseSolver<T>) |
| Max |
Gets or sets the maximum degree of parallelism enabled by this instance.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |
| Max |
Gets or sets the maximum number of evaluations during the calculation.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |
| Max | Gets or sets the maximum number of iterations
to use when approximating the roots of the target
function.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |
| Min |
Gets or sets the minimum iterations that have to be performed.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |
| Parallel |
Gets or sets the configuration for the parallel behavior of the algorithm.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |
| Preconditioner |
Gets or sets the Preconditioner<T>.
(Inherited from IterativeSparseSolver<T>) |
| Residuals |
Gets the vector containing the residuals of the solution.
(Inherited from IterativeSparseSolver<T>) |
| Residual |
Gets the convergence test based on the size of the residuals.
(Inherited from IterativeSparseSolver<T>) |
| Result |
Gets the approximation to the solution from the most recent solve.
(Inherited from IterativeSparseSolver<T>) |
| Right |
Gets or sets the right hand side of the system of equations.
(Inherited from IterativeSparseSolver<T>) |
| Solution |
Gets the result of an algorithm after it has executed.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |
| Solution |
Gets the optional convergence test based on the size of the solution correction.
(Inherited from IterativeSparseSolver<T>) |
| Status |
Gets the AlgorithmStatus following
an execution of the algorithm.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |
| Throw |
Gets or sets whether to throw an
exception when the algorithm fails to converge.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |
Methods
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Get | Serves as the default hash function. (Inherited from Object) |
| Get | Gets the Type of the current instance. (Inherited from Object) |
| Solve() |
Solves the system of equations and returns the solution.
(Inherited from IterativeSparseSolver<T>) |
| Solve( |
Solves the system of equations for the specified right-hand side and returns the result.
(Inherited from IterativeSparseSolver<T>) |
| Solve( |
Solves the system of equations for the specified right-hand side and returns the result.
(Inherited from IterativeSparseSolver<T>) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |