Class KKLayoutAlgorithm<TVertex, TEdge, TGraph>

Kamada-Kawai layout algorithm.

Inheritance
System.Object
AlgorithmBase
LayoutAlgorithmBase<TVertex, TEdge, TGraph>
ParameterizedLayoutAlgorithmBase<TVertex, TEdge, TGraph, KKLayoutParameters>
DefaultParameterizedLayoutAlgorithmBase<TVertex, TEdge, TGraph, KKLayoutParameters>
KKLayoutAlgorithm<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 KKLayoutAlgorithm<TVertex, TEdge, TGraph> : DefaultParameterizedLayoutAlgorithmBase<TVertex, TEdge, TGraph, KKLayoutParameters>, IAlgorithm, IParameterizedLayoutAlgorithm<TVertex, TEdge, TGraph, KKLayoutParameters>, IParameterizedLayoutAlgorithm<TVertex, TEdge, TGraph>, ILayoutAlgorithm<TVertex, TEdge, TGraph>, IAlgorithm<TGraph>, IComputation where TEdge : IEdge<TVertex> where TGraph : IBidirectionalGraph<TVertex, TEdge>
Type Parameters
Name Description
TVertex

Vertex type.
TEdge

Edge type.
TGraph

Graph type

Constructors

| Improve this Doc View Source

KKLayoutAlgorithm(TGraph, KKLayoutParameters)

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

Declaration
public KKLayoutAlgorithm(TGraph visitedGraph, KKLayoutParameters parameters = null)
Parameters
Type Name Description
TGraph visitedGraph

Graph to layout.
KKLayoutParameters parameters

Optional algorithm parameters.
Exceptions
Type Condition
System.ArgumentNullException

visitedGraph is null.
| Improve this Doc View Source

KKLayoutAlgorithm(TGraph, IDictionary<TVertex, Point>, KKLayoutParameters)

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

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

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

Vertices positions.
KKLayoutParameters parameters

Optional algorithm parameters.
Exceptions
Type Condition
System.ArgumentNullException

visitedGraph is null.

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

Report(Int32)

Reports the end of the iterationth iteration.

Declaration
protected void Report(int iteration)
Parameters
Type Name Description
System.Int32 iteration

Implements

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

Extension Methods