GEEQU - 5.2 English - 68552

AOCL API Guide (68552)

Document ID
68552
Release Date
2025-12-29
Version
5.2 English
template<typename T>
void geequ(integer *m, integer *n, T *a, integer *lda, T *r, T *c, T *rowcnd, T *colcnd, T *amax, integer *info)#

GEEQU computes row and column scalings intended to equilibrate an

M-by-N matrix A and reduce its condition number.

Purpose:

  GEEQU computes row and column scalings intended to equilibrate an
  M-by-N matrix A and reduce its condition number.  R returns the row
  scale factors and C the column scale factors, chosen to try to make
  the largest element in each row and column of the matrix B with
  elements B(i,j)=R(i)*A(i,j)*C(j) have absolute value 1.

  R(i) and C(j) 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.
Parameters:
  • M[in]

    M is INTEGER

    The number of rows of the matrix A. M >= 0.

  • N[in]

    N is INTEGER

    The number of columns of the matrix A. N >= 0.

  • A[in]

    A is REAL array, dimension (LDA,N)

    The M-by-N matrix whose equilibration factors are to be computed.

  • LDA[in]

    LDA is INTEGER

    The leading dimension of the array A. LDA >= fla_max(1,M).

  • R[out]

    R is REAL array, dimension (M)

    If INFO = 0 or INFO > M, R contains the row scale factors for A.

  • C[out]

    C is REAL array, dimension (N)

    If INFO = 0, C contains the column scale factors for A.

  • ROWCND[out]

    ROWCND is REAL

    If INFO = 0 or INFO > M, ROWCND contains the ratio of the smallest R(i) to the largest R(i). If ROWCND >= 0.1 and AMAX is neither too large nor too small, it is not worth scaling by R.

  • COLCND[out]

    COLCND is REAL

    If INFO = 0, COLCND contains the ratio of the smallest C(i) to the largest C(i). If COLCND >= 0.1, it is not worth scaling by C.

  • AMAX[out]

    AMAX is REAL

    Absolute value of largest matrix element. If AMAX is very close to overflow or very close to underflow, the matrix should be scaled.

  • INFO[out]

    INFO is INTEGER

    = 0: successful exit

    < 0: if INFO = -i, the i-th argument had an illegal value

    > 0: if INFO = i, and i is

    <= M: the i-th row of A is exactly zero

    > M: the (i-M)-th column of A is exactly zero

template<typename T, typename Ta>
void geequ(integer *m, integer *n, T *a, integer *lda, Ta *r, Ta *c, Ta *rowcnd, Ta *colcnd, Ta *amax, integer *info)#