Class CompressedSparseRowGraph<TVertex>

Directed graph data structure using a compressed sparse row representation. (http://www.cs.utk.edu/~dongarra/etemplates/node373.html)

Inheritance

System.Object

CompressedSparseRowGraph<TVertex>

Implements

IVertexListGraph<TVertex, SEquatableEdge<TVertex>>

IIncidenceGraph<TVertex, SEquatableEdge<TVertex>>

IImplicitGraph<TVertex, SEquatableEdge<TVertex>>

IEdgeListGraph<TVertex, SEquatableEdge<TVertex>>

IGraph<TVertex, SEquatableEdge<TVertex>>

IEdgeSet<TVertex, SEquatableEdge<TVertex>>

IVertexSet<TVertex>

IImplicitVertexSet<TVertex>

System.ICloneable

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

Assembly: QuikGraph.dll

Syntax

[Serializable]
public sealed class CompressedSparseRowGraph<TVertex> : IVertexListGraph<TVertex, SEquatableEdge<TVertex>>, IIncidenceGraph<TVertex, SEquatableEdge<TVertex>>, IImplicitGraph<TVertex, SEquatableEdge<TVertex>>, IEdgeListGraph<TVertex, SEquatableEdge<TVertex>>, IGraph<TVertex, SEquatableEdge<TVertex>>, IEdgeSet<TVertex, SEquatableEdge<TVertex>>, IVertexSet<TVertex>, IImplicitVertexSet<TVertex>, ICloneable

Type Parameters

Name	Description
TVertex	Vertex type.

Properties

| Improve this Doc View Source

AllowParallelEdges

Gets a value indicating if the graph allows parallel edges

Declaration

public bool AllowParallelEdges { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

EdgeCount

Gets the edge count.

Declaration

public int EdgeCount { get; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

Edges

Gets the edges.

Declaration

public IEnumerable<SEquatableEdge<TVertex>> Edges { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<SEquatableEdge<TVertex>>

| Improve this Doc View Source

IsDirected

Gets a value indicating if the graph is directed

Declaration

public bool IsDirected { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsEdgesEmpty

Gets a value indicating whether there are no edges in this set. It is true if this edge set is empty, otherwise false.

Declaration

public bool IsEdgesEmpty { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsVerticesEmpty

Gets a value indicating whether there are no vertices in this set. It is true if this vertex set is empty, otherwise false.

Declaration

public bool IsVerticesEmpty { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

VertexCount

Gets the vertex count.

Declaration

public int VertexCount { get; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

Vertices

Gets the vertices.

Declaration

public IEnumerable<TVertex> Vertices { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<TVertex>

Methods

| Improve this Doc View Source

Clone()

Clones this graph.

Declaration

public CompressedSparseRowGraph<TVertex> Clone()

Returns

Type	Description
CompressedSparseRowGraph<TVertex>	Cloned graph.

| Improve this Doc View Source

ContainsEdge(TVertex, TVertex)

Checks if this graph contains an edge that link source and target vertices.

Declaration

public bool ContainsEdge(TVertex source, TVertex target)

Parameters

Type	Name	Description
TVertex	source	Source vertex.
TVertex	target	Target vertex.

Returns

Type	Description
System.Boolean	True if an edge exists, false otherwise.

Exceptions

Type	Condition
System.ArgumentNullException	`source` is null.
System.ArgumentNullException	`target` is null.

| Improve this Doc View Source

ContainsEdge(SEquatableEdge<TVertex>)

Determines whether this set contains the specified edge.

Declaration

public bool ContainsEdge(SEquatableEdge<TVertex> edge)

Parameters

Type	Name	Description
SEquatableEdge<TVertex>	edge

Returns

Type	Description
System.Boolean	True if the specified `edge` is contained in this set, false otherwise.

Exceptions

Type	Condition
System.ArgumentNullException	`edge` is null.

| Improve this Doc View Source

ContainsVertex(TVertex)

Determines whether this set contains the specified vertex.

Declaration

public bool ContainsVertex(TVertex vertex)

Parameters

Type	Name	Description
TVertex	vertex	Vertex to check.

Returns

Type	Description
System.Boolean	True if the specified `vertex` is contained in this set, false otherwise.

Exceptions

Type	Condition
System.ArgumentNullException	`vertex` is null.

| Improve this Doc View Source

FromGraph<TEdge>(IVertexAndEdgeListGraph<TVertex, TEdge>)

Converts the given graph to a CompressedSparseRowGraph<TVertex>.

Declaration

public static CompressedSparseRowGraph<TVertex> FromGraph<TEdge>(IVertexAndEdgeListGraph<TVertex, TEdge> graph)
    where TEdge : IEdge<TVertex>

Parameters

Type	Name	Description
IVertexAndEdgeListGraph<TVertex, TEdge>	graph	Graph to convert.

Returns

Type	Description
CompressedSparseRowGraph<TVertex>	A corresponding CompressedSparseRowGraph<TVertex>.

Type Parameters

Name	Description
TEdge	Edge type.

Exceptions

Type	Condition
System.ArgumentNullException	`graph` is null.

| Improve this Doc View Source

IsOutEdgesEmpty(TVertex)

Determines whether there are out-edges associated to vertex.

Declaration

public bool IsOutEdgesEmpty(TVertex vertex)

Parameters

Type	Name	Description
TVertex	vertex	The vertex.

Returns

Type	Description
System.Boolean	True if `vertex` has no out-edges, false otherwise.

Exceptions

Type	Condition
System.ArgumentNullException	`vertex` is null.
VertexNotFoundException	`vertex` is not part of the graph.

| Improve this Doc View Source

OutDegree(TVertex)

Gets the count of out-edges of vertex.

Declaration

public int OutDegree(TVertex vertex)

Parameters

Type	Name	Description
TVertex	vertex	The vertex.

Returns

Type	Description
System.Int32	The count of out-edges of `vertex`.

Exceptions

Type	Condition
System.ArgumentNullException	`vertex` is null.
VertexNotFoundException	`vertex` is not part of the graph.

| Improve this Doc View Source

OutEdge(TVertex, Int32)

Gets the out-edge of vertex at position index.

Declaration

public SEquatableEdge<TVertex> OutEdge(TVertex vertex, int index)

Parameters

Type	Name	Description
TVertex	vertex	The vertex.
System.Int32	index	The index.

Returns

Type	Description
SEquatableEdge<TVertex>	The out-edge at position `index`.

Exceptions

Type	Condition
System.ArgumentNullException	`vertex` is null.
System.ArgumentOutOfRangeException	No vertex at `index`.
VertexNotFoundException	`vertex` is not part of the graph.

| Improve this Doc View Source

OutEdges(TVertex)

Gets the out-edges of vertex.

Declaration

public IEnumerable<SEquatableEdge<TVertex>> OutEdges(TVertex vertex)

Parameters

Type	Name	Description
TVertex	vertex	The vertex.

Returns

Type	Description
System.Collections.Generic.IEnumerable<SEquatableEdge<TVertex>>	An enumeration of the out-edges of `vertex`.

Exceptions

Type	Condition
System.ArgumentNullException	`vertex` is null.
VertexNotFoundException	`vertex` is not part of the graph.

| Improve this Doc View Source

TryGetEdge(TVertex, TVertex, out SEquatableEdge<TVertex>)

Tries to get the edge that link source and target vertices.

Declaration

public bool TryGetEdge(TVertex source, TVertex target, out SEquatableEdge<TVertex> edge)

Parameters

Type	Name	Description
TVertex	source	Source vertex.
TVertex	target	Target vertex.
SEquatableEdge<TVertex>	edge

Returns

Type	Description
System.Boolean	True if an edge was found, false otherwise.

Exceptions

Type	Condition
System.ArgumentNullException	`source` is null.
System.ArgumentNullException	`target` is null.

| Improve this Doc View Source

TryGetEdges(TVertex, TVertex, out IEnumerable<SEquatableEdge<TVertex>>)

Tries to get edges that link source and target vertices.

Declaration

public bool TryGetEdges(TVertex source, TVertex target, out IEnumerable<SEquatableEdge<TVertex>> edges)

Parameters

Type	Name	Description
TVertex	source	Source vertex.
TVertex	target	Target vertex.
System.Collections.Generic.IEnumerable<SEquatableEdge<TVertex>>	edges

Returns

Type	Description
System.Boolean	True if at least an edge was found, false otherwise.

Exceptions

Type	Condition
System.ArgumentNullException	`source` is null.
System.ArgumentNullException	`target` is null.

| Improve this Doc View Source

TryGetOutEdges(TVertex, out IEnumerable<SEquatableEdge<TVertex>>)

Tries to get the out-edges of vertex.

Declaration

public bool TryGetOutEdges(TVertex vertex, out IEnumerable<SEquatableEdge<TVertex>> edges)

Parameters

Type	Name	Description
TVertex	vertex	The vertex.
System.Collections.Generic.IEnumerable<SEquatableEdge<TVertex>>	edges

Returns

Type	Description
System.Boolean	True if `vertex` was found or/and out-edges were found, false otherwise.

Exceptions

Type	Condition
System.ArgumentNullException	`vertex` is null.

Explicit Interface Implementations

| Improve this Doc View Source

ICloneable.Clone()

Declaration

object ICloneable.Clone()

Returns

Type	Description
System.Object

Implements

IVertexListGraph<TVertex, TEdge>

IIncidenceGraph<TVertex, TEdge>

IImplicitGraph<TVertex, TEdge>

IEdgeListGraph<TVertex, TEdge>

IGraph<TVertex, TEdge>

IEdgeSet<TVertex, TEdge>

IVertexSet<TVertex>

IImplicitVertexSet<TVertex>

System.ICloneable

Extension Methods

GraphMLExtensions.SerializeToGraphML<TVertex, TEdge, TGraph>(TGraph, String)

GraphMLExtensions.SerializeToGraphML<TVertex, TEdge, TGraph>(TGraph, String, VertexIdentity<TVertex>, EdgeIdentity<TVertex, TEdge>)

GraphMLExtensions.SerializeToGraphML<TVertex, TEdge, TGraph>(TGraph, XmlWriter)

GraphMLExtensions.SerializeToGraphML<TVertex, TEdge, TGraph>(TGraph, XmlWriter, VertexIdentity<TVertex>, EdgeIdentity<TVertex, TEdge>)

GraphMLExtensions.DeserializeFromGraphML<TVertex, TEdge, TGraph>(TGraph, XmlReader, IdentifiableVertexFactory<TVertex>, IdentifiableEdgeFactory<TVertex, TEdge>)

GraphMLExtensions.DeserializeFromGraphML<TVertex, TEdge, TGraph>(TGraph, TextReader, IdentifiableVertexFactory<TVertex>, IdentifiableEdgeFactory<TVertex, TEdge>)

GraphMLExtensions.DeserializeFromGraphML<TVertex, TEdge, TGraph>(TGraph, String, IdentifiableVertexFactory<TVertex>, IdentifiableEdgeFactory<TVertex, TEdge>)

GraphMLExtensions.DeserializeAndValidateFromGraphML<TVertex, TEdge, TGraph>(TGraph, TextReader, IdentifiableVertexFactory<TVertex>, IdentifiableEdgeFactory<TVertex, TEdge>)

SerializationExtensions.SerializeToBinary<TVertex, TEdge>(IGraph<TVertex, TEdge>, Stream)

SerializationExtensions.SerializeToXml<TVertex, TEdge, TGraph>(TGraph, XmlWriter, VertexIdentity<TVertex>, EdgeIdentity<TVertex, TEdge>, String, String, String, String)

SerializationExtensions.SerializeToXml<TVertex, TEdge, TGraph>(TGraph, XmlWriter, VertexIdentity<TVertex>, EdgeIdentity<TVertex, TEdge>, String, String, String, String, Action<XmlWriter, TGraph>, Action<XmlWriter, TVertex>, Action<XmlWriter, TEdge>)

AlgorithmExtensions.GetVertexIdentity<TVertex>(IVertexSet<TVertex>)

AlgorithmExtensions.GetEdgeIdentity<TVertex, TEdge>(IEdgeSet<TVertex, TEdge>)

AlgorithmExtensions.TreeBreadthFirstSearch<TVertex, TEdge>(IVertexListGraph<TVertex, TEdge>, TVertex)

AlgorithmExtensions.TreeDepthFirstSearch<TVertex, TEdge>(IVertexListGraph<TVertex, TEdge>, TVertex)

AlgorithmExtensions.TreeCyclePoppingRandom<TVertex, TEdge>(IVertexListGraph<TVertex, TEdge>, TVertex)

AlgorithmExtensions.TreeCyclePoppingRandom<TVertex, TEdge>(IVertexListGraph<TVertex, TEdge>, TVertex, IMarkovEdgeChain<TVertex, TEdge>)

AlgorithmExtensions.Sinks<TVertex, TEdge>(IVertexListGraph<TVertex, TEdge>)

AlgorithmExtensions.Roots<TVertex, TEdge>(IVertexListGraph<TVertex, TEdge>)

AlgorithmExtensions.TopologicalSort<TVertex, TEdge>(IVertexListGraph<TVertex, TEdge>)

AlgorithmExtensions.StronglyConnectedComponents<TVertex, TEdge>(IVertexListGraph<TVertex, TEdge>, IDictionary<TVertex, Int32>)

AlgorithmExtensions.WeaklyConnectedComponents<TVertex, TEdge>(IVertexListGraph<TVertex, TEdge>, IDictionary<TVertex, Int32>)

AlgorithmExtensions.IsDirectedAcyclicGraph<TVertex, TEdge>(IVertexListGraph<TVertex, TEdge>)

AlgorithmExtensions.OfflineLeastCommonAncestor<TVertex, TEdge>(IVertexListGraph<TVertex, TEdge>, TVertex, IEnumerable<SEquatableEdge<TVertex>>)

AlgorithmExtensions.ComputeTransitiveReduction<TVertex, TEdge>(IEdgeListGraph<TVertex, TEdge>)

AlgorithmExtensions.ComputeTransitiveClosure<TVertex, TEdge>(IEdgeListGraph<TVertex, TEdge>, Func<TVertex, TVertex, TEdge>)

GraphvizExtensions.ToGraphviz<TVertex, TEdge>(IEdgeListGraph<TVertex, TEdge>)

GraphvizExtensions.ToGraphviz<TVertex, TEdge>(IEdgeListGraph<TVertex, TEdge>, Action<GraphvizAlgorithm<TVertex, TEdge>>)

GraphvizExtensions.ToSvg<TVertex, TEdge>(IEdgeListGraph<TVertex, TEdge>)

GraphvizExtensions.ToSvg<TVertex, TEdge>(IEdgeListGraph<TVertex, TEdge>, Action<GraphvizAlgorithm<TVertex, TEdge>>)

MsaglGraphExtensions.CreateMsaglPopulator<TVertex, TEdge>(IEdgeListGraph<TVertex, TEdge>)

MsaglGraphExtensions.CreateMsaglPopulator<TVertex, TEdge>(IEdgeListGraph<TVertex, TEdge>, String, IFormatProvider)

MsaglGraphExtensions.CreateMsaglPopulator<TVertex, TEdge>(IEdgeListGraph<TVertex, TEdge>, VertexIdentity<TVertex>)

MsaglGraphExtensions.ToMsaglGraph<TVertex, TEdge>(IEdgeListGraph<TVertex, TEdge>, MsaglVertexNodeEventHandler<TVertex>, MsaglEdgeEventHandler<TVertex, TEdge>)

MsaglGraphExtensions.ToMsaglGraph<TVertex, TEdge>(IEdgeListGraph<TVertex, TEdge>, VertexIdentity<TVertex>, MsaglVertexNodeEventHandler<TVertex>, MsaglEdgeEventHandler<TVertex, TEdge>)