symmetricMatrix-class         package:Matrix         R Documentation

_V_i_r_t_u_a_l _C_l_a_s_s _o_f _S_y_m_m_e_t_r_i_c _M_a_t_r_i_c_e_s _i_n _p_a_c_k_a_g_e:_M_a_t_r_i_x

_D_e_s_c_r_i_p_t_i_o_n:

     The virtual class of symmetric matrices, '"symmetricMatrix"', from
     the package 'Matrix' contains numeric and logical, dense and
     sparse matrices, e.g., see the examples.

     The main use is in methods (and C functions) that can deal with
     all symmetric 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_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.

     '_f_a_c_t_o_r_s': a list of matrix factorizations, also from the 'Matrix'
          class.

_E_x_t_e_n_d_s:

     Class '"Matrix"', directly.

_M_e_t_h_o_d_s:

     There's a C function 'symmetricMatrix_validity()' called by the
     internal validity checking functions.

_S_e_e _A_l_s_o:

     Classes 'triangularMatrix', and, e.g., 'dsyMatrix' for numeric
     _dense_ matrices, or 'lsCMatrix' for a logical _sparse_ matrix
     class.

_E_x_a_m_p_l_e_s:

     showClass("symmetricMatrix")

     ## The names of direct subclasses:
     scl <- getClass("symmetricMatrix")@subclasses
     directly <- sapply(lapply(scl, slot, "by"), length) == 0
     names(scl)[directly]

