dtrMatrix-class            package:Matrix            R Documentation

_T_r_i_a_n_g_u_l_a_r, _d_e_n_s_e, _n_u_m_e_r_i_c _m_a_t_r_i_c_e_s

_D_e_s_c_r_i_p_t_i_o_n:

     The '"dtrMatrix"' class is the class of triangular, dense, numeric
     matrices in nonpacked storage.  The '"dtpMatrix"' class is the
     same except in packed storage.

_O_b_j_e_c_t_s _f_r_o_m _t_h_e _C_l_a_s_s:

     Objects can be created by calls of the form 'new("dtrMatrix",
     ...)'.

_S_l_o_t_s:


     '_u_p_l_o': Object of class '"character"'. Must be either "U", for
          upper triangular, and "L", for lower triangular.

     '_d_i_a_g': Object of class '"character"'. Must be either '"U"', for
          unit triangular (diagonal is all ones), or '"N"'; see
          'triangularMatrix'.

     '_x': Object of class '"numeric"'. The numeric values that
          constitute the matrix, stored in column-major order.

     '_D_i_m': Object of class '"integer"'. The dimensions of the matrix
          which must be a two-element vector of non-negative integers.

_E_x_t_e_n_d_s:

     Class '"ddenseMatrix"', directly. Class '"triangularMatrix"',
     directly. Class '"Matrix"' and others, by class '"ddenseMatrix"'.

_M_e_t_h_o_d_s:


     %*% 'signature(x = "dtrMatrix", y = "matrix")' and other
          signatures (use 'showMethods("%*%", class="dtrMatrix")'):
          matrix multiplication.

     _c_o_e_r_c_e 'signature(from = "dgeMatrix", to = "dtrMatrix")'

     _c_o_e_r_c_e 'signature(from = "dtrMatrix", to = "matrix")'

     _c_o_e_r_c_e 'signature(from = "dtrMatrix", to = "ltrMatrix")'

     _c_o_e_r_c_e 'signature(from = "dtrMatrix", to = "matrix")'

     _c_o_e_r_c_e 'signature(from = "matrix",    to = "dtrMatrix")'

     _n_o_r_m 'signature(x = "dtrMatrix", type = "character")'

     _r_c_o_n_d 'signature(x = "dtrMatrix", norm = "character")'

     _s_o_l_v_e 'signature(a = "dtrMatrix", b = "missing")'

     _s_o_l_v_e 'signature(a = "dtrMatrix", b = "matrix")'

_S_e_e _A_l_s_o:

     Classes 'ddenseMatrix', 'dtpMatrix', 'triangularMatrix'

_E_x_a_m_p_l_e_s:

     (m <- rbind(2:3, 0:-1))
     (M <- as(m, "dgeMatrix"))

     (T <- as(M, "dtrMatrix")) ## upper triangular is default
     (T2 <- as(t(M), "dtrMatrix"))
     stopifnot(T@uplo == "U", T2@uplo == "L", identical(T2, t(T)))

