Header menu logo B2R2

IGraphAccessible<'V, 'E> Type

Read-only graph information accessor. This interface provides a way to access the information of a graph without modifying it.

Instance members

Instance member Description

this.Edges

Full Usage: this.Edges

Returns: Edge<'V, 'E>[]
Modifiers: abstract

Get an array of all edges in the graph.

Returns: Edge<'V, 'E>[]

this.FindEdge

Full Usage: this.FindEdge

Parameters:
Returns: Edge<'V, 'E>
Modifiers: abstract

Find the edge between src and dst. If this is a directed graph, find the edge from src to dst. If this is an undirected graph, find the edge that spans between src and dst.

src : IVertex<'V>
dst : IVertex<'V>
Returns: Edge<'V, 'E>

this.FindVertexBy

Full Usage: this.FindVertexBy

Parameters:
Returns: IVertex<'V>
Modifiers: abstract

Find a vertex by the given function. This function returns the first element, in which the function returns true. When there is no such an element, the function raises an exception.

arg0 : IVertex<'V> -> bool
Returns: IVertex<'V>

this.FindVertexByData

Full Usage: this.FindVertexByData

Parameters:
    arg0 : 'V

Returns: IVertex<'V>
Modifiers: abstract

Find a vertex that has the given data value from the graph. It will raise an exception if such a vertex does not exist. Note that this function should be used only when one knows each vertex in the graph has a unique data value.

arg0 : 'V
Returns: IVertex<'V>

this.FindVertexByID

Full Usage: this.FindVertexByID

Parameters:
Returns: IVertex<'V>
Modifiers: abstract

Find a vertex by its VertexID. This function raises an exception when there is no such a vertex.

arg0 : VertexID
Returns: IVertex<'V>

this.FoldEdge

Full Usage: this.FoldEdge

Parameters:
    arg0 : 'a -> Edge<'V, 'E> -> 'a
    arg1 : 'a

Returns: 'a
Modifiers: abstract

Fold every edge in the graph (the order can be arbitrary).

arg0 : 'a -> Edge<'V, 'E> -> 'a
arg1 : 'a
Returns: 'a

this.FoldVertex

Full Usage: this.FoldVertex

Parameters:
    arg0 : 'a -> IVertex<'V> -> 'a
    arg1 : 'a

Returns: 'a
Modifiers: abstract

Fold every vertex (the order can be arbitrary).

arg0 : 'a -> IVertex<'V> -> 'a
arg1 : 'a
Returns: 'a

this.HasVertex

Full Usage: this.HasVertex

Parameters:
Returns: bool
Modifiers: abstract

Check the existence of the given vertex from the graph.

arg0 : VertexID
Returns: bool

this.ImplementationType

Full Usage: this.ImplementationType

Returns: ImplementationType
Modifiers: abstract

Get the implementation type of this graph.

Returns: ImplementationType

this.IsEmpty

Full Usage: this.IsEmpty

Returns: bool
Modifiers: abstract

Is this empty? A graph is empty when there is no vertex in the graph.

Returns: bool

this.IterEdge

Full Usage: this.IterEdge

Parameters:
    arg0 : Edge<'V, 'E> -> unit

Modifiers: abstract

Fold every edge in the graph (the order can be arbitrary).

arg0 : Edge<'V, 'E> -> unit

this.IterVertex

Full Usage: this.IterVertex

Parameters:
Modifiers: abstract

Iterate every vertex (the order can be arbitrary).

arg0 : IVertex<'V> -> unit

this.SingleRoot

Full Usage: this.SingleRoot

Returns: IVertex<'V>
Modifiers: abstract

Get exactly one root vertex of this graph. If there are multiple root vertices, this will raise an exception.

Returns: IVertex<'V>

this.Size

Full Usage: this.Size

Returns: int
Modifiers: abstract

Number of vertices.

Returns: int

this.TryFindEdge

Full Usage: this.TryFindEdge

Parameters:
Returns: Edge<'V, 'E> option
Modifiers: abstract

Find the edge between src and dst. If this is a directed graph, find the edge from src to dst. If this is an undirected graph, find the edge that spans between src and dst.

src : IVertex<'V>
dst : IVertex<'V>
Returns: Edge<'V, 'E> option

this.TryFindVertexBy

Full Usage: this.TryFindVertexBy

Parameters:
Returns: IVertex<'V> option
Modifiers: abstract

Find a vertex by the given function without raising an exception.

arg0 : IVertex<'V> -> bool
Returns: IVertex<'V> option

this.TryFindVertexByData

Full Usage: this.TryFindVertexByData

Parameters:
    arg0 : 'V

Returns: IVertex<'V> option
Modifiers: abstract

Find a vertex that has the given VertexData from the graph. This function does not raise an exception unlike FindVertexByData.

arg0 : 'V
Returns: IVertex<'V> option

this.TryFindVertexByID

Full Usage: this.TryFindVertexByID

Parameters:
Returns: IVertex<'V> option
Modifiers: abstract

Find a vertex by its VertexID. This function returns an Option type.

arg0 : VertexID
Returns: IVertex<'V> option

this.Unreachables

Full Usage: this.Unreachables

Returns: IVertex<'V>[]
Modifiers: abstract

Get a collection of unreachable vertices in the graph.

Returns: IVertex<'V>[]

this.Vertices

Full Usage: this.Vertices

Returns: IVertex<'V>[]
Modifiers: abstract

Get an array of all vertices in the graph.

Returns: IVertex<'V>[]

Type something to start searching.