BufferedMatrix-class     package:BufferedMatrix     R Documentation

_C_l_a_s_s _B_u_f_f_e_r_e_d_M_a_t_r_i_x

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

     This is a class representation of a buffered matrix (of numeric
     data). In this case data is primarily stored outide main memory in
     temporary files.

_O_b_j_e_c_t_s _f_r_o_m _t_h_e _C_l_a_s_s:

     Objects can be created using the function 'createBufferedMatrix'

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

     '_r_a_w_B_u_f_f_e_r_e_d_M_a_t_r_i_x': a pointer to an external structure used to
          access and store the matrix data.

     '_r_o_w_n_a_m_e_s': rownames for the matrix.

     '_c_o_l_n_a_m_e_s': colnames for the matrix.

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

     _n_c_o_l 'signature(object = "BufferedMatrix")': Returns the number of
          columns in the matrix

     _n_r_o_w 'signature(object = "BufferedMatrix")': Returns the number of
          rows in the matrix

     _d_i_m 'signature(object = "BufferedMatrix")': Returns the dimensions
          of the matrix

     _b_u_f_f_e_r._d_i_m 'signature(object = "BufferedMatrix")': Returns the
          number of columns and the number of rows to be stored in the
          buffer

     _s_e_t._b_u_f_f_e_r._d_i_m 'signature(object = "BufferedMatrix")': Set the
          buffer size or resize it


     [ 'signature(object = "BufferedMatrix")': matrix accessor

     [<- 'signature(object = "BufferedMatrix")': matrix replacer

     _s_h_o_w 'signature(object = "BufferedMatrix")': prints basic
          information about the BufferedMatrix out to screen

     _i_s._R_o_w_M_o_d_e 'signature(object = "BufferedMatrix")': returns 'TRUE'
          if the row buffer is active and 'FALSE' otherwise.

     _i_s._C_o_l_M_o_d_e 'signature(object = "BufferedMatrix")': returns 'TRUE'
          if the row buffer is inactive and 'FALSE' otherwise.

     _R_o_w_M_o_d_e 'signature(object = "BufferedMatrix")': Activate the row
          buffer. 

     _C_o_l_M_o_d_e 'signature(object = "BufferedMatrix")': Deactivate the row
          buffer


     _d_u_p_l_i_c_a_t_e 'signature(object = "BufferedMatrix")': Make a copy of
          the BufferedMatrix


     _p_r_e_f_i_x 'signature(object = "BufferedMatrix")': return the initial
          part of the string used for temporary files


     _d_i_r_e_c_t_o_r_y 'signature(object = "BufferedMatrix")': return the
          location where temporary files are stored


     _f_i_l_e_n_a_m_e_s 'signature(object = "BufferedMatrix")': return the fully
          pathed filenames for each column in the matrix


     _e_w_A_p_p_l_y 'signature(object = "BufferedMatrix")': apply a function
          elementwise 

     _e_x_p 'signature(object = "BufferedMatrix")': Compute the
          exponential elementwise of the matrix


     _s_q_r_t 'signature(object = "BufferedMatrix")': Compute the
          square-root elementwise of the matrix 

     _p_o_w 'signature(object = "BufferedMatrix")':  Compute $x^{power}$
          elementwise of the matrix


     _l_o_g 'signature(object = "BufferedMatrix")':  Compute logarithm
          elementwise of the matrix


     _c_o_l_M_a_x 'signature(object = "BufferedMatrix")': Returns a vector
          containing maximums by column


     _r_o_w_M_a_x 'signature(object = "BufferedMatrix")': Returns a vector
          containing maximums by row


     _c_o_l_M_e_a_n_s 'signature(object = "BufferedMatrix")': Returns a vector
          containing means by column


     _r_o_w_M_e_a_n_s 'signature(object = "BufferedMatrix")': Returns a vector
          containing means by row


     _c_o_l_M_i_n 'signature(object = "BufferedMatrix")': Returns a vector
          containing minimums by column


     _r_o_w_M_i_n 'signature(object = "BufferedMatrix")': Returns a vector
          containing minimums by row


     _c_o_l_V_a_r_s 'signature(object = "BufferedMatrix")': Returns a vector
          containing sample variances by column


     _r_o_w_V_a_r_s 'signature(object = "BufferedMatrix")': Returns a vector
          containing sample variances by row


     _c_o_l_S_d 'signature(object = "BufferedMatrix")': Returns a vector
          containing sample standard deviations by column


     _r_o_w_S_d 'signature(object = "BufferedMatrix")': Returns a vector
          containing sample standard deviations by row


     _c_o_l_S_u_m_s 'signature(object = "BufferedMatrix")': Returns a vector
          containing sum by column


     _r_o_w_S_u_m_s 'signature(object = "BufferedMatrix")': Returns a vector
          containing sum by row


     _M_a_x 'signature(object = "BufferedMatrix")': Returns the maximum of
          all elements in the matrix


     _M_i_n 'signature(object = "BufferedMatrix")': Returns the minimum of
          all elements in the matrix


     _V_a_r 'signature(object = "BufferedMatrix")': Returns the sample
          variance of all elements in the matrix


     _S_d 'signature(object = "BufferedMatrix")': Returns the sample
          standard deviations of all elements in the matrix


     _S_u_m 'signature(object = "BufferedMatrix")': Returns the sum of all
          elements in the matrix


     _m_e_a_n 'signature(object = "BufferedMatrix")': Returns the mean of
          all elements in the matrix


     _c_o_l_A_p_p_l_y 'signature(object = "BufferedMatrix")': apply a function
          columnwise. Returns either a vector or BufferedMatrix. 

     _r_o_w_A_p_p_l_y 'signature(object = "BufferedMatrix")': apply a function
          row-wise. Returns either a vector or BufferedMatrix. 

     _a_s._m_a_t_r_i_x 'signature(object = "BufferedMatrix")': coerce
          BufferedMatrix into a regular R 'matrix'


     _s_u_b_B_u_f_f_e_r_e_d_M_a_t_r_i_x 'signature(object = "BufferedMatrix")': gets
          data from BufferedMatrix and returns it in another
          BufferedMatrix


     _r_o_w_n_a_m_e_s 'signature(object = "BufferedMatrix")' : access the row
          names


     _c_o_l_n_a_m_e_s 'signature(object = "BufferedMatrix")' : access the
          column names


     _r_o_w_n_a_m_e_s<- 'signature(object = "BufferedMatrix")' : replace the
          row names


     _c_o_l_n_a_m_e_s<- 'signature(object = "BufferedMatrix")' : replace the
          column names


     _d_i_m_n_a_m_e_s 'signature(object = "BufferedMatrix")' : Access the row
          and column names


     _d_i_m_n_a_m_e_s 'signature(object = "BufferedMatrix")' : Replace the row
          and column names


     _R_e_a_d_O_n_l_y_M_o_d_e 'signature(object = "BufferedMatrix")' : Toggles the
          Read Only mode on and off


     _i_s._R_e_a_d_O_n_l_y_M_o_d_e 'signature(object = "BufferedMatrix")' : Finds out
          if it is in Read Only Mode


     _m_e_m_o_r_y._u_s_a_g_e 'signature(object = "BufferedMatrix")' : Give amount
          of RAM currently in use by BufferedMatrix object


     _d_i_s_k._u_s_a_g_e 'signature(object = "BufferedMatrix")' : Give amount of
          disk space currently in use by BufferedMatrix object


     '_a_s(_m_a_t_r_i_x,_B_u_f_f_e_r_e_d_M_a_t_r_i_x)': Coerce 'matrix' to 'BufferedMatrix'.

     '_a_s(_B_u_f_f_e_r_e_d_M_a_t_r_i_x,_m_a_t_r_i_x)': Coerce the 'Buffered' to 'matrix'.

     '_A_d_d_C_o_l_u_m_n': Add an additional column to the matrix. Will be all
          empty (set to 0)

_A_u_t_h_o_r(_s):

     B. M. Bolstad bmb@bmbolstad.com

