Trait

firrtl.graph

MutableEdgeData

Related Doc: package graph

Permalink

trait MutableEdgeData[V, E] extends EdgeData[V, E]

Mixing this trait into a DiGraph indicates that each edge may be associated with an optional data value. The MutableEdgeData trait provides an API for viewing and mutating edge data.

V

the vertex type (datatype) of the underlying DiGraph

E

the type of each edge data value

Self Type
MutableEdgeData[V, E] with MutableDiGraph[V]
Source
EdgeData.scala
Linear Supertypes
EdgeData[V, E], AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MutableEdgeData
  2. EdgeData
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. def addEdge(u: V, v: V, data: E): Unit

    Permalink

    Add an edge (u,v) to the graph with associated edge data.

    Add an edge (u,v) to the graph with associated edge data.

    u

    the source of the edge

    v

    the destination of the edge

    data

    the edge data to associate with the edge

    Exceptions thrown

    IllegalArgumentException if u or v is not part of the graph

    See also

    DiGraph.addEdge

  5. def addEdgeIfValid(u: V, v: V, data: E): Boolean

    Permalink

    Safely add an edge (u,v) to the graph with associated edge data if and only if both vertices are present in the graph.

    Safely add an edge (u,v) to the graph with associated edge data if and only if both vertices are present in the graph. This is useful for preventing spurious edge creating when examining a subset of possible nodes.

    u

    the source of the edge

    v

    the destination of the edge

    data

    the edge data to associate with the edge

    returns

    a Boolean indicating whether the edge was added

    See also

    DiGraph.addEdgeIfValid

  6. def addPairWithEdge(u: V, v: V, data: E): Unit

    Permalink

    Safely add an edge (u,v) to the graph with associated edge data.

    Safely add an edge (u,v) to the graph with associated edge data. If on or more of the two vertices is not present in the graph, add them before creating the edge.

    u

    the source of the edge

    v

    the destination of the edge

    data

    the edge data to associate with the edge

    See also

    DiGraph.addPairWithEdge

  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  8. def assertEdgeExists(u: V, v: V): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    EdgeData

  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  10. def edgeData(u: V, v: V): E

    Permalink

    u

    the source of the edge

    v

    the destination of the edge

    returns

    the edge data associated with a given edge

    Definition Classes
    EdgeData
    Exceptions thrown

    EdgeNotFoundException if the edge does not exist

    NoSuchElementException if the edge has no data

  11. val edgeDataMap: Map[(V, V), E]

    Permalink
    Attributes
    protected
    Definition Classes
    MutableEdgeData → EdgeData

  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  15. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  16. def getEdgeData(u: V, v: V): Option[E]

    Permalink

    Optionally return the edge data associated with a given edge.

    Optionally return the edge data associated with a given edge.

    u

    the source of the edge

    v

    the destination of the edge

    returns

    an option containing the edge data, if any, or None

    Definition Classes
    EdgeData

  17. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  19. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  22. def setEdgeData(u: V, v: V, data: E): Unit

    Permalink

    Associate an edge data value with a graph edge.

    Associate an edge data value with a graph edge.

    u

    the source of the edge

    v

    the destination of the edge

    data

    the edge data to associate with the edge

    Exceptions thrown

    EdgeNotFoundException if the edge does not exist in the graph

  23. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  24. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  25. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  26. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  27. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from EdgeData[V, E]

Inherited from AnyRef

Inherited from Any

Ungrouped