scalax.collection

GraphBase

trait GraphBase[N, E[X] <: EdgeLikeIn[X]] extends Serializable

Base template trait for graphs.

This trait provides the common structure and base operations for immutable graphs independently of their representation. Base operations also cover one-step traversals. For unlimited traversals see trait GraphTraversal.

Users of Graph usually don't interact directly with this trait but with trait Graph instead which inherits the functionality provided by this trait.

If E inherits DirectedEdgeLike the graph is directed, otherwise it is undirected or mixed.

N

the user type of the nodes (vertices) in this graph.

E

the kind of the edges (links) in this graph.

Self Type
GraphBase[N, E]
Linear Supertypes
Serializable, Serializable, AnyRef, Any
Known Subclasses
AdjacencyListBase, AdjacencyListGraph, AdjacencyListGraph, DefaultGraphImpl, DefaultGraphImpl, Graph, Graph, Graph, GraphAux, GraphLike, GraphLike, GraphTraversal, GraphTraversalImpl
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. GraphBase
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. trait Edge extends Serializable

  2. class EdgeBase extends InnerEdgeParam[N, E, NodeT, E] with InnerEdge

  3. sealed trait EdgeOrdering extends Ordering[EdgeT] with ElemOrdering

  4. trait EdgeSet extends Set[EdgeT] with ExtSetMethods[EdgeT] with Serializable

  5. abstract type EdgeSetT <: EdgeSet

  6. abstract type EdgeT <: InnerEdgeParam[N, E, NodeT, E] with InnerEdge with Serializable

  7. sealed trait ElemOrdering extends AnyRef

    Base trait for graph Orderings.

  8. trait InnerEdge extends Iterable[NodeT] with Edge with InnerElem

  9. sealed trait InnerElem extends AnyRef

  10. trait InnerNode extends InnerNodeParam[N] with Node with InnerElem

  11. sealed class NoOrdering extends ElemOrdering

    The empty ElemOrdering.

  12. trait Node extends Serializable

  13. abstract class NodeBase extends InnerNode

    Attributes
    protected

  14. sealed trait NodeOrdering extends Ordering[NodeT] with ElemOrdering

    Ordering for the path dependent type NodeT.

  15. trait NodeSet extends Set[NodeT] with ExtSetMethods[NodeT] with Serializable

  16. abstract type NodeSetT <: NodeSet

  17. abstract type NodeT <: InnerNode with Serializable

Abstract Value Members

  1. abstract def edges: EdgeSetT

    The edge set of this Graph commonly referred to as E(G).

    The edge set of this Graph commonly referred to as E(G).

    returns

    Set of all contained edges.

  2. abstract def isDirected: Boolean

  3. abstract def isHyper: Boolean

  4. abstract def newEdge(innerEdge: E[NodeT]): EdgeT

    Attributes
    protected

  5. abstract def newNode(n: N): NodeT

    Attributes
    protected

  6. abstract def nodes: NodeSetT

    The node (vertex) set of this Graph commonly referred to as V(G).

    The node (vertex) set of this Graph commonly referred to as V(G).

    returns

    Set of all contained nodes.

