ssclme-class             package:Matrix             R Documentation

_l_m_e _m_o_d_e_l_s _a_s _s_p_a_r_s_e, _s_y_m_m_e_t_r_i_c _m_a_t_r_i_c_e_s

_D_e_s_c_r_i_p_t_i_o_n:

     A representation of a linear mixed-effects model using a
     combination of sparse, symmetric, column-oriented matrices and
     dense matrices.

_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("ssclme", ...)'
     or, more commonly, via the 'ssclme' constructor function.

_S_l_o_t_s:

     '_G_p': integer vector of pointers to the beginning of each group of
          columns.  Its length is 1 greater than the number of groups. 
          Successive differences give the number of levels of each
          factor. 

     '_p': as for '"sscMatrix"' objects.

     '_i': as for '"sscMatrix"' objects.

     '_x': as for '"sscMatrix"' objects.

     '_D_i_m': as for '"sscMatrix"' objects.

     '_n_c': An integer vector of the number of columns in each model
          matrix.  The last entry is 'p+1' where 'p' is the number of
          columns in the fixed-effects model matrix.

     '_Z_t_X': A (dense) matrix equivalent to 'crossprod(Z,X)'.

     '_X_t_X': A (dense) matrix equivalent to the upper triangle of
          'crossprod(X)' where 'X' has the response column appended.

     '_L_p': An integer vector of pointers to the beginnings of the
          columns of the unit lower triangular factor L in the LDL'
          decomposition of Z'Z+W.

     '_P_a_r_e_n_t': An integer vector from the symbolic analysis of the
          cross-tabulation.  It is used to compute L efficiently.

     '_L_i': Row indices of L.

     '_D': Diagonal of the diagonal matrix in the LDL' decomposition of
          Z'Z+W.

     '_D_I_s_q_r_t': Square root of the inverse of the diagonal of D in LDL'.

     '_L_x': Non-zero elements in the (strict) lower triangle of L.

     '_R_Z_X': A dense matrix corresponding to 'ZtX' in the decomposition.

     '_R_X_X': A dense matrix corresponding to 'XtX' in the decomposition.

     '_L_I_p': An integer vector of pointers to the columns of the unit
          lower triangular inverse of L.

     '_L_I_i': Row indices of L-inverse.

     '_L_I_x': Non-zero elements in the (strict) lower triangle of
          L-inverse.

     '_s_t_a_t_u_s': Logical vector of length 2 indicating if the object has
          been factored and if the factorization has been inverted.

     '_d_e_v_i_a_n_c_e': Numeric vector of length 2 containing the deviance
          corresponding to the maximum likelihood (ML) and REML
          criteria.  This slot's contents are current if
          'status$factored' is 'TRUE'.

     '_d_e_v_C_o_m_p': Numeric vector of length 4 giving the components used
          to calculate the deviance. This slot's contents are current
          if 'status$factored' is 'TRUE'.

     '_b_V_a_r': A list of numeric 3-dimensional arrays giving the
          conditional variances of the random effects. This slot's
          contents are current if 'status$inverted' is 'TRUE'.

     '_O_m_e_g_a': A list of numeric matrices providing the components of
          symmetric, positive-definite matrix Omega.  Only the upper
          triangle of each component is used and stored.

_M_e_t_h_o_d_s:

     _c_o_e_f 'signature(object = "ssclme")': Extract the "coefficients"
          from the object as a numeric vector.  If the optional
          argument 'unconst' is 'FALSE' (the default), the values in
          the upper triangles of the 'Omega' matrices are concatenated.
           Within each matrix the diagonal is given first then the
          elements above the diagonal are given row-wise.  If 'unconst'
          is 'TRUE', an unconstrained parameterization based on the LDL
          decomposition (logarithms of diagonal elements of D followed
          by elements of the strict lower triangle of L column-wise)
          are given.

     _c_o_e_f<- 'signature(object = "ssclme", value = "numeric")': Assign
          the 'Omega' matrices from a numeric vector.  The assignment
          depends on the optional argument 'unconst' as described
          above.

     _c_o_e_r_c_e 'signature(from = "ssclme", to = "sscMatrix")': return the
          current Z'Z matrix as an 'sscMatrix' object.

     _c_o_e_r_c_e 'signature(from = "ssclme", to = "tscMatrix")': return the
          current L matrix from the LDL decomposition of Z'Z as a
          'tscMatrix' object.

_S_e_e _A_l_s_o:

     'sscCrosstab-class', 'sscMatrix-class', 'tscMatrix-class'

