allIndex-class        package:externalVector        R Documentation

_C_l_a_s_s "_a_l_l_I_n_d_e_x", _i_n_d_e_x _c_l_a_s_s _r_e_p_r_e_s_e_n_t_i_n_g _a _s_u_b_s_c_r_i_p_t _f_o_r _a_l_l
_e_l_e_m_e_n_t_s _o_f _a _v_e_c_t_o_r _o_r _a_n _a_r_r_a_y _d_i_m_e_n_s_i_o_n

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

     When used as a subscript for a vector object 'x', this is
     equivalent to 'seq(length(x))'. When used as a subscript for the
     'i'-th dimension of an array object 'x', this is equivalent to
     'seq(dim(x)[i])'.

_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("allIndex")'.
     Objects from this class can not be modified and they are all
     equivalent.

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

     '._D_a_t_a': Object of class '"logical"', this is always equal to
          'TRUE'. 

_E_x_t_e_n_d_s:

     Class '"logical"', directly. Class '"vectorIndex"', directly.

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

     Signature components for the methods are:

       x        The class "allIndex"
       scalar   Length one positive "integer"
       i        The class "ANY"
       value    The class "ANY"
       .Object  The class "allIndex"

     '_x+_s_c_a_l_a_r': Add 'scalar' to 'x'. Result is 'x'. 

     '_s_c_a_l_a_r+_x': Add 'scalar' to 'x'. Result is 'x'. 

     '_x*_s_c_a_l_a_r': Multiply 'x' by 'scalar'. Result is 'x'. 

     '_s_c_a_l_a_r*_x': Multiply 'x' by 'scalar'. Result is 'x'. 

     _d_i_m(_x) <- _v_a_l_u_e Set a dimension on 'x'. If value is of length 2,
          this may create a "matrixIndex". 

     '_x[_i]': Subset x. Result is i. 

     '_x[]': Subset x with the subscript missing. Result is x. 

     '_x[_i] <- _v_a_l_u_e': Subassign x. Results in an error (as objects from
          class '"allIndex"' are not mutable. 

     '_x[[_i]] <- _v_a_l_u_e': Subassign x. Results in an error (as objects
          from class '"allIndex"' are not mutable. 

     '_a_l_l_N_A(_x)': Are all elements of 'x' 'NA'? Result is always
          'FALSE'. 

     '_a_n_y_N_A(_x)': Is any element of 'x' 'NA'? Result is always 'FALSE'. 

     '_i_n_i_t_i_a_l_i_z_e(._O_b_j_e_c_t)': Initialize an object from class
          '"allIndex"'. 

     '_l_e_n_g_t_h(_x)': Return the length of 'x' which is always 'Inf'. 

     '_l_e_n_g_t_h(_x) <- _v_a_l_u_e': Modify the length of 'x'. Always results in
          an error. 

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

     'vectorIndex-class' for the super class of '"allIndex"'.

