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
  • package config
    Definition Classes
    collection
  • package edge

    Predefined edges.

    Predefined edges.

    While basic edge types are defined in the object GraphEdge, the predefined edges in this package cover the following categories (prefixes, shortcuts):

    weighted (W, %), key-weighted (Wk, %#), labeled (L, +), key-labeled (Lk, +#), weighted and labeled (WL, %+), key-weighted and labeled (WkL, %#+), weighted and key-labeled (WLk, %+#) and key-weighted and key-labeled (WkLk, %#+#).

    These predefined edges provide alternatives for any edge extension taking the burden from the user to implement his/her custom edge class - but baring the disadvantage that user edge attributes must be part of a label class as opposed to being part of the edge class directly. It may also serve as a source for looking up how to implement custom edge classes.

    Definition Classes
    collection
  • package generator

    This package helps you to create random graphs with predefined metrics.

    This package helps you to create random graphs with predefined metrics. It is not only possible to create random graph instances but also Scalacheck generators.

    Definition Classes
    collection
  • package generic
    Definition Classes
    collection
  • package immutable
    Definition Classes
    collection
  • package interfaces
    Definition Classes
    collection
  • package mutable
    Definition Classes
    collection
  • Graph
  • GraphBase
  • GraphDegree
  • GraphEdge
  • GraphLike
  • GraphPredef
  • GraphTraversal
  • GraphTraversalImpl
  • State
  • TraverserImpl

object GraphTraversal extends Serializable

Contains traversal parameter definitions such as direction constants.

Linear Supertypes
Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GraphTraversal
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. sealed trait Direction extends AnyRef

    Algebraic type to determine which connected nodes the traversal has to follow.

    Algebraic type to determine which connected nodes the traversal has to follow. The default value is Successors.

    Note that methods returning a Cycle or Path accept only Successors.

  2. trait Kind extends AnyRef

    Algebraic type for the kind of traversal.

  3. trait NodeInformer extends AnyRef

    Marker trait for informers aimed at passing algorithmic-specific state to scalax.collection.GraphTraversal.ExtendedNodeVisitor.

    Marker trait for informers aimed at passing algorithmic-specific state to scalax.collection.GraphTraversal.ExtendedNodeVisitor. Following informers are available:

    1. scalax.collection.GraphTraversal#Informer.BfsInformer
    2. scalax.collection.GraphTraversal#Informer.DfsInformer
    3. scalax.collection.GraphTraversal#Informer.WgbInformer
    4. scalax.collection.GraphTraversal#Informer.DijkstraInformer
    5. scalax.collection.GraphTraversal#Informer.TarjanInformer.
  4. case class Parameters(kind: Kind = BreadthFirst, direction: Direction = Successors, maxDepth: Int = 0) extends Product with Serializable

    Parameters to control traversals.

    Parameters to control traversals.

    kind

    The kind of traversal including breadth-first and depth-fist search.

    direction

    Determines which connected nodes the traversal has to follow. The default value is Successors.

    maxDepth

    A positive value to limit the number of layers for BFS respectively the number of consecutive child visits before siblings are visited for DFS. 0 - the default - indicates that the traversal should have an unlimited depth.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  20. object AnyConnected extends Direction with Product with Serializable

    Defines the traversal to follow successor and predecessor nodes alike.

  21. object BreadthFirst extends Kind with Product with Serializable

    Instructs the traverser to use a breadth first search (BSF, search layer-for-layer).

  22. object DepthFirst extends Kind with Product with Serializable

    Instructs the traverser to use a depth first search (DFS).

  23. object NodeInformer extends Serializable
  24. object Parameters extends Serializable
  25. object Predecessors extends Direction with Product with Serializable

    Defines the traversal to follow predecessor nodes.

  26. object Successors extends Direction with Product with Serializable

    Defines the traversal to follow successor nodes.

  27. object Visitor

    Implements an empty visitor based on a value.

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped