indexBytes              package:rindex              R Documentation

_I_n_d_e_x _i_n_f_o_r_m_a_t_i_o_n

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

     Some functions giving information about indices

_U_s_a_g_e:

     indexNodes(obj)
     indexBytes(obj)
     ## S3 method for class 'index':
     print(x, tree = FALSE, ...)
     ## S3 method for class 'index':
     str(object, ...)
     ## S3 method for class 'index':
     length(x)

_A_r_g_u_m_e_n_t_s:

       x: an object of class 'index' 

     obj: an object of class 'index' 

  object: an object of class 'index' 

    tree: TRUE to print the tree (default FALSE) 

     ...: ignored or passed 

_D_e_t_a_i_l_s:


          'indexNodes'  returns number of tree nodes
          'indexBytes'  returns indes size in bytes
         'print.index'  prints index info and optionally tree
           'str.index'  removes class and calls NextMethod("str")
        'length.index'  identical to 'length' of original vector
         'names.index'  currently forbidden
       'names<-.index'  currently forbidden

_V_a_l_u_e:

     Functions 'indexNodes', 'indexBytes' and 'length.index' return an
     integer (number of nodes, number of bytes, length of vector).

_N_o_t_e:

     There are dummy functions 'names.index', 'names<-.index' and
     '[<-.index' that catch non-supported use of these generics on
     index objects.

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

     Jens Oehlschlgel

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

     'index', 'length', 'object.size'

