generalGraph-class          package:giRaph          R Documentation

_C_l_a_s_s "_g_e_n_e_r_a_l_G_r_a_p_h"

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

     A class for general 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("generalGraph",
     ...)'. A 'generalGraph' object consists of two slots, one for each
     possible representation: 'incidenceMatrix' and 'incidenceList'.

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

     '_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 '"anyGraph"', directly, with explicit coerce.

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

     _i_n_i_t_i_a_l_i_z_e 'signature(.Object="generalGraph")': constructs a
          general graph from one of the two possible representations

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

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

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

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

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

     _i_n_c_i_d_e_n_c_e_M_a_t_r_i_x 'signature(object = "generalGraph")': gets the
          incidence matrix representation

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

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

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

     _i_s_E_m_p_t_y 'signature(object = "generalGraph")': 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 = "generalGraph")': 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 = "generalGraph", y = "generalGraph")': x
          and y are the same if their non-empty slots represent the
          same graph

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

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

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

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

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

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

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

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

     + 'signature(e1 = "generalGraph", e2 = "edge")': adds an edge to a
          general graph

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

     * 'signature(e1 = "generalGraph", e2 = "vertexSet")': restricts a
          general 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'. Coercion to class 'dg.graph' is
     obtained by expanding hyper edges to sets of ordinary edges, and
     using dashed lines for these. 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:

     'incidenceMatrix-class' and 'incidenceMatrix'

