Represents an iterative algorithm for solving sparse linear systems.
Extreme.Numerics.Net40 (in Extreme.Numerics.Net40.dll) Version: 6.0.16073.0 (6.0.16312.0)
| Name | Description |
---|
 | ConvergenceTests |
Gets the collection of convergence tests for the algorithm.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.) |
 | EstimatedError |
Gets a value indicating the size of the absolute
error of the result.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.) |
 | EvaluationsNeeded |
Gets the number of evaluations needed to execute the algorithm.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.) |
 | EvaluationsRemaining |
Gets the number of evaluations still available.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.) |
 | HasSharedDegreeOfParallelism |
Indicates whether the degree of parallelism is a property that is shared
across instances.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.) |
 | InitialGuess |
Gets or sets the solution of the system of equations.
|
 | IterationsNeeded |
Gets the number of iterations needed by the
algorithm to reach the desired accuracy.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.) |
 | IterationsRemaining |
Gets the number of iterations remaining.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.) |
 | LastCorrection |
Gets the vector containing the residuals of the solution.
|
 | LeftPreconditioner | |
 | LinearOperator |
Gets the sparse matrix of the system of equations.
|
 | MaxDegreeOfParallelism |
Gets or sets the maximum degree of parallelism enabled by this instance.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.) |
 | MaxEvaluations |
Gets or sets the maximum number of evaluations during the calculation.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.) |
 | MaxIterations | Gets or sets the maximum number of iterations
to use when approximating the roots of the target
function.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.) |
 | MinIterations |
Gets or sets the minimum iterations that have to be performed.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.) |
 | ParallelOptions |
Gets the configuration for the parallel behavior of the algorithm.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.) |
 | Preconditioner | |
 | Residuals |
Gets the vector containing the residuals of the solution.
|
 | ResidualTest |
Gets the convergence test based on the size of the residuals.
|
 | Result |
Gets or sets the solution of the system of equations.
(Overrides ManagedIterativeAlgorithmT, TError, TReportResult.) |
 | RightHandSide |
Gets or sets the right hand side of the system of equations.
|
 | SolutionReport |
Gets the result of an algorithm after it has executed.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.) |
 | SolutionTest |
Gets the convergence test based on the size of the residuals.
|
 | Status | (Inherited from ManagedIterativeAlgorithmT, TError, TReport.) |
 | ThrowExceptionOnFailure |
Gets or sets a value indicating whether to throw an
exception when the algorithm fails to converge.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.) |
| Name | Description |
---|
 | Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
 | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
 | GetType | Gets the Type of the current instance. (Inherited from Object.) |
 | IncrementEvaluations |
Increments the number of evaluations by one.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.) |
 | IncrementEvaluations(Int32) |
Increments the number of evaluations by the specified amount.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.) |
 | Iterate |
Performs one iteration of the algorithm.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.) |
 | Iterated |
Performs operations after the iteration stage of the algorithm is complete.
(Overrides ManagedIterativeAlgorithmT, TError, TReportIterated.) |
 | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
 | OnConvergence |
Performs any tasks after the main algorithm has converged.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.) |
 | OnFailure |
Performs any tasks after the main algorithm has failed to converge.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.) |
 | OnInit |
Performs initialization tasks.
(Overrides ManagedIterativeAlgorithmT, TError, TReportOnInit.) |
 | ReportFailure |
Records the results of an algorithm in case it fails.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.) |
 | ReportResult |
Records the results of an algorithm.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.) |
 | ReportSuccess |
Records the results of a algorithm that converged successfully.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.) |
 | ResetEvaluations |
Resets the number of evaluations to zero.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.) |
 | Restart |
Prepares the algorithm to be run again with possibly different inputs.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.) |
 | Run |
Runs the algorithm.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.) |
 | Run(ParallelOptions) |
Runs the algorithm using the specified parallelization options.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.) |
 | SetResult |
Sets the results of an algorithm's execution.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.) |
 | Solve |
Solves the system of equations and returns the solution.
|
 | Solve(VectorT) |
Solves the system of equations for the specified right-hand side and returns the result.
|
 | Solve(VectorT, VectorT) |
Solves the system of equations for the specified right-hand side and returns the result.
|
 | TestConvergence |
Checks whether the algorithm has converged.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.) |
 | ThreadSafeIncrementEvaluations |
Increments the number of evaluations by one.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.) |
 | ThreadSafeIncrementEvaluations(Int32) |
Increments the number of evaluations by the specified amount.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.) |
 | ThrowConvergenceException | (Inherited from ManagedIterativeAlgorithmT, TError, TReport.) |
 | ToString | Returns a string that represents the current object. (Inherited from Object.) |
The only operation the matrix of the linear system must support is matrix-vector multiplication.
All matrix types support this operation, but any object whose type inherits from LinearOperator will do.
To solve a system of equations, create a new instance of one of the classes above and pass the matrix or linear operator
to the constructor. You can optionally set the Preconditioner property to a corresponding instance of one
of the PreconditionerT classes.
Finally, call the Solve(VectorT) method to run the algorithm.