ILMathpinv Method (InArraycomplex, Nullablecomplex)

ILNumerics Ultimate VS Documentation

ILNumerics - Technical Application Development

Moore-Penrose pseudo inverse of A.

[ILNumerics Computing Engine]

Namespace: ILNumerics
Assembly: ILNumerics.Computing (in ILNumerics.Computing.dll) Version: 5.5.0.0 (5.5.7503.3146)

Syntax

Copy

public static RetArray<complex> pinv(
	InArray<complex> A,
	Nullable<complex> tolerance = null
)

Public Shared Function pinv ( 
	A As InArray(Of complex),
	Optional tolerance As Nullable(Of complex) = Nothing
) As RetArray(Of complex)

Dim A As InArray(Of complex)
Dim tolerance As Nullable(Of complex)
Dim returnValue As RetArray(Of complex)

returnValue = ILMath.pinv(A, tolerance)

Parameters

A: Type: ILNumericsInArraycomplex
Input matrix.
tolerance (Optional): Type: SystemNullablecomplex
[Optional] Tolerance. Default: (null) - use default tolerance (see remarks).

Return Value

Type: RetArraycomplex
Pseudo inverse of input matrix A

Remarks

The function returns the pseudo inverse (Moore-Penrose pseudoinverse) of input matrix A. The return value will be of the same size as A.T. It will satisfy the following conditions:

A * pinv(A) * A = A
pinv(A) * A * pinv(A) = pinv(A)
pinv(A) * A is hermitian.
A * pinv(A) is hermitian.

pinv(InArraycomplex, Nullablecomplex) relies on svd(InArraycomplex), utilizing native Lapack functions internally. Singular values less than tolerance will be set to zero. As default tolerance the following equation is used: \\ tolerance = length(A) * norm(A) * eps, where

length(A) - the longest dimension of A.
norm(A) being the largest singular value of A.
eps - the smallest number greater than one.

[ILNumerics Computing Engine]

Reference

ILMath Class

pinv Overload

ILNumerics Namespace

MathInternal.pinv(InArraycomplex, Nullablecomplex)

MathInternal.svd(InArraycomplex)

Globalseps

MathInternal.norm(InArraycomplex, Double)