Hypergraph-class         package:hypergraph         R Documentation

_C_l_a_s_s _H_y_p_e_r_g_r_a_p_h

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

     A hypergraph consists of a set of nodes and a set of hyperedges. 
     Each hyperedge is a subset of the node set.  This class provides a
     representation of a hypergraph that is (hopefully) useful for
     computing.

_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("Hypergraph",
     nodes, hyperedges)'. You can also use the convenience function
     'Hypergraph'.  The 'nodes' argument should be a character vector
     of distinct labels representing the nodes of the hypergraph.  The
     'hyperedges' argument must be a list of 'Hyperedge-class' objects.

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

     '_n_o_d_e_s': A '"character"' vector specifying the nodes

     '_h_y_p_e_r_e_d_g_e_s': A '"list"' of 'Hyperedge-class' objects

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

     _h_y_p_e_r_e_d_g_e_s 'signature(.Object = "Hypergraph")': Return the list of
          'Hyperedge' objects 

     _i_n_c_i_M_a_t 'signature(.Object = "Hypergraph")': Return the incidence
          matrix representation of this hypergraph 

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

     _n_o_d_e_s 'signature(object = "Hypergraph")': Return the vector of
          nodes (character vector) 

     _n_u_m_N_o_d_e_s 'signature(object = "Hypergraph")': Return the number of
          nodes in the hypergraph 

     _t_o_G_r_a_p_h_N_E_L 'signature(.Object = "Hypergraph")': Return the
          'graphNEL' representation of the hypergraph (a bipartite
          graph) 

_N_o_t_e:

     ~~further notes~~

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

     Seth Falcon

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

     'Hyperedge-class' 'DirectedHyperedge-class' 'graphNEL-class'

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

     nodes <- LETTERS[1:4]
     hEdges <- lapply(c("A", LETTERS[1:2], LETTERS[3:4]), "Hyperedge")
     hg <- new("Hypergraph", nodes=nodes, hyperedges=hEdges)

