directedEdge-class          package:giRaph          R Documentation

_C_l_a_s_s "_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 directed 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("directedEdge",
     ...)' which admit short-hands of the form 'd(...)' and 'r(...)'.

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

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

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

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

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

     _i_n_i_t_i_a_l_i_z_e 'signature(.Object = "directedEdge")': constructs a
          directed edge from a list of strictly positive integers

     _s_h_o_w 'signature(object = "directedEdge")': displays a directed
          edge as an ordered sequence of undirected edges joined by
          arrows (using numeric codes)

     _s_h_o_w_R_e_l 'signature(object = "directedEdge",code="vertexSet")':
          displays a directed edge as an ordered sequence of undirected
          edges joined by arrows (using character names

     _a_r_e_T_h_e_S_a_m_e 'signature(x = "directedEdge", y = "directedEdge")': x
          and y are the same directed edge if they are the same ordered
          sequence of undirected edges

     _a_r_e_T_h_e_S_a_m_e 'signature(x = "directedEdge", 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 = "directedEdge")': always
          returns FALSE, as two edges of different kind are never the
          same

     [ 'signature(x = "directedEdge")': extracts a directed edge

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

     _c_a_r_d 'signature(object= "directedEdge")': counts all vertices in a
          directed edge

     _c_o_e_r_c_e 'signature(from = "vector", to = "directedEdge")':
          constructs a directed edge from vector input

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

     _m_a_x_I_d 'signature(x="directedEdge")': gets the maximum numeric
          identifier of a directed edge

     _r_e_c_o_d_e 'signature(object="directedEdge",src = "vertexSet", dst =
          "vertexSet")': recodes a directed 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', 'undirectedEdge-class', 'edgeList-class', 'd' and
     'r'.

