Packages

  • package root

    Welcome to the Graph for Scala API reference.

    Welcome to the Graph for Scala API reference. Some suggested navigation entry points:

    Definition Classes
    root
  • package scalax
    Definition Classes
    root
  • package collection

    Contains the base traits and objects needed to use Graph for Scala.

    Contains the base traits and objects needed to use Graph for Scala.

    See also the Graph for Scala Core User Guide.

    Definition Classes
    scalax
  • trait GraphTraversal[N, E[+X] <: EdgeLikeIn[X]] extends GraphBase[N, E]

    Graph-related functionality such as traversals, path finding, cycle detection etc.

    Graph-related functionality such as traversals, path finding, cycle detection etc. All algorithms including breadth-first, depth-first, white-gray-black search and Dijkstra's algorithm are tail recursive.

    Before starting a traversal a Traverser such as scalax.collection.GraphTraversal#InnerNodeTraverser is instantiated explicitly or implicitly. It holds settings like maxDepth, subgraph or ordering providing a fine-grained control of the traversal. Traversers also extend scala.collection.Iterable meaning that you can process the visited nodes and edges in a functional way.

    Definition Classes
    collection
    See also

    http://www.scala-graph.org/guides/core-traversing

  • trait Walk extends Iterable[InnerElem]

    Represents a walk in this graph where walk ::= node { edge node } A walk/path contains at least one node followed by any number of consecutive pairs of an edge and a node.

    Represents a walk in this graph where walk ::= node { edge node } A walk/path contains at least one node followed by any number of consecutive pairs of an edge and a node. The first element is the start node, the second is an edge with its source being the start node and its target being the third element etc.

    Definition Classes
    GraphTraversal
  • NodeValidator

trait NodeValidator extends (NodeT) => Boolean

Attributes
protected
Linear Supertypes
(NodeT) => Boolean, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. NodeValidator
  2. Function1
  3. AnyRef
  4. Any
Implicitly
  1. by EdgeAssoc
  2. by predicateToNodePredicate
  3. by anyToNode
  4. by ChainingOps
  5. by any2stringadd
  6. by StringFormat
  7. by Ensuring
  8. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def apply(v1: NodeT): Boolean
    Definition Classes
    Function1

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from NodeValidator toany2stringadd[NodeValidator] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (NodeValidator, B)
    Implicit
    This member is added by an implicit conversion from NodeValidator toArrowAssoc[NodeValidator] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def andThen[A](g: (Boolean) => A): (NodeT) => A
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  9. def compose[A](g: (A) => NodeT): (A) => Boolean
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  10. def ensuring(cond: (NodeValidator) => Boolean, msg: => Any): NodeValidator
    Implicit
    This member is added by an implicit conversion from NodeValidator toEnsuring[NodeValidator] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (NodeValidator) => Boolean): NodeValidator
    Implicit
    This member is added by an implicit conversion from NodeValidator toEnsuring[NodeValidator] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: => Any): NodeValidator
    Implicit
    This member is added by an implicit conversion from NodeValidator toEnsuring[NodeValidator] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): NodeValidator
    Implicit
    This member is added by an implicit conversion from NodeValidator toEnsuring[NodeValidator] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. def isDefined: Boolean
    Implicit
    This member is added by an implicit conversion from NodeValidator toOuterNode[NodeValidator] performed by method anyToNode in scalax.collection.GraphPredef.
    Definition Classes
    Param
  19. final def isEdge: Boolean
    Implicit
    This member is added by an implicit conversion from NodeValidator toOuterNode[NodeValidator] performed by method anyToNode in scalax.collection.GraphPredef.
    Definition Classes
    Param
  20. def isIn: Boolean
    Implicit
    This member is added by an implicit conversion from NodeValidator toOuterNode[NodeValidator] performed by method anyToNode in scalax.collection.GraphPredef.
    Definition Classes
    InParam → Param
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. def isNode: Boolean
    Implicit
    This member is added by an implicit conversion from NodeValidator toOuterNode[NodeValidator] performed by method anyToNode in scalax.collection.GraphPredef.
    Definition Classes
    NodeParam
  23. final def isOut: Boolean
    Implicit
    This member is added by an implicit conversion from NodeValidator toOuterNode[NodeValidator] performed by method anyToNode in scalax.collection.GraphPredef.
    Definition Classes
    Param
  24. val n1: NodeValidator
    Implicit
    This member is added by an implicit conversion from NodeValidator toEdgeAssoc[NodeValidator] performed by method EdgeAssoc in scalax.collection.GraphPredef.
    Definition Classes
    EdgeAssoc
  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  28. def pipe[B](f: (NodeValidator) => B): B
    Implicit
    This member is added by an implicit conversion from NodeValidator toChainingOps[NodeValidator] performed by method ChainingOps in scalax.collection.
    Definition Classes
    ChainingOps
  29. def productElementNames: Iterator[String]
    Implicit
    This member is added by an implicit conversion from NodeValidator toOuterNode[NodeValidator] performed by method anyToNode in scalax.collection.GraphPredef.
    Definition Classes
    Product
  30. val self: NodeValidator
    Implicit
    This member is added by an implicit conversion from NodeValidator toChainingOps[NodeValidator] performed by method ChainingOps in scalax.collection.
    Definition Classes
    ChainingOps
  31. def stringPrefix: String
    Implicit
    This member is added by an implicit conversion from NodeValidator toOuterNode[NodeValidator] performed by method anyToNode in scalax.collection.GraphPredef.
    Definition Classes
    NodeParam
  32. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  33. def tap[U](f: (NodeValidator) => U): NodeValidator
    Implicit
    This member is added by an implicit conversion from NodeValidator toChainingOps[NodeValidator] performed by method ChainingOps in scalax.collection.
    Definition Classes
    ChainingOps
  34. def toString(): String
    Definition Classes
    Function1 → AnyRef → Any
  35. val value: NodeValidator
    Implicit
    This member is added by an implicit conversion from NodeValidator toOuterNode[NodeValidator] performed by method anyToNode in scalax.collection.GraphPredef.
    Definition Classes
    OuterNode → NodeParam
  36. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  37. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  38. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  39. def ~[N >: N1](n2: N): UnDiEdge[N]
    Implicit
    This member is added by an implicit conversion from NodeValidator toEdgeAssoc[NodeValidator] performed by method EdgeAssoc in scalax.collection.GraphPredef.
    Definition Classes
    EdgeAssoc
    Annotations
    @inline()
  40. def ~>[N >: N1](n2: N): DiEdge[N]
    Implicit
    This member is added by an implicit conversion from NodeValidator toEdgeAssoc[NodeValidator] performed by method EdgeAssoc in scalax.collection.GraphPredef.
    Definition Classes
    EdgeAssoc
    Annotations
    @inline()

