Class VanishingWeightedMarkovEdgeChain<TVertex, TEdge>

Markov chain with weight vanishing based on a factor.

Inheritance
System.Object
MarkovEdgeChainBase<TVertex, TEdge>
WeightedMarkovEdgeChainBase<TVertex, TEdge>
VanishingWeightedMarkovEdgeChain<TVertex, TEdge>
Implements
IMarkovEdgeChain<TVertex, TEdge>
IEdgeChain<TVertex, TEdge>
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: QuikGraph.Algorithms.RandomWalks
Assembly: QuikGraph.dll
Syntax
public sealed class VanishingWeightedMarkovEdgeChain<TVertex, TEdge> : WeightedMarkovEdgeChainBase<TVertex, TEdge>, IMarkovEdgeChain<TVertex, TEdge>, IEdgeChain<TVertex, TEdge> where TEdge : IEdge<TVertex>
Type Parameters
Name Description
TVertex

Vertex type.
TEdge

Edge type.

Constructors

| Improve this Doc View Source

VanishingWeightedMarkovEdgeChain(IDictionary<TEdge, Double>)

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

Declaration
public VanishingWeightedMarkovEdgeChain(IDictionary<TEdge, double> edgeWeights)
Parameters
Type Name Description
System.Collections.Generic.IDictionary<TEdge, System.Double> edgeWeights

Map that contains edge weights.
Exceptions
Type Condition
System.ArgumentNullException

edgeWeights is null.
| Improve this Doc View Source

VanishingWeightedMarkovEdgeChain(IDictionary<TEdge, Double>, Double)

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

Declaration
public VanishingWeightedMarkovEdgeChain(IDictionary<TEdge, double> edgeWeights, double factor)
Parameters
Type Name Description
System.Collections.Generic.IDictionary<TEdge, System.Double> edgeWeights

Map that contains edge weights.
System.Double factor

Vanishing factor.
Exceptions
Type Condition
System.ArgumentNullException

edgeWeights is null.

Properties

| Improve this Doc View Source

Factor

Vanishing factor.

Declaration
public double Factor { get; set; }
Property Value
Type Description
System.Double

Methods

| Improve this Doc View Source

TryGetSuccessor(IImplicitGraph<TVertex, TEdge>, TVertex, out TEdge)

Tries to get the successor of the given vertex in the given graph.

Declaration
public override bool TryGetSuccessor(IImplicitGraph<TVertex, TEdge> graph, TVertex vertex, out TEdge successor)
Parameters
Type Name Description
IImplicitGraph<TVertex, TEdge> graph

The graph to search in.
TVertex vertex

The vertex.
TEdge successor

Found successor, otherwise null.
Returns
Type Description
System.Boolean

True if a successor was found, false otherwise.
Overrides
QuikGraph.Algorithms.RandomWalks.MarkovEdgeChainBase<TVertex, TEdge>.TryGetSuccessor(QuikGraph.IImplicitGraph<TVertex, TEdge>, TVertex, TEdge)
Exceptions
Type Condition
System.ArgumentNullException

graph is null.
System.ArgumentNullException

vertex is null.
| Improve this Doc View Source

TryGetSuccessor(IEnumerable<TEdge>, TVertex, out TEdge)

Tries to get the successor of the given vertex in the given set of edges.

Declaration
public override bool TryGetSuccessor(IEnumerable<TEdge> edges, TVertex vertex, out TEdge successor)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<TEdge> edges

Edge set in which searching.
TVertex vertex

The vertex.
TEdge successor

Found successor, otherwise null.
Returns
Type Description
System.Boolean

True if a successor was found, false otherwise.
Overrides
QuikGraph.Algorithms.RandomWalks.MarkovEdgeChainBase<TVertex, TEdge>.TryGetSuccessor(System.Collections.Generic.IEnumerable<TEdge>, TVertex, TEdge)
Exceptions
Type Condition
System.ArgumentNullException

edges is null.
System.ArgumentNullException

vertex is null.

Implements

Extension Methods