dtpMatrix-class            package:Matrix            R Documentation

_P_a_c_k_e_d _t_r_i_a_n_g_u_l_a_r _d_e_n_s_e _m_a_t_r_i_c_e_s

_D_e_s_c_r_i_p_t_i_o_n:

     The '"dtpMatrix"' class is the class of triangular, dense, numeric
     matrices in packed storage.  The '"dtrMatrix"' class is the same
     except in nonpacked 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("dtpMatrix",
     ...)' or by coercion from other classes of matrices.

_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. For a
          packed square matrix of dimension d * d, 'length(x)' is of
          length d(d+1)/2 (also when 'diag == "U"'!).

     '_D_i_m','_D_i_m_n_a_m_e_s': The dimension (a length-2 '"integer"') and
          corresponding names (or 'NULL'), inherited from the 'Matrix',
          see there.

_E_x_t_e_n_d_s:

     Class '"ddenseMatrix"', directly. Class '"triangularMatrix"',
     directly. Class '"dMatrix"' and more by class '"ddenseMatrix"'
     etc, see the examples.

_M_e_t_h_o_d_s:


     %*% 'signature(x = "dtpMatrix", y = "dgeMatrix")': Matrix
          multiplication; ditto for several other signature
          combinations, see 'showMethods("%*%", class = "dtpMatrix")'.

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

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

     _d_e_t_e_r_m_i_n_a_n_t 'signature(x = "dtpMatrix", logarithm = "missing")':
          ... 

     _d_e_t_e_r_m_i_n_a_n_t 'signature(x = "dtpMatrix", logarithm = "logical")':
          ... 

     _d_i_a_g 'signature(x = "dtpMatrix")': ... 

     _n_o_r_m 'signature(x = "dtpMatrix", type = "character")': ... 

     _n_o_r_m 'signature(x = "dtpMatrix", type = "missing")': ... 

     _r_c_o_n_d 'signature(x = "dtpMatrix", norm = "character")': ... 

     _r_c_o_n_d 'signature(x = "dtpMatrix", norm = "missing")': ... 

     _s_o_l_v_e 'signature(a = "dtpMatrix", b = "missing")': ... 

     _s_o_l_v_e 'signature(a = "dtpMatrix", b = "matrix")': ... 

     _t 'signature(x = "dtpMatrix")': ... 

     _u_n_p_a_c_k 'signature(x = "dtpMatrix")': ... 

_S_e_e _A_l_s_o:

     Class 'dtrMatrix'

_E_x_a_m_p_l_e_s:

     showClass("dtrMatrix")

     example("dtrMatrix-class")
     (p1 <- as(T2, "dtpMatrix"))
     str(p1)
     (pp <- as(T, "dtpMatrix"))
     stopifnot(length(p1@x) == 3, length(pp@x) == 3,
               p1 @ uplo == T2 @ uplo, pp @ uplo == T @ uplo)

