Threshold Incomplete Cholesky Preconditioner<T> Class
Definition
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 10.9.0
public sealed class ThresholdIncompleteCholeskyPreconditioner<T> : Preconditioner<T>
- Inheritance
- Object → LinearOperator<T> → Preconditioner<T> → ThresholdIncompleteCholeskyPreconditioner<T>
Type Parameters
- T
- The real or complex floating-point scalar type.
Remarks
Successful lower factors have positive real diagonals and define Hermitian positive definite preconditioners. This does not certify the input as positive definite. Incomplete Cholesky may break down on positive definite inputs; shifts and ordering are explicit options.
Zero drop tolerance and a cap of at least the matrix order minus one permit complete Cholesky. Setup generates candidate fill one column at a time using retained sparse factors. The cap bounds retained storage, while setup cost depends on intersections of retained columns. Application work is proportional to retained entries.
The source is retained for Refresh() and never modified. Applications accept and return original-coordinate vectors. Distinct-destination applications may run concurrently; refresh requires exclusive access.
Constructors
| Threshold | Constructs threshold incomplete Cholesky with explicit dropping, fill, pivot protection and modification options. |
| Threshold | Constructs threshold incomplete Cholesky with explicit dropping, fill, pivot protection and modification options. |
Properties
| Column |
Gets the number of columns in the matrix.
(Inherited from LinearOperator<T>) |
| Column |
Gets or sets the index of labels for the columns of the matrix.
(Inherited from LinearOperator<T>) |
| Dropped | Gets the number of nonzero Schur off-diagonal candidates discarded in the last successful factorization. |
| Drop | Gets the requested relative drop tolerance. |
| Element |
Gets the element type of the matrix.
(Inherited from LinearOperator<T>) |
| Factorization | Gets the number of successful factorizations, including construction. |
| Factor | Gets the number of retained lower factor entries, including the diagonal. |
| Linear |
Gets the linear operator to which the Preconditioner<T> applies.
(Inherited from Preconditioner<T>) |
| Maximum | Gets the requested cap on off-diagonal factor entries per column. |
| Minimum | Gets the minimum pivot before taking its square root, relative to its shifted row maximum, or zero for an empty system. |
| Modified | Gets whether dropped real Schur coefficients are compensated on both incident diagonals. |
| Row |
Gets the number of rows in the matrix.
(Inherited from LinearOperator<T>) |
| Row |
Gets or sets the index of labels for the rows of the matrix.
(Inherited from LinearOperator<T>) |
Methods
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Estimate |
Calculates an estimate for the condition number of a matrix.
(Inherited from LinearOperator<T>) |
| Get |
Calculates the determinant of a matrix.
(Inherited from LinearOperator<T>) |
| Get | Serves as the default hash function. (Inherited from Object) |
| Get |
Calculates the inverse matrix..
(Inherited from LinearOperator<T>) |
| Get |
Calculates the inverse of the factorized
matrix.
(Inherited from LinearOperator<T>) |
| Get | Gets the Type of the current instance. (Inherited from Object) |
| IsSingular |
Gets whether the matrix
is singular.
(Inherited from LinearOperator<T>) |
| Least |
Solves the system of linear equations for the specified
right-hand side matrix in the least squares sense.
(Inherited from LinearOperator<T>) |
| Least |
Solves the system of linear equations for the specified
right-hand side vector.
(Inherited from LinearOperator<T>) |
| Least |
Solves the system of linear equations for the specified
right-hand side dense matrix in the least squares sense and optionally overwrites the
right-hand side with the solution.
(Inherited from LinearOperator<T>) |
| Least |
Solves the system of linear equations for the specified
right-hand side dense vector in the least squares sense and optionally
overwrites the right-hand side with the solution.
(Inherited from LinearOperator<T>) |
| Least |
Solves a system of equations defined by the matrix and multiple right-hand sides in the least squares sense.
(Inherited from LinearOperator<T>) |
| Least |
Solves a system of equations defined by the matrix and the specified right-hand side in the least squares sense.
(Inherited from Preconditioner<T>) |
| Multiply( | Applies the linear operator to a matrix. (Inherited from LinearOperator<T>) |
| Multiply( | Applies the linear operator to a vector. (Inherited from LinearOperator<T>) |
| Multiply | Applies the transpose of the linear operator to a matrix. (Inherited from LinearOperator<T>) |
| Multiply | Applies the (conjugate) transpose of the linear operator to a vector. (Inherited from LinearOperator<T>) |
| Rank() |
Returns the numerical rank of a matrix.
(Inherited from LinearOperator<T>) |
| Rank( |
Returns the numerical rank of a matrix using the specified tolerance.
(Inherited from Preconditioner<T>) |
| Refresh | Rebuilds factors from the current logical matrix coefficients and original options. |
| Solve( |
Solves the system of linear equations for the specified
right-hand side matrix.
(Inherited from LinearOperator<T>) |
| Solve( |
Solves the system of linear equations for the specified
right-hand side vector.
(Inherited from LinearOperator<T>) |
| Solve( |
Solves the system of linear equations for the specified
right-hand side dense matrix and optionally overwrites the
right-hand side with the solution.
(Inherited from LinearOperator<T>) |
| Solve( |
Solves the system of linear equations for the specified
right-hand side dense vector and optionally
overwrites the right-hand side with the solution.
(Inherited from LinearOperator<T>) |
| Solve |
Solves a system of equations defined by the matrix and multiple right-hand sides.
(Inherited from LinearOperator<T>) |
| Solve |
Solves a system of equations defined by the matrix and the specified right-hand side.
(Inherited from LinearOperator<T>) |
| Solve |
Solves a system of equations defined by the matrix and the specified right-hand side.
(Overrides Preconditioner<T>.SolveInto(TransposeOperation, Vector<T>, Vector<T>)) |
| Solve |
Solves a system of equations defined by the matrix and multiple right-hand sides.
(Inherited from LinearOperator<T>) |
| Solve |
Solves the transposed system of linear equations for the specified
right-hand side matrix.
(Inherited from LinearOperator<T>) |
| Solve |
Solves the system of linear equations for the specified
right-hand side vector.
(Inherited from LinearOperator<T>) |
| Solve |
Solves the transposed system of linear equations for the specified
right-hand side dense matrix and optionally overwrites the
right-hand side with the solution.
(Inherited from LinearOperator<T>) |
| Solve |
Solves the transposed system of linear equations for the specified
right-hand side dense vector and optionally
overwrites the right-hand side with the solution.
(Inherited from LinearOperator<T>) |
| Solve |
Solves a system of equations defined by the matrix and multiple right-hand sides.
(Inherited from LinearOperator<T>) |
| Solve |
Solves a system of equations defined by the matrix and the specified right-hand side.
(Inherited from LinearOperator<T>) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |