XLPack 6.1
Excel VBA Numerical Library Reference Manual
Loading...
Searching...
No Matches

◆ Zlantr()

Function Zlantr ( Norm As  String,
Uplo As  String,
Diag As  String,
M As  Long,
N As  Long,
A() As  Complex,
Optional Info As  Long 
)

One norm, Frobenius norm, infinity norm, or element of largest absolute value of a complex trapezoidal or triangular matrix

Purpose
This routine returns the value of the one norm, the Frobenius norm, the infinity norm, or the element of largest absolute value of a complex trapezoidal or triangular matrix A.
Returns
Double
max(abs(Aij)) when Norm = "M",
norm1(A) when Norm = "1" or "O",
normI(A) when Norm = "I", or
normF(A) when Norm = "F" or "E"

where norm1 denotes the one norm of a matrix (maximum column sum), normI denotes the infinity norm of a matrix (maximum row sum) and normF denotes the Frobenius norm of a matrix (square root of sum of squares). Note that max(abs(Aij)) is not a consistent matrix norm.
Parameters
[in]NormSpecifies the value to be returned by Zlantr as described above.
[in]UploSpecifies whether the matrix A is upper or lower trapezoidal.
= "U": Upper trapezoidal.
= "L": Lower trapezoidal.
Note that A is triangular instead of trapezoidal if M = N.
[in]DiagSpecifies whether or not the matrix A has unit diagonal.
= 'N': Non-unit diagonal.
= 'U': Unit diagonal.
[in]MThe number of rows of the matrix A. (M >= 0, and if Uplo = "U", M <= N)
When M = 0, returns zero.
[in]NThe number of columns of the matrix A. (N >= 0, and if Uplo = "L", N <= M)
When N = 0, returns zero.
[in]A()Array A(LA1 - 1, LA2 - 1) (LA1 >= M, LA2 >= N)
The trapezoidal matrix A (A is triangular if M = N). If Uplo = "U", the leading M by N upper trapezoidal part of the array A contains the upper trapezoidal matrix, and the strictly lower triangular part of A is not referenced. If Uplo = "L", the leading M by N lower trapezoidal part of the array A contains the lower trapezoidal matrix, and the strictly upper triangular part of A is not referenced. Note that when Diag = "U", the diagonal elements of A are not referenced and are assumed to be one.
[out]Info(Optional)
= 0: Successful exit.
= -1: The argument Norm had an illegal value. (Norm <> "M", "1", "O", "I", "F" nor "E")
= -2: The argument Uplo had an illegal value. (Uplo <> "U" nor "L")
= -3: The argument Diag had an illegal value. (Diag <> "N" nor "U")
= -4: The argument M had an illegal value. (M < 0, Uplo = "U" and M > N)
= -5: The argument N had an illegal value. (N < 0, Uplo = "L" and N > M)
= -6: The argument A() is invalid.
Reference
LAPACK