ComplexFloatLUDecomp (FsODE)

FsODE

Documentation for 0.0.2

ComplexFloatLUDecomp Type

Namespace: Altaxo.Calc.LinearAlgebra
Assembly: AltaxoCore.Redist.dll
Base Type: Algorithm
All Interfaces: IAlgorithm

This class computes the LU factorization of a general n by n ComplexFloatMatrix.

Constructors

Constructor Description


                
                  
                    
                      ComplexFloatLUDecomp(matrix)

Full Usage: ComplexFloatLUDecomp(matrix)

Parameters:

matrix : IROComplexFloatMatrix - The matrix to factor.

Constructor for LU decomposition class. The constructor performs the factorization and the upper and lower matrices are accessible by the U and L properties.

matrix : IROComplexFloatMatrix: The matrix to factor.

ArgumentNullException	matrix is null.
NotSquareMatrixException	matrix is not square.

Instance members

Instance member Description


                
                  
                    
                      this.GetDeterminant

Full Usage: this.GetDeterminant

Returns: ComplexFloat he determinant of the matrix.

Calculates the determinant of the matrix.

Returns: ComplexFloat: he determinant of the matrix.


                
                  
                    
                      this.GetInverse

Full Usage: this.GetInverse

Returns: ComplexFloatMatrix the inverse of the matrix.

Calculates the inverse of the matrix.

Returns: ComplexFloatMatrix: the inverse of the matrix.

SingularMatrixException

matrix is singular.


                
                  
                    
                      this.GetPivots

Full Usage: this.GetPivots

Returns: int[] array of ints indicating which rows were interchanged during factorization.

Returns an array of ints indicating which rows were interchanged during factorization. Row i was interchanged with row pivots[i].

Returns: int[]: array of ints indicating which rows were interchanged during factorization.


                
                  
                    
                      this.IsSingular

Full Usage: this.IsSingular

Returns: bool true if the matrix is singular; otherwise, false.

Return a value indicating whether the matrix is singular.

Returns: bool: true if the matrix is singular; otherwise, false.

Full Usage: this.L

Returns: ComplexFloatMatrix the lower matrix.

Returns the lower matrix.

Returns: ComplexFloatMatrix: the lower matrix.

Full Usage: this.Solve

Parameters:

B : IROComplexFloatMatrix - RHS side of the system.

Returns: ComplexFloatMatrix the solution matrix, X.

Solves a system on linear equations, AX=B, where A is the factored matrixed.

B : IROComplexFloatMatrix: RHS side of the system.

Returns: ComplexFloatMatrix: the solution matrix, X.

ArgumentNullException	B is null.
SingularMatrixException	Ais singular.
ArgumentException	The number of rows of A and B must be the same.

Full Usage: this.Solve

Parameters:

B : IROComplexFloatVector - RHS side of the system.

Returns: ComplexFloatVector the solution vector, X.

Solves a system on linear equations, AX=B, where A is the factored matrixed.

B : IROComplexFloatVector: RHS side of the system.

Returns: ComplexFloatVector: the solution vector, X.

ArgumentNullException	B is null.
SingularMatrixException	A is singular.
ArgumentException	The number of rows of A and the length of B must be the same.

Full Usage: this.U

Returns: ComplexFloatMatrix the upper matrix.

Returns the upper matrix.

Returns: ComplexFloatMatrix: the upper matrix.