SRC/slarft.f(3)

πŸ’… SRC/slarft.f(3) β€” Library Functions Manual πŸ’…

okay bestie, welcome to the SRC/slarft.f(3) page from the Library Functions Manual. This one is all about slarft, and it's lowkey iconic if you're into block reflectors. πŸ¦‹

πŸ’– NAME πŸ’–

SRC/slarft.f β€” that's the file, fr fr.

✨ SYNOPSIS ✨

Functions/Subroutines

  • recursive subroutine slarft (direct, storev, n, k, v, ldv, tau, t, ldt) β€” SLARFT forms the triangular factor T of a block reflector H = I - vtvH.

πŸŽ€ Function/Subroutine Documentation πŸŽ€

   recursive subroutine slarft (character direct, character storev, integer n,
       integer k, real, dimension( ldv, * ) v, integer ldv, real, dimension( *
       ) tau, real, dimension( ldt, * ) t, integer ldt)

SLARFT forms the triangular factor T of a block reflector H = I - vtvH.

🧚 Purpose 🧚

Here's the tea: SLARFT forms the triangular factor T of a real block reflector H of order n, and H is defined as a product of k elementary reflectors.

  • If DIRECT = 'F', then H = H(1) H(2) . . . H(k) and T is upper triangular.
  • If DIRECT = 'B', then H = H(k) . . . H(2) H(1) and T is lower triangular.
  • If STOREV = 'C', the vector which defines the elementary reflector H(i) is stored in the i-th column of the array V, and:
H  =  I - V * T * V**T
  • If STOREV = 'R', the vector which defines the elementary reflector H(i) is stored in the i-th row of the array V, and:
H  =  I - V**T * T * V

πŸ’… Parameters πŸ’…

  • DIRECT β€” DIRECT is CHARACTER*1. It specifies the order in which the elementary reflectors are multiplied to form the block reflector:
    • = 'F': H = H(1) H(2) . . . H(k) (Forward)
    • = 'B': H = H(k) . . . H(2) H(1) (Backward)
  • STOREV β€” STOREV is CHARACTER*1. It specifies how the vectors which define the elementary reflectors are stored (see also Further Details):
    • = 'C': columnwise
    • = 'R': rowwise
  • N β€” N is INTEGER. The order of the block reflector H. N >= 0.
  • K β€” K is INTEGER. The order of the triangular factor T (= the number of elementary reflectors). K >= 1.
  • V β€” V is REAL array, dimension (LDV,K) if STOREV = 'C', or (LDV,N) if STOREV = 'R'. The matrix V. See further details.
  • LDV β€” LDV is INTEGER. The leading dimension of the array V. If STOREV = 'C', LDV >= max(1,N); if STOREV = 'R', LDV >= K.
  • TAU β€” TAU is REAL array, dimension (K). TAU(i) must contain the scalar factor of the elementary reflector H(i).
  • T β€” T is REAL array, dimension (LDT,K). The k by k triangular factor T of the block reflector. If DIRECT = 'F', T is upper triangular; if DIRECT = 'B', T is lower triangular. The rest of the array is not used.
  • LDT β€” LDT is INTEGER. The leading dimension of the array T. LDT >= K.

🌸 Author 🌸

  • Univ. of Tennessee
  • Univ. of California Berkeley
  • Johnathan Rhyne, Univ. of Colorado Denver (original author, 2024)
  • NAG Ltd.

πŸ¦‹ Further Details πŸ¦‹

The shape of the matrix V and the storage of the vectors which define the H(i) is best illustrated by this example with n = 5 and k = 3. The elements equal to 1 are not stored.

DIRECT = 'F' and STOREV = 'C':         DIRECT = 'F' and STOREV = 'R':

             V = (  1       )                 V = (  1 v1 v1 v1 v1 )
                 ( v1  1    )                     (     1 v2 v2 v2 )
                 ( v1 v2  1 )                     (        1 v3 v3 )
                 ( v1 v2 v3 )
                 ( v1 v2 v3 )
DIRECT = 'B' and STOREV = 'C':         DIRECT = 'B' and STOREV = 'R':

             V = ( v1 v2 v3 )                 V = ( v1 v1  1       )
                 ( v1 v2 v3 )                     ( v2 v2 v2  1    )
                 (  1 v2 v3 )                     ( v3 v3 v3 v3  1 )
                 (     1 v3 )
                 (        1 )

Definition at line 162 of file slarft.f.

πŸ“ Author πŸ“

Generated automatically by Doxygen for LAPACK from the source code.


Cute sign-off: this page is from LAPACK Version 3.12.0, source SRC/slarft.f(3) β€” and the footer has no date listed, just those deets. πŸ’–

πŸ“¦ where this page comes from