Class FRLayoutAlgorithm<TVertex, TEdge, TGraph>

Fruchterman-Reingold layout algorithm.

Inheritance
System.Object
AlgorithmBase
LayoutAlgorithmBase<TVertex, TEdge, TGraph>
ParameterizedLayoutAlgorithmBase<TVertex, TEdge, TGraph, FRLayoutParametersBase>
FRLayoutAlgorithm<TVertex, TEdge, TGraph>
Implements
IParameterizedLayoutAlgorithm<TVertex, TEdge, TGraph>
ILayoutAlgorithm<TVertex, TEdge, TGraph>
QuikGraph.Algorithms.IAlgorithm<TGraph>
QuikGraph.Algorithms.IComputation
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: GraphShape.Algorithms.Layout
Assembly: GraphShape.dll
Syntax
public class FRLayoutAlgorithm<TVertex, TEdge, TGraph> : ParameterizedLayoutAlgorithmBase<TVertex, TEdge, TGraph, FRLayoutParametersBase>, IAlgorithm, IParameterizedLayoutAlgorithm<TVertex, TEdge, TGraph, FRLayoutParametersBase>, IParameterizedLayoutAlgorithm<TVertex, TEdge, TGraph>, ILayoutAlgorithm<TVertex, TEdge, TGraph>, IAlgorithm<TGraph>, IComputation where TEdge : IEdge<TVertex> where TGraph : IVertexAndEdgeListGraph<TVertex, TEdge>
Type Parameters
Name Description
TVertex

Vertex type.
TEdge

Edge type.
TGraph

Graph type

Constructors

| Improve this Doc View Source

FRLayoutAlgorithm(TGraph, FRLayoutParametersBase)

Initializes a new instance of the FRLayoutAlgorithm<TVertex, TEdge, TGraph> class.

Declaration
public FRLayoutAlgorithm(TGraph visitedGraph, FRLayoutParametersBase parameters = null)
Parameters
Type Name Description
TGraph visitedGraph

Graph to layout.
FRLayoutParametersBase parameters

Optional algorithm parameters.
Exceptions
Type Condition
System.ArgumentNullException

visitedGraph is null.
| Improve this Doc View Source

FRLayoutAlgorithm(TGraph, IDictionary<TVertex, Point>, FRLayoutParametersBase)

Initializes a new instance of the FRLayoutAlgorithm<TVertex, TEdge, TGraph> class.

Declaration
public FRLayoutAlgorithm(TGraph visitedGraph, IDictionary<TVertex, Point> verticesPositions, FRLayoutParametersBase parameters = null)
Parameters
Type Name Description
TGraph visitedGraph

Graph to layout.
System.Collections.Generic.IDictionary<TVertex, Point> verticesPositions

Vertices positions.
FRLayoutParametersBase parameters

Optional algorithm parameters.
Exceptions
Type Condition
System.ArgumentNullException

visitedGraph is null.

Properties

| Improve this Doc View Source

DefaultParameters

Default algorithm parameters to use if no parameters provided at construction.

Declaration
protected override FRLayoutParametersBase DefaultParameters { get; }
Property Value
Type Description
FRLayoutParametersBase
Overrides
GraphShape.Algorithms.Layout.ParameterizedLayoutAlgorithmBase<TVertex, TEdge, TGraph, GraphShape.Algorithms.Layout.FRLayoutParametersBase>.DefaultParameters

Methods

| Improve this Doc View Source

Initialize()

Called on algorithm initialization step.

Declaration
protected override void Initialize()
Overrides
| Improve this Doc View Source

InternalCompute()

Algorithm compute step.

Declaration
protected override void InternalCompute()
Overrides
| Improve this Doc View Source

IterateOne()

Compute one force application iteration.

Declaration
protected void IterateOne()

Implements

QuikGraph.Algorithms.IAlgorithm<TGraph>
QuikGraph.Algorithms.IComputation

Extension Methods