returnFactorVerticesAndEdges: Class dg.FactorVertexList: The factor vertex list

Description Usage Arguments Details Value Slots Extends Methods Note Author(s)

Description

Create factor vertex and factor edge lists.

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

Usage

1
2
3
4
5
6
returnFactorVerticesAndEdges(Vertices, factors = NULL, types = "Generator", 
                             factorVertexColor = "default", 
                             factorEdgeColor = "DarkOliveGreen", 
                             
                             fixedFactorPositions = FALSE,
                             factorClasses = validFactorClasses())

Arguments

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.

Details

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.

Value

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.

Slots

.Data:

Object of class "list".

Extends

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".

Methods

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

Note

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.

Author(s)

Jens Henrik Badsberg


dynamicGraph documentation built on May 29, 2017, 8:01 p.m.