svd                   package:base                   R Documentation

_S_i_n_g_u_l_a_r _V_a_l_u_e _D_e_c_o_m_p_o_s_i_t_i_o_n _o_f _a _M_a_t_r_i_x

_D_e_s_c_r_i_p_t_i_o_n:

     Compute the singular-value decomposition of a rectangular matrix.

_U_s_a_g_e:

     svd(x, nu = min(n, p), nv = min(n, p), LINPACK = FALSE)

     La.svd(x, nu = min(n, p), nv = min(n, p),
            method = c("dgesdd", "dgesvd"))

_A_r_g_u_m_e_n_t_s:

       x: a real or complex matrix whose SVD decomposition is to be
          computed.

      nu: the number of left  singular vectors to be computed. This
          must be one of '0', 'nrow(x)' and 'ncol(x)', except for the
          default options for real matrices.

      nv: the number of right singular vectors to be computed. This
          must be one of '0' and 'ncol(x)'.

 LINPACK: logical. Should LINPACK be used (for compatibility with R <
          1.7.0)?

  method: The LAPACK routine to use in the real case.

_D_e_t_a_i_l_s:

     The singular value decomposition plays an important role in many
     statistical techniques.  'svd' and 'La.svd' provide two slightly
     different interfaces.  The main functions used are the LAPACK
     routines DGESDD and ZGESVD; 'svd(LINPACK=TRUE)' provides an
     interface to the LINPACK routine DSVDC, purely for backwards
     compatibility.

     'La.svd' provides an interface to both the LAPACK routines DGESVD
     and DGESDD.  The latter is usually substantially faster if
     singular vectors are required: see <URL:
     http://www.cs.berkeley.edu/~demmel/DOE2000/Report0100.html>. Most
     benefit is seen with an optimized BLAS system.  As from R 2.3.0,
     using 'method="dgesvd"' is deprecated.

     Computing the singular vectors is the slow part for large
     matrices.

     Unsuccessful results from the underlying LAPACK code will result
     in an error giving a positive error code: these can only be
     interpreted by detailed study of the FORTRAN code.

_V_a_l_u_e:

     The SVD decomposition of the matrix as computed by LINPACK,

                            *X = U D V'*,

     where *U* and *V* are orthogonal, *V'* means _V transposed_, and
     *D* is a diagonal matrix with the singular values D[i,i]. 
     Equivalently, *D = U' X V*, which is verified in the examples,
     below.

     The returned value is a list with components 

       d: a vector containing the singular values of 'x'.

       u: a matrix whose columns contain the left singular vectors of
          'x', present if 'nu > 0'

       v: a matrix whose columns contain the right singular vectors of
          'x', present if 'nv > 0'.


     For 'La.svd' the return value replaces 'v' by 'vt', the
     (conjugated if complex) transpose of 'v'.

_R_e_f_e_r_e_n_c_e_s:

     Becker, R. A., Chambers, J. M. and Wilks, A. R. (1988) _The New S
     Language_. Wadsworth & Brooks/Cole.

     Dongarra, J. J., Bunch, J. R., Moler, C. B. and Stewart, G. W.
     (1978) _LINPACK Users Guide._  Philadelphia: SIAM Publications.

     Anderson. E. and ten others (1999) _LAPACK Users' Guide_. Third
     Edition. SIAM.
      Available on-line at <URL:
     http://www.netlib.org/lapack/lug/lapack_lug.html>.

_S_e_e _A_l_s_o:

     'eigen', 'qr'.

     'capabilities' to test for IEEE 754 arithmetic.

_E_x_a_m_p_l_e_s:

     hilbert <- function(n) { i <- 1:n; 1 / outer(i - 1, i, "+") }
     X <- hilbert(9)[,1:6]
     (s <- svd(X))
     D <- diag(s$d)
     s$u %*% D %*% t(s$v) #  X = U D V'
     t(s$u) %*% X %*% s$v #  D = U' X V

