geequ#

Functions

void sgeequ(
    const INT           m,
    const INT           n,
    const f32* restrict A,
    const INT           lda,
          f32* restrict R,
          f32* restrict C,
          f32*          rowcnd,
          f32*          colcnd,
          f32*          amax,
          INT*          info
);
void sgeequ(const INT m, const INT n, const f32 *restrict A, const INT lda, f32 *restrict R, f32 *restrict C, f32 *rowcnd, f32 *colcnd, f32 *amax, INT *info)#

SGEEQU 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.

  • <= m: the i-th row of A is exactly zero (1-based)

  • > m: the (i-m)-th column of A is exactly zero (1-based)

Parameters

in
m

The number of rows of the matrix A (m >= 0).

in
n

The number of columns of the matrix A (n >= 0).

in
A

The M-by-N matrix whose equilibration factors are to be computed. Array of dimension (lda, n).

in
lda

The leading dimension of the array A (lda >= max(1,m)).

out
R

If info = 0 or info > m, R contains the row scale factors for A. Array of dimension m.

out
C

If info = 0, C contains the column scale factors for A. Array of dimension n.

out
rowcnd

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.

out
colcnd

If info = 0, colcnd contains the ratio of the smallest C(j) to the largest C(j). If colcnd >= 0.1, it is not worth scaling by C.

out
amax

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

out
info

Exit status:

  • = 0: successful exit

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

  • > 0: if info = i, and i is

Functions

void dgeequ(
    const INT           m,
    const INT           n,
    const f64* restrict A,
    const INT           lda,
          f64* restrict R,
          f64* restrict C,
          f64*          rowcnd,
          f64*          colcnd,
          f64*          amax,
          INT*          info
);
void dgeequ(const INT m, const INT n, const f64 *restrict A, const INT lda, f64 *restrict R, f64 *restrict C, f64 *rowcnd, f64 *colcnd, f64 *amax, INT *info)#

DGEEQU 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.

  • <= m: the i-th row of A is exactly zero (1-based)

  • > m: the (i-m)-th column of A is exactly zero (1-based)

Parameters

in
m

The number of rows of the matrix A (m >= 0).

in
n

The number of columns of the matrix A (n >= 0).

in
A

The M-by-N matrix whose equilibration factors are to be computed. Array of dimension (lda, n).

in
lda

The leading dimension of the array A (lda >= max(1,m)).

out
R

If info = 0 or info > m, R contains the row scale factors for A. Array of dimension m.

out
C

If info = 0, C contains the column scale factors for A. Array of dimension n.

out
rowcnd

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.

out
colcnd

If info = 0, colcnd contains the ratio of the smallest C(j) to the largest C(j). If colcnd >= 0.1, it is not worth scaling by C.

out
amax

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

out
info

Exit status:

  • = 0: successful exit

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

  • > 0: if info = i, and i is

Functions

void cgeequ(
    const INT           m,
    const INT           n,
    const c64* restrict A,
    const INT           lda,
          f32* restrict R,
          f32* restrict C,
          f32*          rowcnd,
          f32*          colcnd,
          f32*          amax,
          INT*          info
);
void cgeequ(const INT m, const INT n, const c64 *restrict A, const INT lda, f32 *restrict R, f32 *restrict C, f32 *rowcnd, f32 *colcnd, f32 *amax, INT *info)#

CGEEQU 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.

  • <= m: the i-th row of A is exactly zero (1-based)

  • > m: the (i-m)-th column of A is exactly zero (1-based)

Parameters

in
m

The number of rows of the matrix A (m >= 0).

in
n

The number of columns of the matrix A (n >= 0).

in
A

The M-by-N matrix whose equilibration factors are to be computed. Array of dimension (lda, n).

in
lda

The leading dimension of the array A (lda >= max(1,m)).

out
R

If info = 0 or info > m, R contains the row scale factors for A. Array of dimension m.

out
C

If info = 0, C contains the column scale factors for A. Array of dimension n.

out
rowcnd

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.

out
colcnd

If info = 0, colcnd contains the ratio of the smallest C(j) to the largest C(j). If colcnd >= 0.1, it is not worth scaling by C.

out
amax

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

out
info

Exit status:

  • = 0: successful exit

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

  • > 0: if info = i, and i is

Functions

void zgeequ(
    const INT            m,
    const INT            n,
    const c128* restrict A,
    const INT            lda,
          f64*  restrict R,
          f64*  restrict C,
          f64*           rowcnd,
          f64*           colcnd,
          f64*           amax,
          INT*           info
);
void zgeequ(const INT m, const INT n, const c128 *restrict A, const INT lda, f64 *restrict R, f64 *restrict C, f64 *rowcnd, f64 *colcnd, f64 *amax, INT *info)#

ZGEEQU 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.

  • <= m: the i-th row of A is exactly zero (1-based)

  • > m: the (i-m)-th column of A is exactly zero (1-based)

Parameters

in
m

The number of rows of the matrix A (m >= 0).

in
n

The number of columns of the matrix A (n >= 0).

in
A

The M-by-N matrix whose equilibration factors are to be computed. Array of dimension (lda, n).

in
lda

The leading dimension of the array A (lda >= max(1,m)).

out
R

If info = 0 or info > m, R contains the row scale factors for A. Array of dimension m.

out
C

If info = 0, C contains the column scale factors for A. Array of dimension n.

out
rowcnd

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.

out
colcnd

If info = 0, colcnd contains the ratio of the smallest C(j) to the largest C(j). If colcnd >= 0.1, it is not worth scaling by C.

out
amax

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

out
info

Exit status:

  • = 0: successful exit

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

  • > 0: if info = i, and i is

On this page

This Page