home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / clabrd.z / clabrd
Encoding:
Text File  |  2002-10-03  |  7.4 KB  |  199 lines
  1.  
  2.  
  3.  
  4. CCCCLLLLAAAABBBBRRRRDDDD((((3333SSSS))))                                                          CCCCLLLLAAAABBBBRRRRDDDD((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      CLABRD - reduce the first NB rows and columns of a complex general m by n
  10.      matrix A to upper or lower real bidiagonal form by a unitary
  11.      transformation Q' * A * P, and returns the matrices X and Y which are
  12.      needed to apply the transformation to the unreduced part of A
  13.  
  14. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  15.      SUBROUTINE CLABRD( M, N, NB, A, LDA, D, E, TAUQ, TAUP, X, LDX, Y, LDY )
  16.  
  17.          INTEGER        LDA, LDX, LDY, M, N, NB
  18.  
  19.          REAL           D( * ), E( * )
  20.  
  21.          COMPLEX        A( LDA, * ), TAUP( * ), TAUQ( * ), X( LDX, * ), Y(
  22.                         LDY, * )
  23.  
  24. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  25.      These routines are part of the SCSL Scientific Library and can be loaded
  26.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  27.      directs the linker to use the multi-processor version of the library.
  28.  
  29.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  30.      4 bytes (32 bits). Another version of SCSL is available in which integers
  31.      are 8 bytes (64 bits).  This version allows the user access to larger
  32.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  33.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  34.      only one of the two versions; 4-byte integer and 8-byte integer library
  35.      calls cannot be mixed.
  36.  
  37. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  38.      CLABRD reduces the first NB rows and columns of a complex general m by n
  39.      matrix A to upper or lower real bidiagonal form by a unitary
  40.      transformation Q' * A * P, and returns the matrices X and Y which are
  41.      needed to apply the transformation to the unreduced part of A. If m >= n,
  42.      A is reduced to upper bidiagonal form; if m < n, to lower bidiagonal
  43.      form.
  44.  
  45.      This is an auxiliary routine called by CGEBRD
  46.  
  47.  
  48. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  49.      M       (input) INTEGER
  50.              The number of rows in the matrix A.
  51.  
  52.      N       (input) INTEGER
  53.              The number of columns in the matrix A.
  54.  
  55.      NB      (input) INTEGER
  56.              The number of leading rows and columns of A to be reduced.
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. CCCCLLLLAAAABBBBRRRRDDDD((((3333SSSS))))                                                          CCCCLLLLAAAABBBBRRRRDDDD((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      A       (input/output) COMPLEX array, dimension (LDA,N)
  75.              On entry, the m by n general matrix to be reduced.  On exit, the
  76.              first NB rows and columns of the matrix are overwritten; the rest
  77.              of the array is unchanged.  If m >= n, elements on and below the
  78.              diagonal in the first NB columns, with the array TAUQ, represent
  79.              the unitary matrix Q as a product of elementary reflectors; and
  80.              elements above the diagonal in the first NB rows, with the array
  81.              TAUP, represent the unitary matrix P as a product of elementary
  82.              reflectors.  If m < n, elements below the diagonal in the first
  83.              NB columns, with the array TAUQ, represent the unitary matrix Q
  84.              as a product of elementary reflectors, and elements on and above
  85.              the diagonal in the first NB rows, with the array TAUP, represent
  86.              the unitary matrix P as a product of elementary reflectors.  See
  87.              Further Details.  LDA     (input) INTEGER The leading dimension
  88.              of the array A.  LDA >= max(1,M).
  89.  
  90.      D       (output) REAL array, dimension (NB)
  91.              The diagonal elements of the first NB rows and columns of the
  92.              reduced matrix.  D(i) = A(i,i).
  93.  
  94.      E       (output) REAL array, dimension (NB)
  95.              The off-diagonal elements of the first NB rows and columns of the
  96.              reduced matrix.
  97.  
  98.      TAUQ    (output) COMPLEX array dimension (NB)
  99.              The scalar factors of the elementary reflectors which represent
  100.              the unitary matrix Q. See Further Details.  TAUP    (output)
  101.              COMPLEX array, dimension (NB) The scalar factors of the
  102.              elementary reflectors which represent the unitary matrix P. See
  103.              Further Details.  X       (output) COMPLEX array, dimension
  104.              (LDX,NB) The m-by-nb matrix X required to update the unreduced
  105.              part of A.
  106.  
  107.      LDX     (input) INTEGER
  108.              The leading dimension of the array X. LDX >= max(1,M).
  109.  
  110.      Y       (output) COMPLEX array, dimension (LDY,NB)
  111.              The n-by-nb matrix Y required to update the unreduced part of A.
  112.  
  113.      LDY     (output) INTEGER
  114.              The leading dimension of the array Y. LDY >= max(1,N).
  115.  
  116. FFFFUUUURRRRTTTTHHHHEEEERRRR DDDDEEEETTTTAAAAIIIILLLLSSSS
  117.      The matrices Q and P are represented as products of elementary
  118.      reflectors:
  119.  
  120.         Q = H(1) H(2) . . . H(nb)  and  P = G(1) G(2) . . . G(nb)
  121.  
  122.      Each H(i) and G(i) has the form:
  123.  
  124.         H(i) = I - tauq * v * v'  and G(i) = I - taup * u * u'
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. CCCCLLLLAAAABBBBRRRRDDDD((((3333SSSS))))                                                          CCCCLLLLAAAABBBBRRRRDDDD((((3333SSSS))))
  137.  
  138.  
  139.  
  140.      where tauq and taup are complex scalars, and v and u are complex vectors.
  141.  
  142.      If m >= n, v(1:i-1) = 0, v(i) = 1, and v(i:m) is stored on exit in
  143.      A(i:m,i); u(1:i) = 0, u(i+1) = 1, and u(i+1:n) is stored on exit in
  144.      A(i,i+1:n); tauq is stored in TAUQ(i) and taup in TAUP(i).
  145.  
  146.      If m < n, v(1:i) = 0, v(i+1) = 1, and v(i+1:m) is stored on exit in
  147.      A(i+2:m,i); u(1:i-1) = 0, u(i) = 1, and u(i:n) is stored on exit in
  148.      A(i,i+1:n); tauq is stored in TAUQ(i) and taup in TAUP(i).
  149.  
  150.      The elements of the vectors v and u together form the m-by-nb matrix V
  151.      and the nb-by-n matrix U' which are needed, with X and Y, to apply the
  152.      transformation to the unreduced part of the matrix, using a block update
  153.      of the form:  A := A - V*Y' - X*U'.
  154.  
  155.      The contents of A on exit are illustrated by the following examples with
  156.      nb = 2:
  157.  
  158.      m = 6 and n = 5 (m > n):          m = 5 and n = 6 (m < n):
  159.  
  160.        (  1   1   u1  u1  u1 )           (  1   u1  u1  u1  u1  u1 )
  161.        (  v1  1   1   u2  u2 )           (  1   1   u2  u2  u2  u2 )
  162.        (  v1  v2  a   a   a  )           (  v1  1   a   a   a   a  )
  163.        (  v1  v2  a   a   a  )           (  v1  v2  a   a   a   a  )
  164.        (  v1  v2  a   a   a  )           (  v1  v2  a   a   a   a  )
  165.        (  v1  v2  a   a   a  )
  166.  
  167.      where a denotes an element of the original matrix which is unchanged, vi
  168.      denotes an element of the vector defining H(i), and ui an element of the
  169.      vector defining G(i).
  170.  
  171.  
  172. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  173.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  174.  
  175.      This man page is available only online.
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.