Annotation of rpl/lapack/lapack/zsysv.f, revision 1.16
1.10 bertrand 1: *> \brief <b> ZSYSV computes the solution to system of linear equations A * X = B for SY matrices</b>
2: *
3: * =========== DOCUMENTATION ===========
4: *
1.16 ! bertrand 5: * Online html documentation available at
! 6: * http://www.netlib.org/lapack/explore-html/
1.10 bertrand 7: *
8: *> \htmlonly
1.16 ! bertrand 9: *> Download ZSYSV + dependencies
! 10: *> <a href="http://www.netlib.org/cgi-bin/netlibfiles.tgz?format=tgz&filename=/lapack/lapack_routine/zsysv.f">
! 11: *> [TGZ]</a>
! 12: *> <a href="http://www.netlib.org/cgi-bin/netlibfiles.zip?format=zip&filename=/lapack/lapack_routine/zsysv.f">
! 13: *> [ZIP]</a>
! 14: *> <a href="http://www.netlib.org/cgi-bin/netlibfiles.txt?format=txt&filename=/lapack/lapack_routine/zsysv.f">
1.10 bertrand 15: *> [TXT]</a>
1.16 ! bertrand 16: *> \endhtmlonly
1.10 bertrand 17: *
18: * Definition:
19: * ===========
20: *
21: * SUBROUTINE ZSYSV( UPLO, N, NRHS, A, LDA, IPIV, B, LDB, WORK,
22: * LWORK, INFO )
1.16 ! bertrand 23: *
1.10 bertrand 24: * .. Scalar Arguments ..
25: * CHARACTER UPLO
26: * INTEGER INFO, LDA, LDB, LWORK, N, NRHS
27: * ..
28: * .. Array Arguments ..
29: * INTEGER IPIV( * )
30: * COMPLEX*16 A( LDA, * ), B( LDB, * ), WORK( * )
31: * ..
1.16 ! bertrand 32: *
1.10 bertrand 33: *
34: *> \par Purpose:
35: * =============
36: *>
37: *> \verbatim
38: *>
39: *> ZSYSV computes the solution to a complex system of linear equations
40: *> A * X = B,
41: *> where A is an N-by-N symmetric matrix and X and B are N-by-NRHS
42: *> matrices.
43: *>
44: *> The diagonal pivoting method is used to factor A as
45: *> A = U * D * U**T, if UPLO = 'U', or
46: *> A = L * D * L**T, if UPLO = 'L',
47: *> where U (or L) is a product of permutation and unit upper (lower)
48: *> triangular matrices, and D is symmetric and block diagonal with
49: *> 1-by-1 and 2-by-2 diagonal blocks. The factored form of A is then
50: *> used to solve the system of equations A * X = B.
51: *> \endverbatim
52: *
53: * Arguments:
54: * ==========
55: *
56: *> \param[in] UPLO
57: *> \verbatim
58: *> UPLO is CHARACTER*1
59: *> = 'U': Upper triangle of A is stored;
60: *> = 'L': Lower triangle of A is stored.
61: *> \endverbatim
62: *>
63: *> \param[in] N
64: *> \verbatim
65: *> N is INTEGER
66: *> The number of linear equations, i.e., the order of the
67: *> matrix A. N >= 0.
68: *> \endverbatim
69: *>
70: *> \param[in] NRHS
71: *> \verbatim
72: *> NRHS is INTEGER
73: *> The number of right hand sides, i.e., the number of columns
74: *> of the matrix B. NRHS >= 0.
75: *> \endverbatim
76: *>
77: *> \param[in,out] A
78: *> \verbatim
79: *> A is COMPLEX*16 array, dimension (LDA,N)
80: *> On entry, the symmetric matrix A. If UPLO = 'U', the leading
81: *> N-by-N upper triangular part of A contains the upper
82: *> triangular part of the matrix A, and the strictly lower
83: *> triangular part of A is not referenced. If UPLO = 'L', the
84: *> leading N-by-N lower triangular part of A contains the lower
85: *> triangular part of the matrix A, and the strictly upper
86: *> triangular part of A is not referenced.
87: *>
88: *> On exit, if INFO = 0, the block diagonal matrix D and the
89: *> multipliers used to obtain the factor U or L from the
90: *> factorization A = U*D*U**T or A = L*D*L**T as computed by
91: *> ZSYTRF.
92: *> \endverbatim
93: *>
94: *> \param[in] LDA
95: *> \verbatim
96: *> LDA is INTEGER
97: *> The leading dimension of the array A. LDA >= max(1,N).
98: *> \endverbatim
99: *>
100: *> \param[out] IPIV
101: *> \verbatim
102: *> IPIV is INTEGER array, dimension (N)
103: *> Details of the interchanges and the block structure of D, as
104: *> determined by ZSYTRF. If IPIV(k) > 0, then rows and columns
105: *> k and IPIV(k) were interchanged, and D(k,k) is a 1-by-1
106: *> diagonal block. If UPLO = 'U' and IPIV(k) = IPIV(k-1) < 0,
107: *> then rows and columns k-1 and -IPIV(k) were interchanged and
108: *> D(k-1:k,k-1:k) is a 2-by-2 diagonal block. If UPLO = 'L' and
109: *> IPIV(k) = IPIV(k+1) < 0, then rows and columns k+1 and
110: *> -IPIV(k) were interchanged and D(k:k+1,k:k+1) is a 2-by-2
111: *> diagonal block.
112: *> \endverbatim
113: *>
114: *> \param[in,out] B
115: *> \verbatim
116: *> B is COMPLEX*16 array, dimension (LDB,NRHS)
117: *> On entry, the N-by-NRHS right hand side matrix B.
118: *> On exit, if INFO = 0, the N-by-NRHS solution matrix X.
119: *> \endverbatim
120: *>
121: *> \param[in] LDB
122: *> \verbatim
123: *> LDB is INTEGER
124: *> The leading dimension of the array B. LDB >= max(1,N).
125: *> \endverbatim
126: *>
127: *> \param[out] WORK
128: *> \verbatim
129: *> WORK is COMPLEX*16 array, dimension (MAX(1,LWORK))
130: *> On exit, if INFO = 0, WORK(1) returns the optimal LWORK.
131: *> \endverbatim
132: *>
133: *> \param[in] LWORK
134: *> \verbatim
135: *> LWORK is INTEGER
136: *> The length of WORK. LWORK >= 1, and for best performance
137: *> LWORK >= max(1,N*NB), where NB is the optimal blocksize for
138: *> ZSYTRF.
139: *> for LWORK < N, TRS will be done with Level BLAS 2
140: *> for LWORK >= N, TRS will be done with Level BLAS 3
141: *>
142: *> If LWORK = -1, then a workspace query is assumed; the routine
143: *> only calculates the optimal size of the WORK array, returns
144: *> this value as the first entry of the WORK array, and no error
145: *> message related to LWORK is issued by XERBLA.
146: *> \endverbatim
147: *>
148: *> \param[out] INFO
149: *> \verbatim
150: *> INFO is INTEGER
151: *> = 0: successful exit
152: *> < 0: if INFO = -i, the i-th argument had an illegal value
153: *> > 0: if INFO = i, D(i,i) is exactly zero. The factorization
154: *> has been completed, but the block diagonal matrix D is
155: *> exactly singular, so the solution could not be computed.
156: *> \endverbatim
157: *
158: * Authors:
159: * ========
160: *
1.16 ! bertrand 161: *> \author Univ. of Tennessee
! 162: *> \author Univ. of California Berkeley
! 163: *> \author Univ. of Colorado Denver
! 164: *> \author NAG Ltd.
1.10 bertrand 165: *
1.16 ! bertrand 166: *> \date December 2016
1.10 bertrand 167: *
168: *> \ingroup complex16SYsolve
169: *
170: * =====================================================================
1.1 bertrand 171: SUBROUTINE ZSYSV( UPLO, N, NRHS, A, LDA, IPIV, B, LDB, WORK,
172: $ LWORK, INFO )
173: *
1.16 ! bertrand 174: * -- LAPACK driver routine (version 3.7.0) --
1.1 bertrand 175: * -- LAPACK is a software package provided by Univ. of Tennessee, --
176: * -- Univ. of California Berkeley, Univ. of Colorado Denver and NAG Ltd..--
1.16 ! bertrand 177: * December 2016
1.1 bertrand 178: *
179: * .. Scalar Arguments ..
180: CHARACTER UPLO
181: INTEGER INFO, LDA, LDB, LWORK, N, NRHS
182: * ..
183: * .. Array Arguments ..
184: INTEGER IPIV( * )
185: COMPLEX*16 A( LDA, * ), B( LDB, * ), WORK( * )
186: * ..
187: *
188: * =====================================================================
189: *
190: * .. Local Scalars ..
191: LOGICAL LQUERY
1.10 bertrand 192: INTEGER LWKOPT
1.1 bertrand 193: * ..
194: * .. External Functions ..
195: LOGICAL LSAME
1.10 bertrand 196: EXTERNAL LSAME
1.1 bertrand 197: * ..
198: * .. External Subroutines ..
1.9 bertrand 199: EXTERNAL XERBLA, ZSYTRF, ZSYTRS, ZSYTRS2
1.1 bertrand 200: * ..
201: * .. Intrinsic Functions ..
202: INTRINSIC MAX
203: * ..
204: * .. Executable Statements ..
205: *
206: * Test the input parameters.
207: *
208: INFO = 0
209: LQUERY = ( LWORK.EQ.-1 )
210: IF( .NOT.LSAME( UPLO, 'U' ) .AND. .NOT.LSAME( UPLO, 'L' ) ) THEN
211: INFO = -1
212: ELSE IF( N.LT.0 ) THEN
213: INFO = -2
214: ELSE IF( NRHS.LT.0 ) THEN
215: INFO = -3
216: ELSE IF( LDA.LT.MAX( 1, N ) ) THEN
217: INFO = -5
218: ELSE IF( LDB.LT.MAX( 1, N ) ) THEN
219: INFO = -8
220: ELSE IF( LWORK.LT.1 .AND. .NOT.LQUERY ) THEN
221: INFO = -10
222: END IF
223: *
224: IF( INFO.EQ.0 ) THEN
225: IF( N.EQ.0 ) THEN
226: LWKOPT = 1
227: ELSE
1.10 bertrand 228: CALL ZSYTRF( UPLO, N, A, LDA, IPIV, WORK, -1, INFO )
1.9 bertrand 229: LWKOPT = WORK(1)
1.1 bertrand 230: END IF
231: WORK( 1 ) = LWKOPT
232: END IF
233: *
234: IF( INFO.NE.0 ) THEN
235: CALL XERBLA( 'ZSYSV ', -INFO )
236: RETURN
237: ELSE IF( LQUERY ) THEN
238: RETURN
239: END IF
240: *
1.9 bertrand 241: * Compute the factorization A = U*D*U**T or A = L*D*L**T.
1.1 bertrand 242: *
243: CALL ZSYTRF( UPLO, N, A, LDA, IPIV, WORK, LWORK, INFO )
244: IF( INFO.EQ.0 ) THEN
245: *
246: * Solve the system A*X = B, overwriting B with X.
247: *
1.9 bertrand 248: IF ( LWORK.LT.N ) THEN
249: *
250: * Solve with TRS ( Use Level BLAS 2)
251: *
252: CALL ZSYTRS( UPLO, N, NRHS, A, LDA, IPIV, B, LDB, INFO )
253: *
254: ELSE
255: *
256: * Solve with TRS2 ( Use Level BLAS 3)
257: *
258: CALL ZSYTRS2( UPLO,N,NRHS,A,LDA,IPIV,B,LDB,WORK,INFO )
259: *
260: END IF
1.1 bertrand 261: *
262: END IF
263: *
264: WORK( 1 ) = LWKOPT
265: *
266: RETURN
267: *
268: * End of ZSYSV
269: *
270: END
CVSweb interface <joel.bertrand@systella.fr>