Returns the numerical rank of a matrix using the specified tolerance.
Namespace: Extreme.Mathematics.LinearAlgebra
Assembly: Extreme.Numerics (Extreme.Numerics)
Syntax
| Visual Basic (Declaration) |
|---|
Public Overrides Function Rank ( _ tolerance As Double _ ) As Integer |
| C# |
|---|
public override int Rank ( double tolerance ) |
| C++ |
|---|
public: virtual int Rank ( double tolerance ) override |
Parameters
- tolerance (System.Double)
- The absolute tolerance used to determine if a matrix component is considered zero.
Return Value
An integer indicating the numerical rank of the matrix.Remarks
If tolerance is negative, the default tolerance is used. The default tolerance
is equal to the product of the machine precision, the largest dimension of the matrix, and the one-norm of the matrix.
The rank is determined by counting the number of diagonal elements of the upper-triangular component of
the decomposition whose absolute value is greater than the tolerance.
