Show / Hide Table of Contents

    Class LocalEdge

    Provides graph edge info

    Inheritance
    System.Object
    LocalEdge
    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: Elements.Search
    Assembly: Hypar.Elements.dll
    Syntax
    public class LocalEdge

    Constructors

    LocalEdge(Int32, Int32)

    Creates a new instance of Edge class

    Declaration
    public LocalEdge(int vertexIndex1, int vertexIndex2)
    Parameters
    Type Name Description
    System.Int32 vertexIndex1

    The index of the first vertex.

    System.Int32 vertexIndex2

    The index of the second vertex.

    Properties

    End

    The index of the second vertex.

    Declaration
    public int End { get; }
    Property Value
    Type Description
    System.Int32

    Start

    The index of the first vertex.

    Declaration
    public int Start { get; }
    Property Value
    Type Description
    System.Int32

    Methods

    IsBetweenVertices(Int32, Int32)

    Is this edge between the provided vertices?

    Declaration
    public bool IsBetweenVertices(int start, int end)
    Parameters
    Type Name Description
    System.Int32 start

    The index of the first vertex.

    System.Int32 end

    The index of the second vertex.

    Returns
    Type Description
    System.Boolean

    Returns true if the edge is between the provided vertex indices.

    IsVisitedFromVertex(Int32)

    Is this edge visited from the provided vertex?

    Declaration
    public bool IsVisitedFromVertex(int vertexIndex)
    Parameters
    Type Name Description
    System.Int32 vertexIndex

    The index of the vertex from which the vertex is visited.

    Returns
    Type Description
    System.Boolean

    Returns true if the edge was visited from the vertex.

    MarkAsVisited(Int32)

    Mark a vertex as having been visited from the specified index.

    Declaration
    public void MarkAsVisited(int start)
    Parameters
    Type Name Description
    System.Int32 start

    The index of the vertex from which the edge is visited.