returnFactorEdgeList      package:dynamicGraph      R Documentation

_C_l_a_s_s "_d_g._F_a_c_t_o_r_E_d_g_e_L_i_s_t": _T_h_e _f_a_c_t_o_r _e_d_g_e _l_i_s_t

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

     Return a list of factor edges, each of class 'dg.FactorEdge'.

     Objects can be created by calls of the form
     'new("dg.FactorEdgeList", ...)'.

_U_s_a_g_e:

     returnFactorEdgeList(edge.list, vertices, factorvertices = NULL,
                          width = 2, color = "DarkSlateGrey", N = 3, 
                          type = NULL)

_A_r_g_u_m_e_n_t_s:

edge.list: A list of vectors identifying the edges (between vertices).
          Each vector of 'edge.list' should be a vector of  integers
          giving the indices of the vertices of an edge, or a vector of
          text strings with the names of the vertices. 

vertices: The list of 'vertices',  each of a class containing
          'dg.Vertex'. 

factorvertices: The list of 'factorvertices',  each of a class
          containing 'dg.FactorVertex'. 

   width: A numeric with the initial 'width' of the factor edges. 

   color: A text string giving the initial 'color' of the factor edges. 

       N: Integer, 'N' is the number of coordinates of the vertices. 

    type: A text string giving the 'type' of the factor edges. 

_V_a_l_u_e:

     A list of edges, each of class 'dg.FactorEdge'.

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

     '._D_a_t_a': Object of class '"list"'. 

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

     Class '"dg.EdgeList"', directly. Class '"dg.list"', directly.
     Class '"list"', from data part. Class '"dg.NodeList"', by class
     '"dg.EdgeList"'. Class '"vector"', by class '"dg.EdgeList"'. Class
     '"vector"', by class '"dg.list"'. Class '"vector"', by class
     '"list"'.

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

     _i_n_i_t_i_a_l_i_z_e 'signature(.Object = "dg.FactorEdgeList")': ... 

_N_o_t_e:

     The methods of the edge list, 'returnEdgeList', also applies for
     factor edge lists.

     No example is given here since the factor edge list usually will
     be returned by the function  'returnFactorVerticesAndEdges'. The
     application is similar to 'returnBlockEdgeList', see example here.

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

     Jens Henrik Badsberg

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

     'returnFactorVerticesAndEdges' and 'returnBlockEdgeList'.