Concrete Value Members

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from GraphBase[N, E] to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd

  5. def ->[B](y: B): (GraphBase[N, E], B)

    Implicit information
    This member is added by an implicit conversion from GraphBase[N, E] to ArrowAssoc[GraphBase[N, E]] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  8. object Edge extends Serializable

  9. object EdgeOrdering extends Serializable

    Ordering for the path dependent type EdgeT.

  10. object EdgeT

  11. object InnerEdge extends Serializable

  12. object InnerNode extends Serializable

  13. object Node extends Serializable

  14. object NodeOrdering extends Serializable

  15. final lazy val anyOrdering: AnyOrdering[N]

    Attributes
    protected

  16. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  17. def clone(): AnyRef

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

  18. final lazy val defaultEdgeOrdering: EdgeOrdering

  19. final lazy val defaultNodeOrdering: NodeOrdering

  20. implicit final def edgeToEdgeCont(e: E[N]): E[NodeT]

    Attributes
    protected
    Annotations
    @inline()

  21. def ensuring(cond: (GraphBase[N, E]) ⇒ Boolean, msg: ⇒ Any): GraphBase[N, E]

    Implicit information
    This member is added by an implicit conversion from GraphBase[N, E] to Ensuring[GraphBase[N, E]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  22. def ensuring(cond: (GraphBase[N, E]) ⇒ Boolean): GraphBase[N, E]

    Implicit information
    This member is added by an implicit conversion from GraphBase[N, E] to Ensuring[GraphBase[N, E]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  23. def ensuring(cond: Boolean, msg: ⇒ Any): GraphBase[N, E]

    Implicit information
    This member is added by an implicit conversion from GraphBase[N, E] to Ensuring[GraphBase[N, E]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  24. def ensuring(cond: Boolean): GraphBase[N, E]

    Implicit information
    This member is added by an implicit conversion from GraphBase[N, E] to Ensuring[GraphBase[N, E]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

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

    Definition Classes
    AnyRef

  26. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  27. def finalize(): Unit

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

  28. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from GraphBase[N, E] to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

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

    Definition Classes
    AnyRef → Any

  30. def graphSize: Int

    The size - commonly referred to as ||G|| - of this graph equaling to the number of edges.

    The size - commonly referred to as ||G|| - of this graph equaling to the number of edges.

    Method size is reserved for the number of nodes and edges because Graph is also SetLike with set elements being nodes or edges.

  31. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  32. def initialize(nodes: Iterable[N], edges: Iterable[E[N]]): Unit

    Populates this graph with nodes and edges.

    Populates this graph with nodes and edges.

    The implementing class will typically have a constructor with the same parameters which is invoked by from of the companion object.

    nodes

    The isolated (and optionally any other) outer nodes that the node set of this graph is to be populated with.

    edges

    The outer edges that the edge set of this graph is to be populated with. Nodes being the end of any of these edges will be added to the node set.

    Attributes
    protected

  33. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  34. final def isTrivial: Boolean

    true if this graph has at most 1 node.

    true if this graph has at most 1 node.

    Annotations
    @inline()

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

    Definition Classes
    AnyRef

  36. final val noOrdering: NoOrdering

  37. final def nonTrivial: Boolean

    true if this graph has at least 2 nodes.

    true if this graph has at least 2 nodes.

    Annotations
    @inline()

  38. final def notify(): Unit

    Definition Classes
    AnyRef

  39. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  40. def order: Int

    The order - commonly referred to as |G| - of this graph equaling to the number of nodes.

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

    Definition Classes
    AnyRef

  42. def toString(): String

    Definition Classes
    AnyRef → Any

  43. def totalWeight: Long

  44. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  47. def →[B](y: B): (GraphBase[N, E], B)

    Implicit information
    This member is added by an implicit conversion from GraphBase[N, E] to ArrowAssoc[GraphBase[N, E]] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from GraphBase[N, E] to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (graphBase: StringAdd).self
    Definition Classes
    StringAdd

  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from GraphBase[N, E] to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (graphBase: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: GraphBase[N, E]

    Implicit information
    This member is added by an implicit conversion from GraphBase[N, E] to ArrowAssoc[GraphBase[N, E]] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (graphBase: ArrowAssoc[GraphBase[N, E]]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: GraphBase[N, E]

    Implicit information
    This member is added by an implicit conversion from GraphBase[N, E] to Ensuring[GraphBase[N, E]] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (graphBase: Ensuring[GraphBase[N, E]]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from GraphBase[N, E] to StringAdd

Inherited by implicit conversion any2stringfmt from GraphBase[N, E] to StringFormat

Inherited by implicit conversion any2ArrowAssoc from GraphBase[N, E] to ArrowAssoc[GraphBase[N, E]]

Inherited by implicit conversion any2Ensuring from GraphBase[N, E] to Ensuring[GraphBase[N, E]]

Ungrouped