returnFactorEdgeList: Class dg.FactorEdgeList: The factor edge list

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

Description

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

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

Usage

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

Arguments

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.

Value

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

Slots

.Data:

Object of class "list".

Extends

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

Methods

initialize

signature(.Object = "dg.FactorEdgeList"): ...

Note

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.

Author(s)

Jens Henrik Badsberg

See Also

returnFactorVerticesAndEdges and returnBlockEdgeList.


dynamicGraph documentation built on May 2, 2019, 6:38 a.m.