multiGraph-class           package:giRaph           R Documentation

_C_l_a_s_s "_m_u_l_t_i_G_r_a_p_h"

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

     A class for multi-graphs.

_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("multiGraph",
     ...)'. A 'multiGraph' object consists of three slots, one for each
     possible representation: 'adjacencyList', 'incidenceMatrix' and
     'incidenceList'.

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

     '_a_d_j_a_c_e_n_c_y_L_i_s_t': Object of class '"adjacencyList"'

     '_i_n_c_i_d_e_n_c_e_M_a_t_r_i_x': Object of class '"incidenceMatrix"'

     '_i_n_c_i_d_e_n_c_e_L_i_s_t': Object of class '"incidenceList"'

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

     Class '"generalGraph"', directly, with explicit coerce. Class
     '"anyGraph"', directly, with explicit coerce.

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

     _i_n_i_t_i_a_l_i_z_e 'signature(.Object="multiGraph")': constructs a
          multi-graph from one of the three possible representations

     _s_h_o_w 'signature(object = "multiGraph")': displays the available
          representations of a multi-graph

     _d_i_s_p_l_a_y 'signature(x = "multiGraph")': static graphical
          representation via package 'mathgraph'

     _d_y_n_a_m_i_c._G_r_a_p_h 'signature(object = "multiGraph")': dynamic
          graphical representation via package 'dynamicGraph'

     _i_n_c_i_d_e_n_c_e_L_i_s_t<- 'signature(x = "multiGraph")': sets the incidence
          list representation

     _i_n_c_i_d_e_n_c_e_M_a_t_r_i_x<- 'signature(x = "multiGraph")': sets the
          incidence matrix representation

     _a_d_j_a_c_e_n_c_y_L_i_s_t<- 'signature(x = "multiGraph")': sets the adjacency
          list representation

     _a_d_j_a_c_e_n_c_y_L_i_s_t 'signature(object = "multiGraph")': gets the
          adjacency list representation

     _n_a_m_e_s 'signature(x = "multiGraph")': gets the character vertex
          identifiers of a multi-graph

     _n_a_m_e_s<- 'signature(x = "multiGraph")': sets the character vertex
          identifiers of a multi-graph

     _c_a_r_d 'signature(object = "multiGraph")': returns the number of
          vertices and the total number of edge occurrences in a
          multi-graph

     _i_s_E_m_p_t_y 'signature(object = "multiGraph")': a graph object is
          empty if all its possible representations are empty

     _i_s_P_r_e_s_e_n_t 'signature(el = "edge", ou = "multiGraph")': an edge
          occurs in a graph object if it occurs in its non-empty slots

     _a_r_e_T_h_e_S_a_m_e 'signature(x = "multiGraph", y = "multiGraph")': x and
          y are the same if their non-empty slots represent the same
          graph

     [ 'signature(x = "multiGraph")': extracts an induced subgraph

     [[ 'signature(x = "multiGraph")': extracts the character
          identifier of a vertex 

     _c_o_e_r_c_e 'signature(from = "anyGraph", to = "multiGraph")': all but
          ordinary directed and undirected edges are lost in the
          conversion

     _c_o_e_r_c_e 'signature(from = "generalGraph", to = "multiGraph")':
          hyper-edges are lost in the conversion

     _c_o_e_r_c_e 'signature(from = "simpleGraph", to = "multiGraph")': no
          edges are lost in the conversion as every simple-graph is a
          multi-graph

     _c_o_e_r_c_e 'signature(from = "multiGraph", to = "dg.simple.graph")':
          conversion to class 'dg.simple.graph' of package
          'dynamicGraph'

     _c_o_e_r_c_e 'signature(from = "multiGraph", to = "dg.graph")':
          conversion to class 'dg.graph' of package 'dynamicGraph'

     + 'signature(e1 = "multiGraph", e2 = "vertexSet")': adds a vertex
          set to a multi-graph by making the new vertices isolated

     - 'signature(e1 = "multiGraph", e2 = "vertexSet")': removes a
          vertex set from a multi-graph by dropping all edges involving
          the vertex set

     + 'signature(e1 = "multiGraph", e2 = "edge")': adds an edge to a
          multi-graph

     - 'signature(e1 = "multiGraph", e2 = "edge")': removes an edge
          from a multi-graph

     * 'signature(e1 = "multiGraph", e2 = "vertexSet")': restricts a
          multi-graph to a vertex set by dropping all edges involving
          vertices outside the vertex set

_N_o_t_e:

     Graphical representation via package 'dynamicGraph' is based on
     coercion to class 'dg.graph', implemented via coercion to class
     'dg.simple.graph'. Coercion to class 'dg.simple.graph' is
     implemented via coercion to class 'simpleGraph', thus dropping
     loops and parallel edges. Graphical representation via package
     'mathgraph' is obtained by means of coercion to class
     'simpleGraph'.

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

     Jens Henrik Badsberg, Claus Dethlefsen, Luca La Rocca

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

     'adjacencyList-class' and 'adjacencyList'

