?geequ

Developer Reference for Intel® oneAPI Math Kernel Library for C

Download PDF

ID 766684

Date 3/22/2024

Version

Public

A newer version of this document is available. Customers should click here to go to the newest version.

Visible to Intel only — GUID: GUID-C20CD22A-5C1F-42F8-9961-63AF7421295B

View Details

?geequ

Computes row and column scaling factors intended to equilibrate a general matrix and reduce its condition number.

Syntax

lapack_int LAPACKE_sgeequ( int matrix_layout, lapack_int m, lapack_int n, const float* a, lapack_int lda, float* r, float* c, float* rowcnd, float* colcnd, float* amax );

lapack_int LAPACKE_dgeequ( int matrix_layout, lapack_int m, lapack_int n, const double* a, lapack_int lda, double* r, double* c, double* rowcnd, double* colcnd, double* amax );

lapack_int LAPACKE_cgeequ( int matrix_layout, lapack_int m, lapack_int n, const lapack_complex_float* a, lapack_int lda, float* r, float* c, float* rowcnd, float* colcnd, float* amax );

lapack_int LAPACKE_zgeequ( int matrix_layout, lapack_int m, lapack_int n, const lapack_complex_double* a, lapack_int lda, double* r, double* c, double* rowcnd, double* colcnd, double* amax );

Include Files

mkl.h

Description

The routine computes row and column scalings intended to equilibrate an m-by-n matrix A and reduce its condition number. The output array r returns the row scale factors and the array c the column scale factors. These factors are chosen to try to make the largest element in each row and column of the matrix B with elements b_ij=r[i-1]*a_ij*c[j-1] have absolute value 1.

Input Parameters

matrix_layout	Specifies whether matrix storage layout is row major (LAPACK_ROW_MAJOR) or column major (LAPACK_COL_MAJOR).
m	The number of rows of the matrix `A`; `m≥ 0`.
n	The number of columns of the matrix `A`; `n≥ 0`.
a	Array: size max(1, ldan) for column major layout and max(1, ldam) for row major layout. Contains the `m`-by-`n` matrix `A` whose equilibration factors are to be computed.
lda	The leading dimension of `a`; `lda≥ max(1, m)`.

Output Parameters

r, c	Arrays: `r` (size `m`), `c` (size `n`). If `info = 0`, or `info`>`m`, the array `r` contains the row scale factors of the matrix `A`. If `info = 0`, the array `c` contains the column scale factors of the matrix `A`.
rowcnd	If `info = 0` or `info>m`, `rowcnd` contains the ratio of the smallest `r[i]` to the largest `r[i]`.
colcnd	If `info = 0`, `colcnd` contains the ratio of the smallest `c[i]` to the largest `c[i]`.
amax	Absolute value of the largest element of the matrix `A`.

Return Values

This function returns a value info.

If info = 0, the execution is successful.

If info = -i, parameter i had an illegal value.

If info = i, i > 0, and

i≤m, the i-th row of A is exactly zero;

i>m, the (i-m)th column of A is exactly zero.

Application Notes

All the components of r and c are restricted to be between SMLNUM = smallest safe number and BIGNUM= largest safe number. Use of these scaling factors is not guaranteed to reduce the condition number of A but works well in practice.

SMLNUM and BIGNUM are parameters representing machine precision. You can use the ?lamch routines to compute them. For example, compute single precision values of SMLNUM and BIGNUM as follows:

SMLNUM = slamch ('s')
BIGNUM = 1 / SMLNUM

If rowcnd≥ 0.1 and amax is neither too large nor too small, it is not worth scaling by r.

If colcnd≥ 0.1, it is not worth scaling by c.

If amax is very close to SMLNUM or very close to BIGNUM, the matrix A should be scaled.

Parent topic: Matrix Equilibration: LAPACK Computational Routines

Select Your Language

Using Intel.com Search

Quick Links

Recent Searches

Advanced Search

Only search in

Developer Reference for Intel® oneAPI Math Kernel Library for C

?geequ

Syntax

Include Files

Description

Input Parameters

Output Parameters

Return Values

Application Notes

See Also