dMatrix-class             package:Matrix             R Documentation

(_V_i_r_t_u_a_l) _C_l_a_s_s "_d_M_a_t_r_i_x" _o_f "_d_o_u_b_l_e" _M_a_t_r_i_c_e_s

_D_e_s_c_r_i_p_t_i_o_n:

     The 'dMatrix' class is a virtual class contained by all actual
     classes of numeric matrices in the 'Matrix' package.  Similarly,
     all the actual classes of logical matrices inherit from the
     'lMatrix' class.

_S_l_o_t_s:

     Common to _all_ matrix object in the package:

     '_D_i_m': Object of class '"integer"' - the dimensions of the matrix
          - must be an integer vector with exactly two non-negative
          values.

     '_D_i_m_n_a_m_e_s': list of length two; each component containing NULL or
          a 'character' vector length equal the corresponding 'Dim'
          element.

_M_e_t_h_o_d_s:

     There are (relatively simple) group methods (see, e.g., 'Arith')

     _A_r_i_t_h 'signature(e1 = "dMatrix", e2 = "dMatrix")': ... 

     _A_r_i_t_h 'signature(e1 = "dMatrix", e2 = "numeric")': ... 

     _A_r_i_t_h 'signature(e1 = "numeric", e2 = "dMatrix")': ... 

     _M_a_t_h 'signature(x = "dMatrix")': ... 

     _M_a_t_h_2 'signature(x = "dMatrix", digits = "numeric")': this group
          contains 'round()' and 'signif()'.

     _C_o_m_p_a_r_e 'signature(e1 = "numeric", e2 = "dMatrix")': ... 

     _C_o_m_p_a_r_e 'signature(e1 = "dMatrix", e2 = "numeric")': ... 

     _C_o_m_p_a_r_e 'signature(e1 = "dMatrix", e2 = "dMatrix")': ... 

     _S_u_m_m_a_r_y 'signature(x = "dMatrix")': The '"Summary"' group contains
          the seven functions 'max()', 'min()', 'range()', 'prod()',
          'sum()', 'any()', and 'all()'.

     The following methods are also defined for all double matrices:

     _c_o_e_r_c_e 'signature(from = "dMatrix", to = "matrix")': ... 

     _e_x_p_m 'signature(x = "dMatrix")': computes the _"Matrix
          Exponential"_, see 'expm'.

     _z_a_p_s_m_a_l_l 'signature(x = "dMatrix")': ... 

_S_e_e _A_l_s_o:

     The nonzero-pattern matrix class 'nMatrix', and the numeric matrix
     classes 'dgeMatrix', 'dgCMatrix', and 'Matrix'.

_E_x_a_m_p_l_e_s:

      showClass("dMatrix")

      set.seed(101)
      round(Matrix(rnorm(28), 4,7), 2)
      (M <- zapsmall(Matrix(rlnorm(56, sd=10), 4,14)))
      table(as.logical(M == 0))

