returnFactorVerticesAndEdges  package:dynamicGraph  R Documentation

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

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

     Create factor vertex and factor edge lists.

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

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

     returnFactorVerticesAndEdges(Vertices, factors = NULL, types = "Generator", 
                                  factorVertexColor = "default", 
                                  factorEdgeColor = "DarkOliveGreen", 
                                  fixedFactorPositions = FALSE,
                                  factorClasses = validFactorClasses())

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

Vertices: The list of 'Vertices', each containing the class
          'dg.Vertex'. 

 factors: The list of vectors identifying the 'factors'. Each item in
          the list is a vector of the indices of vertices of a factor.  

   types: The 'types' of the factors. Either a single 'type' or a list
          of the same length as 'factors'. Each item of 'types' should
          match the labels of 'factorClasses', and is used to set the
          class of the factor vertex. 

factorVertexColor: The 'factorVertexColor' of the factor vertices. 

factorEdgeColor: The 'factorEdgeColor' of the factor edges. 

fixedFactorPositions: Logical.  If 'fixedFactorPositions' is setto TRUE
          then the factor  vertices will not follow the moved vertices. 

factorClasses: The valid 'factorClasses'. 

_D_e_t_a_i_l_s:

     The argument 'factors' is a list of vectors identifying  the
     'factors', or 'generators'. Each item in the list is a vector with
     of the indices (or names) of the vertices of a factor, or
     variables of a generator. A factor vertex is made for each factor,
     and factor edges from this factor vertex to the vertices of the
     factor or added to the factor edge list. Also the edges between
     pairs of the vertices in the factors are returned.

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

     A list with components 

FactorVertices: The list of factor vertices, each of class containing
          'dg.FactorVertex'. 

FactorEdges: The list of factor edge, each of class containing
          'dg.FactorEdge'.

PairEdges: A matrix with the edges of the graph, two columns with the
          indices of the vertices of two ends  of the edges. 

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

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

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

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

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

     No methods defined with class "dg.FactorVertexList" in the
     signature.

_N_o_t_e:

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

     Your 'modifyModel' should compute the new factors, generators,
     when modifying the model. See 'dg.Model-class' for examples on use
     of 'returnFactorVerticesAndEdges'.

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

     Jens Henrik Badsberg

