adjacencyMatrix-class         package:giRaph         R Documentation

_C_l_a_s_s "_a_d_j_a_c_e_n_c_y_M_a_t_r_i_x"

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

     A class for adjacency matrix representation of 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("adjacencyMatrix",X)'.

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

     '._D_a_t_a': Object of class '"matrix"'; standard 0-1 coding for
          ordinary directed and undirected edges

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

     Class '"matrix"', from data part. Class '"structure"', by class
     '"matrix"'. Class '"array"', by class '"matrix"'. Class
     '"vector"', by class "matrix", with explicit coerce.

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

     _i_n_i_t_i_a_l_i_z_e 'signature(.Object = "adjacencyMatrix")': constructs an
          adjacency matrix representation of a simple-graph from a 0-1
          matrix

     _s_h_o_w 'signature(object = "adjacencyMatrix")': displays an
          adjacency matrix representation 

     _n_a_m_e_s 'signature(x = "adjacencyMatrix")': gets the character
          vertex identifiers of an adjacency matrix

     _n_a_m_e_s<- 'signature(x = "adjacencyMatrix")': sets the character
          vertex identifiers of an adjacency matrix

     _c_a_r_d 'signature(object = "adjacencyMatrix")': returns the number
          of vertices and the total number of edges (directed and
          undirected) in an incidence matrix

     _i_s_E_m_p_t_y 'signature(object = "adjacencyMatrix")': an adjacency
          matrix is empty if it has no entries

     _i_s_P_r_e_s_e_n_t 'signature(el = "undirectedEdge", ou =
          "adjacencyMatrix")': tells whether an undirected edge occurs
          in the graph represented by an adjacency matrix

     _i_s_P_r_e_s_e_n_t 'signature(el = "directedEdge", ou =
          "adjacencyMatrix")': tells whether a directed edge occurs in
          the graph represented by an adjacency matrix

     _a_r_e_T_h_e_S_a_m_e 'signature(x = "adjacencyMatrix", y =
          "adjacencyMatrix")': x and y are the same adjacency matrix if
          they represent the same simple-graph

     [ 'signature(x = "adjacencyMatrix")': extracts the adjacency
          matrix of an induced subgraph

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

     _c_o_e_r_c_e 'signature(from = "incidenceList", to =
          "adjacencyMatrix")': converts an incidence list to an
          adjacency matrix by keeping ordinary directed and undirected
          edges and dropping loops and parallel edges

     _c_o_e_r_c_e 'signature(from = "incidenceMatrix", to =
          "adjacencyMatrix")': converts an incidence matrix to an
          adjacency matrix by dropping hyper-edges, loops and parallel
          edges

     _c_o_e_r_c_e 'signature(from = "adjacencyList", to =
          "adjacencyMatrix")': converts an adjacency list to an
          adjacency matrix by dropping loops and parallel edges

     + 'signature(e1 = "adjacencyMatrix", e2 = "vertexSet")': adds a
          vertex set to an adjacency matrix by making the new vertices
          isolated

     - 'signature(e1 = "adjacencyMatrix", e2 = "vertexSet")': removes a
          vertex set from an adjacency matrix by dropping all edges
          involving the vertex set

     + 'signature(e1 = "adjacencyMatrix", e2 = "undirectedEdge")': adds
          an ordinary undirected edge (not a loop) to an adjacency
          matrix

     + 'signature(e1 = "adjacencyMatrix", e2 = "directedEdge")': adds
          an ordinary directed edge to an adjacency matrix

     - 'signature(e1 = "adjacencyMatrix", e2 = "undirectedEdge")':
          removes an undirected edge from an adjacency matrix

     - 'signature(e1 = "adjacencyMatrix", e2 = "directedEdge")':
          removes a directed edge from an adjacency matrix

     * 'signature(e1 = "adjacencyMatrix", e2 = "vertexSet")': restricts
          an adjacency matrix to a vertex set by dropping all edges
          involving vertices outside the vertex set

_W_a_r_n_i_n_g:

     All input non-zero diagonal entries are silently changed to zero
     by the constructor.

_N_o_t_e:

     The 'names<-' replacement method works only if the names to be
     assigned can be used to construct a 'vertexSet' object having the
     right cardinality, otherwise the names are left unchanged and a
     warning message is given.

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

     Jens Henrik Badsberg, Claus Dethlefsen, Luca La Rocca

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

     'adjacencyMatrix' and 'simpleGraph-class'

