Interface IChainBasedLayoutOperations<TLayout, TNode>

Represents layout operations that are meant to work with chains.

Inherited Members

ILayoutOperations<TLayout, TNode>.PerturbShape(TLayout, TNode, Boolean)

ILayoutOperations<TLayout, TNode>.PerturbPosition(TLayout, TNode, Boolean)

ILayoutOperations<TLayout, TNode>.IsLayoutValid(TLayout)

ILayoutOperations<TLayout, TNode>.GetEnergy(TLayout)

ILayoutOperations<TLayout, TNode>.UpdateLayout(TLayout)

ILayoutOperations<TLayout, TNode>.AddNodeGreedily(TLayout, TNode, Int32)

ILayoutOperations<TLayout, TNode>.AreDifferentEnough(TLayout, TLayout)

Namespace: Edgar.Legacy.Core.LayoutOperations.Interfaces

Assembly: Edgar.dll

Syntax

public interface IChainBasedLayoutOperations<in TLayout, TNode> : ILayoutOperations<TLayout, TNode>

Type Parameters

Name	Description
TLayout
TNode

Methods

AddChain(TLayout, IList<TNode>, Boolean, out Int32)

Adds a chain of nodes to a given layout.

Declaration

void AddChain(TLayout layout, IList<TNode> chain, bool updateLayout, out int iterationsCount)

Parameters

Type	Name	Description
TLayout	layout
System.Collections.Generic.IList<TNode>	chain
System.Boolean	updateLayout	Whether energies should be updated.
System.Int32	iterationsCount

AreDifferentEnough(TLayout, TLayout, IList<TNode>)

Checks if configurations of nodes from a given chain are different enough.

Declaration

bool AreDifferentEnough(TLayout layout1, TLayout layout2, IList<TNode> chain)

Parameters

Type	Name	Description
TLayout	layout1
TLayout	layout2
System.Collections.Generic.IList<TNode>	chain

Returns

Type	Description
System.Boolean

IsLayoutValid(TLayout, IList<TNode>)

Checks if a given layout has all configurations from a given chain and that all configurations are valid.

Declaration

bool IsLayoutValid(TLayout layout, IList<TNode> chain)

Parameters

Type	Name	Description
TLayout	layout
System.Collections.Generic.IList<TNode>	chain

Returns

Type	Description
System.Boolean

PerturbLayout(TLayout, IList<TNode>, Boolean)

Perturbs a random node from a given chain.

Declaration

void PerturbLayout(TLayout layout, IList<TNode> chain, bool updateLayout)

Parameters

Type	Name	Description
TLayout	layout
System.Collections.Generic.IList<TNode>	chain	Chain of nodes to choose from.
System.Boolean	updateLayout	Whether energies should be updated.

PerturbPosition(TLayout, IList<TNode>, Boolean)

Perturbs position of a random node from a given chain.

Declaration

void PerturbPosition(TLayout layout, IList<TNode> chain, bool updateLayout)

Parameters

Type	Name	Description
TLayout	layout
System.Collections.Generic.IList<TNode>	chain	Chain of nodes to choose from.
System.Boolean	updateLayout	Whether energies should be updated.

PerturbShape(TLayout, IList<TNode>, Boolean)

Perturbs shape of a random node from a given chain.

Declaration

void PerturbShape(TLayout layout, IList<TNode> chain, bool updateLayout)

Parameters

Type	Name	Description
TLayout	layout
System.Collections.Generic.IList<TNode>	chain	Chain of nodes to choose from.
System.Boolean	updateLayout	Whether energies should be updated.

TryCompleteChain(TLayout, IList<TNode>)

Tries to complete a given chain. This operation may fail, in which case false is returned and the layout is not modified.

Declaration

bool TryCompleteChain(TLayout layout, IList<TNode> chain)

Parameters

Type	Name	Description
TLayout	layout
System.Collections.Generic.IList<TNode>	chain

Returns

Type	Description
System.Boolean	Whether a given chain was completed successfully