simpleGraph-class           package:giRaph           R Documentation

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

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

     A class for simple-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("simpleGraph",
     ...)'. A 'simpleGraph' object consists of four slots, one for each
     possible representation: 'adjacencyMatrix', 'adjacencyList',
     'incidenceMatrix' and 'incidenceList'.

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

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

     '_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 '"multiGraph"', directly, with explicit coerce. 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="simpleGraph")': constructs a
          simple-graph from one of the four possible representations

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

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

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

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

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

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

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

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

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

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

     _c_a_r_d 'signature(object = "simpleGraph")': returns the number of
          vertices and the total number of edges (directed and
          undirected) in a simple graph

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

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

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

     _c_o_e_r_c_e 'signature(from = "anyGraph", to = "simpleGraph")': only
          ordinary directed and undirected edges, but no loops nor
          parallel edges, are kept in the conversion

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

     _c_o_e_r_c_e 'signature(from = "multiGraph", to = "simpleGraph")': loops
          and parallel edges are lost in the conversion

     _c_o_e_r_c_e 'signature(from = "mathgraph", to = "simpleGraph")':
          conversion from class 'mathgraph' of package 'mathgraph'

     _c_o_e_r_c_e 'signature(from = "simpleGraph", to = "mathgraph")':
          conversion to class 'mathgraph' of package 'mathgraph'

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

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

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

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

     + 'signature(e1 = "simpleGraph", e2 = "undirectedEdge")': adds an
          ordinary undirected edge (not a loop) to a simple graph

     + 'signature(e1 = "simpleGraph", e2 = "directedEdge")': adds an
          ordinary directed edge to a simple graph

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

     * 'signature(e1 = "simpleGraph", e2 = "vertexSet")': restricts a
          simple 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'.

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

     Jens Henrik Badsberg, Claus Dethlefsen, Luca La Rocca

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

     'adjacencyMatrix-class' and 'adjacencyMatrix'

