undirectedEdge-class         package:giRaph         R Documentation

_C_l_a_s_s "_u_n_d_i_r_e_c_t_e_d_E_d_g_e"

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

     Class for undirected edges

_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("undirectedEdge",
     ...)' which admit short-hands of the form 'u(...)'.

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

     '._D_a_t_a': Object of class '"vector"' storing strictly positive
          numbers that refer to a given '"vertexSet"' object

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

     Class '"edge"', directly. Class '"integer"', from data part. Class
     '"vector"', by class '"integer"'. Class '"numeric"', by class
     '"integer"'.

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

     _i_n_i_t_i_a_l_i_z_e 'signature(.Object = "undirectedEdge")': constructs an
          undirected edge from a vector of strictly positive integers

     _s_h_o_w 'signature(object = "undirectedEdge")': displays an
          undirected edge as numbers joined by lines

     _s_h_o_w_R_e_l 'signature(object = "undirectedEdge",code="vertexSet")':
          displays an undirected edge as names joined by lines

     _a_r_e_T_h_e_S_a_m_e 'signature(x = "undirectedEdge", y =
          "undirectedEdge")': x and y are the same undirected edge if
          they are the same set of numbers

     _a_r_e_T_h_e_S_a_m_e 'signature(x = "undirectedEdge", y = "edge")': always
          returns FALSE, as two edges of different kind are never the
          same

     _a_r_e_T_h_e_S_a_m_e 'signature(x = "edge", y = "undirectedEdge")': always
          returns FALSE, as two edges of different kind are never the
          same    

     [ 'signature(x = "undirectedEdge")': extracts an undirected edge

     _c_o_e_r_c_e 'signature(from = "vector", to = "undirectedEdge")':
          constructs an undirected edge from vector input

     _c_o_e_r_c_e 'signature(from = "directedEdge", to = "undirectedEdge")':
          makes a directed edge undirected

     _m_a_x_I_d 'signature(x="undirectedEdge")': gets the maximum numeric
          identifier of an undirected edge

     _r_e_c_o_d_e 'signature(object =
          "undirectedEdge",src="vertexSet",dst="vertexSet")': recodes
          an undirected edge by making its numbers refer to another
          '"vertexSet"' object

_W_a_r_n_i_n_g:

     The constructor will try to handle any vector input by silently
     transforming it into a list of strictly positive integers.

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

     Jens Henrik Badsberg, Claus Dethlefsen, Luca La Rocca

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

     'edge-class', 'directedEdge-class', 'edgeList-class' and 'u'.

