doc/info/lapack.texi

   1 @menu
   2 * Introduction to lapack::
   3 * Functions and Variables for lapack::
   4 @end menu
   5
   6 @node Introduction to lapack, Functions and Variables for lapack, Package lapack, Package lapack
   7 @section Introduction to lapack
   8
   9 @code{lapack} is a Common Lisp translation (via the program @code{f2cl}) of the Fortran library LAPACK,
  10 as obtained from the SLATEC project.
  11
  12 @opencatbox{Categories:}
  13 @category{Numerical methods}
  14 @category{Share packages}
  15 @category{Package lapack}
  16 @closecatbox
  17
  18
  19 @node Functions and Variables for lapack, , Introduction to lapack, Package lapack
  20 @section Functions and Variables for lapack
  21
  22 @anchor{dgeev}
  23 @deffn {Function} dgeev @
  24 @fname{dgeev} (@var{A}) @
  25 @fname{dgeev} (@var{A}, @var{right_p}, @var{left_p})
  26
  27 Computes the eigenvalues and, optionally, the eigenvectors of a matrix @var{A}.
  28 All elements of @var{A} must be integer or floating point numbers.
  29 @var{A} must be square (same number of rows and columns).
  30 @var{A} might or might not be symmetric.
  31
  32 @code{dgeev(@var{A})} computes only the eigenvalues of @var{A}.
  33 @code{dgeev(@var{A}, @var{right_p}, @var{left_p})} computes the eigenvalues of @var{A}
  34 and the right eigenvectors when @math{@var{right_p} = @code{true}}
  35 and the left eigenvectors when @math{@var{left_p} = @code{true}}.
  36
  37 A list of three items is returned.
  38 The first item is a list of the eigenvalues.
  39 The second item is @code{false} or the matrix of right eigenvectors.
  40 The third item is @code{false} or the matrix of left eigenvectors.
  41
  42 The right eigenvector @math{v(j)} (the @math{j}-th column of the right eigenvector matrix) satisfies
  43
  44 @math{A . v(j) = lambda(j) . v(j)}
  45
  46 where @math{lambda(j)} is the corresponding eigenvalue.
  47 The left eigenvector @math{u(j)} (the @math{j}-th column of the left eigenvector matrix) satisfies
  48
  49 @math{u(j)**H . A = lambda(j) . u(j)**H}
  50
  51 where @math{u(j)**H} denotes the conjugate transpose of @math{u(j)}.
  52 The Maxima function @code{ctranspose} computes the conjugate transpose.
  53
  54 The computed eigenvectors are normalized to have Euclidean norm
  55 equal to 1, and largest component has imaginary part equal to zero.
  56
  57 Example:
  58
  59 @c ===beg===
  60 @c load ("lapack")$
  61 @c fpprintprec : 6;
  62 @c M : matrix ([9.5, 1.75], [3.25, 10.45]);
  63 @c dgeev (M);
  64 @c [L, v, u] : dgeev (M, true, true);
  65 @c D : apply (diag_matrix, L);
  66 @c M . v - v . D;
  67 @c transpose (u) . M - D . transpose (u);
  68 @c ===end===
  69 @example
  70 (%i1) load ("lapack")$
  71 (%i2) fpprintprec : 6;
  72 (%o2)                           6
  73 (%i3) M : matrix ([9.5, 1.75], [3.25, 10.45]);
  74                          [ 9.5   1.75  ]
  75 (%o3)                    [             ]
  76                          [ 3.25  10.45 ]
  77 (%i4) dgeev (M);
  78 (%o4)          [[7.54331, 12.4067], false, false]
  79 (%i5) [L, v, u] : dgeev (M, true, true);
  80                            [ - .666642  - .515792 ]
  81 (%o5) [[7.54331, 12.4067], [                      ],
  82                            [  .745378   - .856714 ]
  83                                         [ - .856714  - .745378 ]
  84                                         [                      ]]
  85                                         [  .515792   - .666642 ]
  86 (%i6) D : apply (diag_matrix, L);
  87                       [ 7.54331     0    ]
  88 (%o6)                 [                  ]
  89                       [    0     12.4067 ]
  90 (%i7) M . v - v . D;
  91                 [      0.0       - 8.88178E-16 ]
  92 (%o7)           [                              ]
  93                 [ - 8.88178E-16       0.0      ]
  94 (%i8) transpose (u) . M - D . transpose (u);
  95                      [ 0.0  - 4.44089E-16 ]
  96 (%o8)                [                    ]
  97                      [ 0.0       0.0      ]
  98 @end example
  99
 100 @opencatbox{Categories:}
 101 @category{Package lapack}
 102 @closecatbox
 103
 104 @end deffn
 105
 106 @anchor{dgeqrf}
 107 @deffn {Function} dgeqrf (@var{A})
 108
 109 Computes the QR decomposition of the matrix @var{A}.
 110 All elements of @var{A} must be integer or floating point numbers.
 111 @var{A} may or may not have the same number of rows and columns.
 112
 113 A list of two items is returned.
 114 The first item is the matrix @var{Q}, which is a square, orthonormal matrix
 115 which has the same number of rows as @var{A}.
 116 The second item is the matrix @var{R}, which is the same size as @var{A},
 117 and which has all elements equal to zero below the diagonal.
 118 The product @code{@var{Q} . @var{R}}, where "." is the noncommutative multiplication operator,
 119 is equal to @var{A} (ignoring floating point round-off errors).
 120
 121 @c ===beg===
 122 @c load ("lapack")$
 123 @c fpprintprec : 6;
 124 @c M : matrix ([1, -3.2, 8], [-11, 2.7, 5.9]);
 125 @c [q, r] : dgeqrf (M);
 126 @c q . r - M;
 127 @c mat_norm (%);
 128 @c ===end===
 129 @example
 130 (%i1) load ("lapack") $
 131 (%i2) fpprintprec : 6 $
 132 (%i3) M : matrix ([1, -3.2, 8], [-11, 2.7, 5.9]) $
 133 (%i4) [q, r] : dgeqrf (M);
 134        [ - .0905357  .995893  ]
 135 (%o4) [[                      ],
 136        [  .995893    .0905357 ]
 137                                [ - 11.0454   2.97863   5.15148 ]
 138                                [                               ]]
 139                                [     0      - 2.94241  8.50131 ]
 140 (%i5) q . r - M;
 141          [ - 7.77156E-16   1.77636E-15   - 8.88178E-16 ]
 142 (%o5)    [                                             ]
 143          [      0.0       - 1.33227E-15   8.88178E-16  ]
 144 (%i6) mat_norm (%, 1);
 145 (%o6)                      3.10862E-15
 146 @end example
 147
 148 @opencatbox{Categories:}
 149 @category{Package lapack}
 150 @closecatbox
 151
 152 @end deffn
 153
 154 @anchor{dgesv}
 155 @deffn {Function} dgesv (@var{A}, @var{b})
 156
 157 Computes the solution @var{x} of the linear equation @math{@var{A} @var{x} = @var{b}},
 158 where @var{A} is a square matrix, and @var{b} is a matrix of the same number of rows
 159 as @var{A} and any number of columns.
 160 The return value @var{x} is the same size as @var{b}.
 161
 162 The elements of @var{A} and @var{b} must evaluate to real floating point numbers via @code{float};
 163 thus elements may be any numeric type, symbolic numerical constants, or expressions which evaluate to floats.
 164 The elements of @var{x} are always floating point numbers.
 165 All arithmetic is carried out as floating point operations.
 166
 167 @code{dgesv} computes the solution via the LU decomposition of @var{A}.
 168
 169 Examples:
 170
 171 @code{dgesv} computes the solution of the linear equation @math{@var{A} @var{x} = @var{b}}.
 172
 173 @c ===beg===
 174 @c A : matrix ([1, -2.5], [0.375, 5]);
 175 @c b : matrix ([1.75], [-0.625]);
 176 @c x : dgesv (A, b);
 177 @c dlange (inf_norm, b - A . x);
 178 @c ===end===
 179 @example
 180 (%i1) A : matrix ([1, -2.5], [0.375, 5]);
 181                                [   1    - 2.5 ]
 182 (%o1)                          [              ]
 183                                [ 0.375    5   ]
 184 (%i2) b : matrix ([1.75], [-0.625]);
 185                                   [  1.75   ]
 186 (%o2)                             [         ]
 187                                   [ - 0.625 ]
 188 (%i3) x : dgesv (A, b);
 189                             [  1.210526315789474  ]
 190 (%o3)                       [                     ]
 191                             [ - 0.215789473684211 ]
 192 (%i4) dlange (inf_norm, b - A.x);
 193 (%o4)                                 0.0
 194 @end example
 195
 196 @var{b} is a matrix with the same number of rows as @var{A} and any number of columns.
 197 @var{x} is the same size as @var{b}.
 198
 199 @c ===beg===
 200 @c A : matrix ([1, -0.15], [1.82, 2]);
 201 @c b : matrix ([3.7, 1, 8], [-2.3, 5, -3.9]);
 202 @c x : dgesv (A, b);
 203 @c dlange (inf_norm, b - A . x);
 204 @c ===end===
 205 @example
 206 (%i1) A : matrix ([1, -0.15], [1.82, 2]);
 207                                [  1    - 0.15 ]
 208 (%o1)                          [              ]
 209                                [ 1.82    2    ]
 210 (%i2) b : matrix ([3.7, 1, 8], [-2.3, 5, -3.9]);
 211                               [  3.7   1    8   ]
 212 (%o2)                         [                 ]
 213                               [ - 2.3  5  - 3.9 ]
 214 (%i3) x : dgesv (A, b);
 215       [  3.103827540695117  1.20985481742191    6.781786185657722 ]
 216 (%o3) [                                                           ]
 217       [ -3.974483062032557  1.399032116146062  -8.121425428948527 ]
 218 (%i4) dlange (inf_norm, b - A . x);
 219 (%o4)                       1.1102230246251565E-15
 220 @end example
 221
 222 The elements of @var{A} and @var{b} must evaluate to real floating point numbers.
 223
 224 @c ===beg===
 225 @c A : matrix ([5, -%pi], [1b0, 11/17]);
 226 @c b : matrix ([%e], [sin(1)]);
 227 @c x : dgesv (A, b);
 228 @c dlange (inf_norm, b - A . x);
 229 @c ===end===
 230 @example
 231 (%i1) A : matrix ([5, -%pi], [1b0, 11/17]);
 232                                [   5    - %pi ]
 233                                [              ]
 234 (%o1)                          [         11   ]
 235                                [ 1.0b0   --   ]
 236                                [         17   ]
 237 (%i2) b : matrix ([%e], [sin(1)]);
 238                                   [   %e   ]
 239 (%o2)                             [        ]
 240                                   [ sin(1) ]
 241 (%i3) x : dgesv (A, b);
 242                              [ 0.690375643155986 ]
 243 (%o3)                        [                   ]
 244                              [ 0.233510982552952 ]
 245 (%i4) dlange (inf_norm, b - A . x);
 246 (%o4)                        2.220446049250313E-16
 247 @end example
 248
 249 @opencatbox{Categories:}
 250 @category{Package lapack}
 251 @category{Linear equations}
 252 @closecatbox
 253
 254 @end deffn
 255
 256 @anchor{dgesvd}
 257 @deffn {Function} dgesvd @
 258 @fname{dgesvd} (@var{A}) @
 259 @fname{dgesvd} (@var{A}, @var{left_p}, @var{right_p})
 260
 261 Computes the singular value decomposition (SVD) of a matrix @var{A},
 262 comprising the singular values and, optionally, the left and right singular vectors.
 263 All elements of @var{A} must be integer or floating point numbers.
 264 @var{A} might or might not be square (same number of rows and columns).
 265
 266 Let @math{m} be the number of rows, and @math{n} the number of columns of @var{A}.
 267 The singular value decomposition of @var{A} comprises three matrices,
 268 @var{U}, @var{Sigma}, and @var{V^T},
 269 such that
 270
 271 @c this code breaks texi2pdf: @math{@var{A} = @var{U} . @var{Sigma} . @var{V^T}}
 272 @math{@var{A} = @var{U} . @var{Sigma} . @var{V}^T}
 273
 274 where @var{U} is an @math{m}-by-@math{m} unitary matrix,
 275 @var{Sigma} is an @math{m}-by-@math{n} diagonal matrix,
 276 and @var{V^T} is an @math{n}-by-@math{n} unitary matrix.
 277
 278 Let @math{sigma[i]} be a diagonal element of @math{Sigma},
 279 that is, @math{@var{Sigma}[i, i] = @var{sigma}[i]}.
 280 The elements @math{sigma[i]} are the so-called singular values of @var{A};
 281 these are real and nonnegative, and returned in descending order.
 282 The first @math{min(m, n)} columns of @var{U} and @var{V} are
 283 the left and right singular vectors of @var{A}.
 284 Note that @code{dgesvd} returns the transpose of @var{V}, not @var{V} itself.
 285
 286 @code{dgesvd(@var{A})} computes only the singular values of @var{A}.
 287 @code{dgesvd(@var{A}, @var{left_p}, @var{right_p})} computes the singular values of @var{A}
 288 and the left singular vectors when @math{@var{left_p} = @code{true}}
 289 and the right singular vectors when @math{@var{right_p} = @code{true}}.
 290
 291 A list of three items is returned.
 292 The first item is a list of the singular values.
 293 The second item is @code{false} or the matrix of left singular vectors.
 294 The third item is @code{false} or the matrix of right singular vectors.
 295
 296 Example:
 297
 298 @c ===beg===
 299 @c load ("lapack")$
 300 @c fpprintprec : 6;
 301 @c M: matrix([1, 2, 3], [3.5, 0.5, 8], [-1, 2, -3], [4, 9, 7]);
 302 @c dgesvd (M);
 303 @c [sigma, U, VT] : dgesvd (M, true, true);
 304 @c m : length (U);
 305 @c n : length (VT);
 306 @c Sigma:
 307 @c   genmatrix(lambda ([i, j], if i=j then sigma[i] else 0),
 308 @c             m, n);
 309 @c U . Sigma . VT - M;
 310 @c transpose (U) . U;
 311 @c VT . transpose (VT);
 312 @c ===end===
 313 @example
 314 (%i1) load ("lapack")$
 315 (%i2) fpprintprec : 6;
 316 (%o2)                           6
 317 (%i3) M: matrix([1, 2, 3], [3.5, 0.5, 8], [-1, 2, -3], [4, 9, 7]);
 318                         [  1    2    3  ]
 319                         [               ]
 320                         [ 3.5  0.5   8  ]
 321 (%o3)                   [               ]
 322                         [ - 1   2   - 3 ]
 323                         [               ]
 324                         [  4    9    7  ]
 325 (%i4) dgesvd (M);
 326 (%o4)      [[14.4744, 6.38637, .452547], false, false]
 327 (%i5) [sigma, U, VT] : dgesvd (M, true, true);
 328 (%o5) [[14.4744, 6.38637, .452547],
 329 [ - .256731  .00816168   .959029    - .119523 ]
 330 [                                             ]
 331 [ - .526456   .672116   - .206236   - .478091 ]
 332 [                                             ],
 333 [  .107997   - .532278  - .0708315  - 0.83666 ]
 334 [                                             ]
 335 [ - .803287  - .514659  - .180867    .239046  ]
 336 [ - .374486  - .538209  - .755044 ]
 337 [                                 ]
 338 [  .130623   - .836799   0.5317   ]]
 339 [                                 ]
 340 [ - .917986   .100488    .383672  ]
 341 (%i6) m : length (U);
 342 (%o6)                           4
 343 (%i7) n : length (VT);
 344 (%o7)                           3
 345 (%i8) Sigma:
 346         genmatrix(lambda ([i, j], if i=j then sigma[i] else 0),
 347                   m, n);
 348                   [ 14.4744     0        0    ]
 349                   [                           ]
 350                   [    0     6.38637     0    ]
 351 (%o8)             [                           ]
 352                   [    0        0     .452547 ]
 353                   [                           ]
 354                   [    0        0        0    ]
 355 (%i9) U . Sigma . VT - M;
 356           [  1.11022E-15        0.0       1.77636E-15 ]
 357           [                                           ]
 358           [  1.33227E-15    1.66533E-15       0.0     ]
 359 (%o9)     [                                           ]
 360           [ - 4.44089E-16  - 8.88178E-16  4.44089E-16 ]
 361           [                                           ]
 362           [  8.88178E-16    1.77636E-15   8.88178E-16 ]
 363 (%i10) transpose (U) . U;
 364        [     1.0      5.55112E-17    2.498E-16     2.77556E-17  ]
 365        [                                                        ]
 366        [ 5.55112E-17      1.0       5.55112E-17    4.16334E-17  ]
 367 (%o10) [                                                        ]
 368        [  2.498E-16   5.55112E-17       1.0       - 2.08167E-16 ]
 369        [                                                        ]
 370        [ 2.77556E-17  4.16334E-17  - 2.08167E-16       1.0      ]
 371 (%i11) VT . transpose (VT);
 372           [      1.0           0.0      - 5.55112E-17 ]
 373           [                                           ]
 374 (%o11)    [      0.0           1.0       5.55112E-17  ]
 375           [                                           ]
 376           [ - 5.55112E-17  5.55112E-17       1.0      ]
 377 @end example
 378
 379 @opencatbox{Categories:}
 380 @category{Package lapack}
 381 @closecatbox
 382
 383 @end deffn
 384
 385 @anchor{dlange}
 386 @anchor{zlange}
 387 @deffn {Function} dlange (@var{norm}, @var{A})
 388 @deffnx {Function} zlange (@var{norm}, @var{A})
 389
 390 Computes a norm or norm-like function of the matrix @var{A}.  If
 391 @var{A} is a real matrix, use @code{dlange}.  For a matrix with
 392 complex elements, use @code{zlange}.
 393
 394 @code{norm} specifies the kind of norm to be computed:
 395 @table @code
 396 @item max
 397 Compute @math{max(abs(A(i, j)))} where @math{i} and @math{j} range over
 398 the rows and columns, respectively, of @var{A}.
 399 Note that this function is not a proper matrix norm.
 400 @item one_norm
 401 Compute the @math{L[1]} norm of @var{A},
 402 that is, the maximum of the sum of the absolute value of elements in each column.
 403 @item inf_norm
 404 Compute the @math{L[inf]} norm of @var{A},
 405 that is, the maximum of the sum of the absolute value of elements in each row.
 406 @item frobenius
 407 Compute the Frobenius norm of @var{A},
 408 that is, the square root of the sum of squares of the matrix elements.
 409 @end table
 410
 411 @opencatbox{Categories:}
 412 @category{Package lapack}
 413 @closecatbox
 414
 415 @end deffn
 416
 417 @anchor{dgemm}
 418 @deffn {Function} dgemm @
 419 @fname{dgemm} (@var{A}, @var{B}) @
 420 @fname{dgemm} (@var{A}, @var{B}, @var{options})
 421 Compute the product of two matrices and optionally add the product to
 422 a third matrix.
 423
 424 In the simplest form, @code{dgemm(@var{A}, @var{B})} computes the
 425 product of the two real matrices, @var{A} and @var{B}.
 426
 427 In the second form, @code{dgemm} computes the @math{@var{alpha} *
 428 @var{A} * @var{B} + @var{beta} * @var{C}} where @var{A}, @var{B},
 429 @var{C} are real matrices of the appropriate sizes and @var{alpha} and
 430 @var{beta} are real numbers.  Optionally, @var{A} and/or @var{B} can
 431 be transposed before computing the product.  The extra parameters are
 432 specified by optional keyword arguments: The keyword arguments are
 433 optional and may be specified in any order.  They all take the form
 434 @code{key=val}.  The keyword arguments are:
 435
 436 @table @code
 437 @item C
 438 The matrix @var{C} that should be added.  The default is @code{false},
 439 which means no matrix is added.
 440 @item alpha
 441 The product of @var{A} and @var{B} is multiplied by this value.  The
 442 default is 1.
 443 @item beta
 444 If a matrix @var{C} is given, this value multiplies @var{C} before it
 445 is added.  The default value is 0, which implies that @var{C} is not
 446 added, even if @var{C} is given.  Hence, be sure to specify a non-zero
 447 value for @var{beta}.
 448 @item transpose_a
 449 If @code{true}, the transpose of @var{A} is used instead of @var{A}
 450 for the product.  The default is @code{false}.
 451 @item transpose_b
 452 If @code{true}, the transpose of @var{B} is used instead of @var{B}
 453 for the product.  The default is @code{false}.
 454 @end table
 455
 456 @c ===beg===
 457 @c load ("lapack")$
 458 @c A : matrix([1,2,3],[4,5,6],[7,8,9]);
 459 @c B : matrix([-1,-2,-3],[-4,-5,-6],[-7,-8,-9]);
 460 @c C : matrix([3,2,1],[6,5,4],[9,8,7]);
 461 @c dgemm(A,B);
 462 @c A . B;
 463 @c dgemm(A,B,transpose_a=true);
 464 @c transpose(A) . B;
 465 @c dgemm(A,B,c=C,beta=1);
 466 @c A . B + C;
 467 @c dgemm(A,B,c=C,beta=1, alpha=-1);
 468 @c -A . B + C
 469 @c ===end===
 470 @example
 471 (%i1) load ("lapack")$
 472 (%i2) A : matrix([1,2,3],[4,5,6],[7,8,9]);
 473                                   [ 1  2  3 ]
 474                                   [         ]
 475 (%o2)                             [ 4  5  6 ]
 476                                   [         ]
 477                                   [ 7  8  9 ]
 478 (%i3) B : matrix([-1,-2,-3],[-4,-5,-6],[-7,-8,-9]);
 479                                [ - 1  - 2  - 3 ]
 480                                [               ]
 481 (%o3)                          [ - 4  - 5  - 6 ]
 482                                [               ]
 483                                [ - 7  - 8  - 9 ]
 484 (%i4) C : matrix([3,2,1],[6,5,4],[9,8,7]);
 485                                   [ 3  2  1 ]
 486                                   [         ]
 487 (%o4)                             [ 6  5  4 ]
 488                                   [         ]
 489                                   [ 9  8  7 ]
 490 (%i5) dgemm(A,B);
 491                          [ - 30.0   - 36.0   - 42.0  ]
 492                          [                           ]
 493 (%o5)                    [ - 66.0   - 81.0   - 96.0  ]
 494                          [                           ]
 495                          [ - 102.0  - 126.0  - 150.0 ]
 496 (%i6) A . B;
 497                             [ - 30   - 36   - 42  ]
 498                             [                     ]
 499 (%o6)                       [ - 66   - 81   - 96  ]
 500                             [                     ]
 501                             [ - 102  - 126  - 150 ]
 502 (%i7) dgemm(A,B,transpose_a=true);
 503                          [ - 66.0  - 78.0   - 90.0  ]
 504                          [                          ]
 505 (%o7)                    [ - 78.0  - 93.0   - 108.0 ]
 506                          [                          ]
 507                          [ - 90.0  - 108.0  - 126.0 ]
 508 (%i8) transpose(A) . B;
 509                            [ - 66  - 78   - 90  ]
 510                            [                    ]
 511 (%o8)                      [ - 78  - 93   - 108 ]
 512                            [                    ]
 513                            [ - 90  - 108  - 126 ]
 514 (%i9) dgemm(A,B,c=C,beta=1);
 515                          [ - 27.0  - 34.0   - 41.0  ]
 516                          [                          ]
 517 (%o9)                    [ - 60.0  - 76.0   - 92.0  ]
 518                          [                          ]
 519                          [ - 93.0  - 118.0  - 143.0 ]
 520 (%i10) A . B + C;
 521                             [ - 27  - 34   - 41  ]
 522                             [                    ]
 523 (%o10)                      [ - 60  - 76   - 92  ]
 524                             [                    ]
 525                             [ - 93  - 118  - 143 ]
 526 (%i11) dgemm(A,B,c=C,beta=1, alpha=-1);
 527                             [ 33.0   38.0   43.0  ]
 528                             [                     ]
 529 (%o11)                      [ 72.0   86.0   100.0 ]
 530                             [                     ]
 531                             [ 111.0  134.0  157.0 ]
 532 (%i12) -A . B + C;
 533                                [ 33   38   43  ]
 534                                [               ]
 535 (%o12)                         [ 72   86   100 ]
 536                                [               ]
 537                                [ 111  134  157 ]
 538
 539 @end example
 540 @opencatbox{Categories:}
 541 @category{Package lapack}
 542 @closecatbox
 543
 544 @end deffn
 545
 546 @anchor{zgeev}
 547 @deffn {Function} zgeev @
 548 @fname{zgeev} (@var{A}) @
 549 @fname{zgeev} (@var{A}, @var{right_p}, @var{left_p})
 550
 551 Like @code{dgeev}, but the matrix @var{A} is complex.
 552
 553 @opencatbox{Categories:}
 554 @category{Package lapack}
 555 @closecatbox
 556
 557 @end deffn
 558
 559 @anchor{zheev}
 560 @deffn {Function} zheev @
 561 @fname{zheev} (@var{A}) @
 562 @fname{zheev} (@var{A}, @var{eigvec_p})
 563
 564 Like @code{dgeev}, but the matrix @var{A} is assumed to be a square
 565 complex Hermitian matrix. If @var{eigvec_p} is @code{true}, then the
 566 eigenvectors of the matrix are also computed.
 567
 568 No check is made that the matrix @var{A} is, in fact, Hermitian.
 569
 570 A list of two items is returned, as in @code{dgeev}: a list of
 571 eigenvalues, and @code{false} or the matrix of the eigenvectors.
 572
 573 @c ===beg===
 574 @c load("lapack")
 575 @c A: matrix(
 576 @c      [9.14 +%i*0.00 ,   -4.37 -%i*9.22 ,  -1.98 -%i*1.72 ,  -8.96 -%i*9.50],
 577 @c      [-4.37 +%i*9.22 ,  -3.35 +%i*0.00 ,   2.25 -%i*9.51 ,   2.57 +%i*2.40],
 578 @c      [-1.98 +%i*1.72 ,   2.25 +%i*9.51 ,  -4.82 +%i*0.00 ,  -3.24 +%i*2.04],
 579 @c      [-8.96 +%i*9.50 ,   2.57 -%i*2.40 ,  -3.24 -%i*2.04 ,   8.44 +%i*0.00]);
 580 @c zheev(M);
 581 @c E: zheev(M,true)$
 582 @c E[1];
 583 @c E[2];
 584 An example of computing the eigenvalues and then eigenvalues and
 585 eigenvectors of an Hermitian matrix.
 586 @example
 587 (%i1) load("lapack")$
 588 (%i2) A: matrix(
 589      [9.14 +%i*0.00 ,   -4.37 -%i*9.22 ,  -1.98 -%i*1.72 ,  -8.96 -%i*9.50],
 590      [-4.37 +%i*9.22 ,  -3.35 +%i*0.00 ,   2.25 -%i*9.51 ,   2.57 +%i*2.40],
 591      [-1.98 +%i*1.72 ,   2.25 +%i*9.51 ,  -4.82 +%i*0.00 ,  -3.24 +%i*2.04],
 592      [-8.96 +%i*9.50 ,   2.57 -%i*2.40 ,  -3.24 -%i*2.04 ,   8.44 +%i*0.00]);
 593 (%o2)
 594   [      9.14       (- 9.22 %i) - 4.37  (- 1.72 %i) - 1.98  (- 9.5 %i) - 8.96 ]
 595   [                                                                           ]
 596   [ 9.22 %i - 4.37        - 3.35          2.25 - 9.51 %i      2.4 %i + 2.57   ]
 597   [                                                                           ]
 598   [ 1.72 %i - 1.98    9.51 %i + 2.25          - 4.82         2.04 %i - 3.24   ]
 599   [                                                                           ]
 600   [ 9.5 %i - 8.96     2.57 - 2.4 %i     (- 2.04 %i) - 3.24        8.44        ]
 601 (%i3) zheev(A);
 602 (%o3) [[- 16.00474647209473, - 6.764970154793324, 6.665711453507098,
 603                                                      25.51400517338097], false]
 604 (%i4) E:zheev(A,true)$
 605 (%i5) E[1];
 606 (%o5) [- 16.00474647209474, - 6.764970154793325, 6.665711453507101,
 607                                                              25.51400517338096]
 608 (%i6) E[2];
 609                [   0.2674650533172745 %i + 0.2175453586665017    ]
 610                [                                                 ]
 611                [  0.002696730886619885 %i + 0.6968836773391712   ]
 612 (%o6)  Col 1 = [                                                 ]
 613                [ (- 0.6082406376714117 %i) - 0.01210614292697931 ]
 614                [                                                 ]
 615                [               0.1593081858095037                ]
 616          [   0.2644937470667444 %i + 0.4773693349937472   ]
 617          [                                                ]
 618          [ (- 0.2852389036031621 %i) - 0.1414362742011673 ]
 619  Col 2 = [                                                ]
 620          [   0.2654607680986639 %i + 0.4467818117184174   ]
 621          [                                                ]
 622          [               0.5750762708542709               ]
 623          [   0.2810649767305922 %i - 0.1335263928245182   ]
 624          [                                                ]
 625          [   0.2866310132869556 %i - 0.4536971347853274   ]
 626  Col 3 = [                                                ]
 627          [ (- 0.2933684323754295 %i) - 0.4954972425541057 ]
 628          [                                                ]
 629          [               0.5325337537576771               ]
 630          [ (- 0.5737316575503476 %i) - 0.3966146799427706 ]
 631          [                                                ]
 632          [  0.01826502619021457 %i + 0.3530557704387017   ]
 633  Col 4 = [                                                ]
 634          [  0.1673700900085425 %i + 0.01476684746229564   ]
 635          [                                                ]
 636          [               0.6002632636961784               ]
 637 @end example
 638
 639 @opencatbox{Categories:}
 640 @category{Package lapack}
 641 @closecatbox
 642
 643 @end deffn
 644