?sycon

Developer Reference for Intel® oneAPI Math Kernel Library for C

Download PDF

ID 766684

Date 11/07/2023

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-C84FC6A9-EA43-4390-96D6-FC497737E234

View Details

?sycon

Estimates the reciprocal of the condition number of a symmetric matrix.

Syntax

lapack_int LAPACKE_ssycon( int matrix_layout, char uplo, lapack_int n, const float* a, lapack_int lda, const lapack_int* ipiv, float anorm, float* rcond );

lapack_int LAPACKE_dsycon( int matrix_layout, char uplo, lapack_int n, const double* a, lapack_int lda, const lapack_int* ipiv, double anorm, double* rcond );

lapack_int LAPACKE_csycon( int matrix_layout, char uplo, lapack_int n, const lapack_complex_float* a, lapack_int lda, const lapack_int* ipiv, float anorm, float* rcond );

lapack_int LAPACKE_zsycon( int matrix_layout, char uplo, lapack_int n, const lapack_complex_double* a, lapack_int lda, const lapack_int* ipiv, double anorm, double* rcond );

Include Files

mkl.h

Description

The routine estimates the reciprocal of the condition number of a symmetric matrix A:

κ₁(A) = ||A||₁ ||A^-1||₁ (since A is symmetric, κ_∞(A) = κ₁(A)).

An estimate is obtained for ||A^-1||, and the reciprocal of the condition number is computed as rcond = 1 / (||A|| ||A^-1||).

Before calling this routine:

compute anorm (either ||A||₁ = max_jΣ_i |a_ij| or ||A||_∞ = max_iΣ_j |a_ij|)
call ?sytrf to compute the factorization of A.

Input Parameters

matrix_layout	Specifies whether matrix storage layout is row major (LAPACK_ROW_MAJOR) or column major (LAPACK_COL_MAJOR).
uplo	Must be 'U' or 'L'. Indicates how the input matrix `A` has been factored: If `uplo = 'U'`, the array `a` stores the upper triangular factor `U` of the factorization `A` = `UDU^T`. If `uplo = 'L'`, the array `a` stores the lower triangular factor `L` of the factorization `A` = `LDL^T`.
n	The order of matrix `A`; `n`≥ 0.
a	The array `a` of size max(1,lda*n) contains the factored matrix `A`, as returned by ?sytrf.
lda	The leading dimension of `a`; `lda≥ max(1, n)`.
ipiv	Array, size at least `max(1, n)`. The array `ipiv`, as returned by ?sytrf.
anorm	The norm of the original matrix `A` (see Description).

Output Parameters

rcond

An estimate of the reciprocal of the condition number. The routine sets rcond =0 if the estimate underflows; in this case the matrix is singular (to working precision). However, anytime rcond is small compared to 1.0, for the working precision, the matrix may be poorly conditioned or even singular.

Return Values

This function returns a value info.

If info = 0, the execution is successful.

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

Application Notes

The computed rcond is never less than r (the reciprocal of the true condition number) and in practice is nearly always less than 10r. A call to this routine involves solving a number of systems of linear equations A*x = b; the number is usually 4 or 5 and never more than 11. Each solution requires approximately 2n² floating-point operations for real flavors and 8n² for complex flavors.

Parent topic: Estimating the Condition Number: 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

?sycon

Syntax

Include Files

Description

Input Parameters

Output Parameters

Return Values

Application Notes

See Also