DirectedHyperedge-class      package:hypergraph      R Documentation

_C_l_a_s_s _D_i_r_e_c_t_e_d_H_y_p_e_r_e_d_g_e

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

     This class represents directed hyperedges in a 'Hypergraph-class'.
      A directed hyperedge consists of two disjount sets of nodes,
     those in the tail and those in the head of the hyperedge. 
     Directed hyperedges are sometimes called hyperarcs.

_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("DirectedHyperedge", head, tail, label)'. You can also use
     the convenience function 'DirectedHyperedge'.

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


     '_t_a_i_l': Character vector of nodes in the tail of the hyperedge

     '_h_e_a_d': Character vector of nodes in the head of the hyperege

     '_l_a_b_e_l': Character string describing the directed hyperedge

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

     Class '"Hyperedge"', directly.

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


     _h_e_a_d 'signature(.Object = "DirectedHyperedge")': Return a vector
          containing the nodes in the head of the hyperedge

     _t_a_i_l 'signature(.Object = "DirectedHyperedge")': Return a vector
          containing the nodes in the tail of the hyperedge

     _i_n_i_t_i_a_l_i_z_e 'signature(.Object = "DirectedHyperedge")': Create a
          new instance.

     _n_o_d_e_s 'signature(object = "DirectedHyperedge")': Return a vector
          containing all nodes present in the hyperedge.

     _s_h_o_w 'signature(object = "DirectedHyperedge")': Print me 

     _t_o_U_n_d_i_r_e_c_t_e_d 'signature(.Object = "DirectedHyperedge")': Return a
          'Hyperedge-class' object that results from coercing to an
          undirected hyperedge.

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

     Seth Falcon

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

     'DirectedHyperedge' 'Hyperedge' 'Hyperedge-class'
     'Hypergraph-class'

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

     head <- LETTERS[1:4]
     tail <- LETTERS[19:21]
     label <- "Directed hyperedge"
     dhe <- new("DirectedHyperedge", head=head, tail=tail, label=label)