Shadowed Implicit Value Members

  1. def andThen[A](g: (Boolean) => A): (Param[NodeT, EI]) => A
    Implicit
    This member is added by an implicit conversion from NodeValidator to(Param[NodeT, EI]) => Boolean performed by method predicateToNodePredicate in scalax.collection.GraphPredef.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (nodeValidator: (Param[NodeT, EI]) => Boolean).andThen(g)
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  2. def apply(v1: Param[NodeT, EI]): Boolean
    Implicit
    This member is added by an implicit conversion from NodeValidator to(Param[NodeT, EI]) => Boolean performed by method predicateToNodePredicate in scalax.collection.GraphPredef.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (nodeValidator: (Param[NodeT, EI]) => Boolean).apply(v1)
    Definition Classes
    Function1
  3. def compose[A](g: (A) => Param[NodeT, EI]): (A) => Boolean
    Implicit
    This member is added by an implicit conversion from NodeValidator to(Param[NodeT, EI]) => Boolean performed by method predicateToNodePredicate in scalax.collection.GraphPredef.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (nodeValidator: (Param[NodeT, EI]) => Boolean).compose(g)
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  4. def toString(): String
    Implicit
    This member is added by an implicit conversion from NodeValidator to(Param[NodeT, EI]) => Boolean performed by method predicateToNodePredicate in scalax.collection.GraphPredef.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (nodeValidator: (Param[NodeT, EI]) => Boolean).toString()
    Definition Classes
    Function1 → AnyRef → Any
  5. def toString(): String
    Implicit
    This member is added by an implicit conversion from NodeValidator toOuterNode[NodeValidator] performed by method anyToNode in scalax.collection.GraphPredef.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (nodeValidator: OuterNode[NodeValidator]).toString()
    Definition Classes
    NodeParam → AnyRef → Any

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from NodeValidator toStringFormat[NodeValidator] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (NodeValidator, B)
    Implicit
    This member is added by an implicit conversion from NodeValidator toArrowAssoc[NodeValidator] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from (NodeT) => Boolean

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion EdgeAssoc fromNodeValidator to EdgeAssoc[NodeValidator]

Inherited by implicit conversion predicateToNodePredicate fromNodeValidator to (Param[NodeT, EI]) => Boolean

Inherited by implicit conversion anyToNode fromNodeValidator to OuterNode[NodeValidator]

Inherited by implicit conversion ChainingOps fromNodeValidator to ChainingOps[NodeValidator]

Inherited by implicit conversion any2stringadd fromNodeValidator to any2stringadd[NodeValidator]

Inherited by implicit conversion StringFormat fromNodeValidator to StringFormat[NodeValidator]

Inherited by implicit conversion Ensuring fromNodeValidator to Ensuring[NodeValidator]

Inherited by implicit conversion ArrowAssoc fromNodeValidator to ArrowAssoc[NodeValidator]

Ungrouped