gNode-class              package:graph              R Documentation

_C_l_a_s_s "_g_N_o_d_e"

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

     This is an implemention of a very general graph node class. It is
     patterned after the descriptions in GXL.

_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("gNode", ...)'.
     These are nodes of a graph and can have any number of attributes.

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

     '_l_a_b_e_l': Object of class '"character"' A label of the node. Should
          be unique within the graph. 

     '_f_r_o_m_E_d_g_e_s': Object of class '"list"' A vector of the edge
          identifiers corresponding to the edges starting at that node. 

     '_t_o_E_d_g_e_s': Object of class '"list"' A vector of the edge
          identifiers corresponding to the edges pointing to that node. 

     '_e_d_g_e_O_r_d_e_r': Object of class '"list"' A vector of edge identifiers
          indicating the order in which the edges in the slot
          '"fromEdges"' would be traversed (may also be used for
          rendering). If this is of length zero, then the '"fromEdges"'
          slot is used for the order.

     '_n_o_d_e_T_y_p_e': Object of class '"character"' the type of node. Could
          be a factor. 

     '_n_o_d_e_I_D': Object of class '"Ruuid"' a unique identifier. 

     '_p_r_o_p_e_r_t_y': Object of class '"list"', holds properties associated
          with the graph node.

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

     Class '"propertyHolder"', directly.

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

     _e_d_g_e_O_r_d_e_r 'signature(object = "gNode")': A method that returns the
          'edgeOrder' for the named node.

     _f_r_o_m_E_d_g_e_s 'signature(object = "gNode")': A method that returns the
          'fromEdges'. 

     _f_r_o_m_E_d_g_e_s<- 'signature(object = "gNode")': A method that assigns
          the 'fromEdges'

     _l_a_b_e_l 'signature(object = "gNode")':A method that returns the node
          label. 

     _n_o_d_e_I_D 'signature(object = "gNode")': A method that returns the
          node identifier. 

     _n_o_d_e_T_y_p_e 'signature(object = "gNode")': A method that returns the
          node type. 

     _t_o_E_d_g_e_s 'signature(object = "gNode")': A method that returns the
          'toEdges'. 

     _t_o_E_d_g_e_s<- 'signature(object = "gNode")': A method that assigns the
          'toEdges'. 

     _i_d_s_t_r_i_n_g 'signature(x = "gNode")': A method that returns the node
          identifier as a character string.

     _i_n_i_t_i_a_l_i_z_e 'signature(.Object = "gNode", ...)': initializer for
          '"gNode"' class.

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

     R. Gentleman and Saikat DebRoy

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

     'distGraph-class', 'graphNEL-class'

_E_x_a_m_p_l_e_s:

     node <- new("gNode", label="A")
     label(node)
     idstring(node)

