scalax.collection.GraphTraversalImpl

Traversal

class Traversal extends GraphTraversalImpl.Traversal

Linear Supertypes
GraphTraversalImpl.Traversal, AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Traversal
  2. Traversal
  3. AnyRef
  4. Any
Implicitly
  1. by anyToNode
  2. by CollectionsHaveToParArray
  3. by EdgeAssoc
  4. by any2stringadd
  5. by StringFormat
  6. by Ensuring
  7. by ArrowAssoc
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Traversal(direction: Direction, nodeFilter: (NodeT) ⇒ Boolean, edgeFilter: (GraphTraversalImpl.EdgeT) ⇒ Boolean, nodeVisitor: (NodeT) ⇒ VisitorReturn, edgeVisitor: (GraphTraversalImpl.EdgeT) ⇒ Unit, ordering: GraphTraversalImpl.ElemOrdering)

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 information
    This member is added by an implicit conversion from Traversal to any2stringadd[Traversal] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Traversal, B)

    Implicit information
    This member is added by an implicit conversion from Traversal to ArrowAssoc[Traversal] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  6. final def _depthFirstSearch(root: NodeT, pred: (NodeT) ⇒ Boolean = noNode, maxDepth: Int = 0, nodeUpVisitor: (NodeT) ⇒ Unit = noNodeUpAction): (Option[NodeT], ArrayStack[(NodeT, Int)])

  7. final val addFilteredMethod: (NodeT, (NodeT) ⇒ Boolean, Boolean) ⇒ Iterable[NodeT]

    Attributes
    protected
  8. final val addMethod: (NodeT, GraphTraversalImpl.EdgeT, (NodeT) ⇒ Unit) ⇒ Unit

    Attributes
    protected
  9. def apply(root: NodeT, pred: (NodeT) ⇒ Boolean = noNode, breadthFirst: Boolean = true, maxDepth: Int = 0): Option[NodeT]

    Traverses this graph from root for side-effects allowing

    Traverses this graph from root for side-effects allowing

    a) to filter nodes and/or edges, b) to carry out any side effect at visited nodes and/or edges and c) to cancel the traversal at any node.

    root

    The node where subsequent graph traversals start.

    pred

    The traversal stops at the first node except for root for which this predicate holds true and returns it. The default value noNode leads to a full traversal.

    breadthFirst

    If true the traversal is based on a breath first (BFS, layer-for-layer) search, otherwise on a depth first search (DFS). The default value is BFS.

    maxDepth

    A positive value limiting the number of layers for Bfs respectively the number of consecutive child visits before siblings are visited for Dfs. 0, the default value, indicates that the traversal should have an unlimited depth meaning that it will be continued until either it's canceled or all nodes have been visited.

    returns

    the node found if any.

    Definition Classes
    TraversalTraversal
  10. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  11. final def bfs(root: NodeT, pred: (NodeT) ⇒ Boolean = noNode, maxDepth: Int = 0): Option[NodeT]

    Synonym for breadthFirstSearch

    Synonym for breadthFirstSearch

    Definition Classes
    Traversal
    Annotations
    @inline()
  12. def breadthFirstSearch(root: NodeT, pred: (NodeT) ⇒ Boolean = noNode, maxDepth: Int = 0): Option[NodeT]

    Starting at root, functionally traverses this graph up to maxDepth layers using the breadth first search algorithm and all filters, visitors etc.

    Starting at root, functionally traverses this graph up to maxDepth layers using the breadth first search algorithm and all filters, visitors etc. passed to the encapsulating Traversal instance.

    root

    The node where subsequent graph traversals start.

    pred

    The traversal stops at the first node except for root for which this predicate holds true and returns it. The default value noNode leads to a full traversal.

    maxDepth

    A positive value limiting the number of layers for Bfs respectively the number of consecutive child visits before siblings are visited for Dfs. 0, the default value, indicates that the traversal should have an unlimited depth meaning that it will be continued until either it's canceled or all nodes have been visited.

    returns

    the node found if any.

    Definition Classes
    TraversalTraversal
  13. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  14. def depthFirstSearch(root: NodeT, pred: (NodeT) ⇒ Boolean = noNode, maxDepth: Int = 0, nodeUpVisitor: (NodeT) ⇒ Unit = noNodeUpAction): Option[NodeT]

    Starting at root, functionally traverses this graph up to maxDepth layers using the depth first search algorithm and all filters, visitors etc.

    Starting at root, functionally traverses this graph up to maxDepth layers using the depth first search algorithm and all filters, visitors etc. passed to the encapsulating Traversal instance.

    root

    The node where subsequent graph traversals start.

    pred

    The traversal stops at the first node except for root for which this predicate holds true and returns it. The default value noNode leads to a full traversal.

    maxDepth

    A positive value limiting the number of layers for Bfs respectively the number of consecutive child visits before siblings are visited for Dfs. 0, the default value, indicates that the traversal should have an unlimited depth meaning that it will be continued until either it's canceled or all nodes have been visited.

    nodeUpVisitor

    Function to be called on reaching an already visited node when moving up in the imaginary tree of a depth first search. Paired with nodeVisitor (the 'down-visitor'), this 'up-visitor' enables a stack-wise view of the traversed nodes. The default value is the empty function noNodeUpAction. Alternatively, an instance of ExtendedNodeVisitor may be passed to obtain additional state information such as the current depth. The concrete type of the last argument, the informer depends on the underlying implementation so you need to match against it. Concerning this method please match against scalax.collection.GraphTraversalImpl.DfsInformer.

    returns

    the node found if any.

    Definition Classes
    TraversalTraversal
  15. def depthFirstSearchWGB(root: NodeT, predicate: (NodeT) ⇒ Boolean = noNode, globalState: Array[Handle] = Array.empty[Handle]): (Option[NodeT], ArrayStack[CycleStackElem])

    Tail-recursive white-gray-black DFS implementation for cycle detection.

    Tail-recursive white-gray-black DFS implementation for cycle detection.

    root

    start node for the search

    predicate

    node predicate marking an end condition for the search

    Attributes
    protected[scalax.collection]
  16. final def dfs(root: NodeT, pred: (NodeT) ⇒ Boolean = noNode, maxDepth: Int = 0, nodeUpVisitor: (NodeT) ⇒ Unit = noNodeUpAction): Option[NodeT]

    Synonym for depthFirstSearch

    Synonym for depthFirstSearch

    Definition Classes
    Traversal
    Annotations
    @inline()
  17. final val doEdgeFilter: Boolean

    Attributes
    protected
  18. final val doEdgeSort: Boolean

    Attributes
    protected
  19. final val doEdgeVisitor: Boolean

    Attributes
    protected
  20. final val doFilter: Boolean

    Attributes
    protected
  21. final val doNodeFilter: Boolean

    Attributes
    protected
  22. final val doNodeSort: Boolean

    Attributes
    protected
  23. final val doNodeVisitor: Boolean

    Attributes
    protected
  24. final val edgeOrdering: GraphTraversalImpl.EdgeOrdering

    Attributes
    protected
  25. final val edgesMethod: (NodeT) ⇒ Set[GraphTraversalImpl.EdgeT]

    Attributes
    protected
  26. def ensuring(cond: (Traversal) ⇒ Boolean, msg: ⇒ Any): Traversal

    Implicit information
    This member is added by an implicit conversion from Traversal to Ensuring[Traversal] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  27. def ensuring(cond: (Traversal) ⇒ Boolean): Traversal

    Implicit information
    This member is added by an implicit conversion from Traversal to Ensuring[Traversal] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  28. def ensuring(cond: Boolean, msg: ⇒ Any): Traversal

    Implicit information
    This member is added by an implicit conversion from Traversal to Ensuring[Traversal] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  29. def ensuring(cond: Boolean): Traversal

    Implicit information
    This member is added by an implicit conversion from Traversal to Ensuring[Traversal] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  30. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  31. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  32. def filteredDi(direction: Direction, node: NodeT, isVisited: (NodeT) ⇒ Boolean, reverse: Boolean): Iterable[NodeT]

    Attributes
    protected[scalax.collection]
  33. final def filteredDiPredecessors(node: NodeT, isVisited: (NodeT) ⇒ Boolean, reverse: Boolean): Iterable[NodeT]

    Computes the filtered direct predecessors of node.

    Computes the filtered direct predecessors of node. It also calls edgeVisitor but does not call nodeVisitor.

    node

    the node the direct predecessors are to be calculated of.

    isVisited

    function returning whether a specific node has already been visited during the current traversal.

    reverse

    whether to sort in reverse order. Only applicable when ordering is different from noOrdering.

    Attributes
    protected[scalax.collection]
    Definition Classes
    TraversalTraversal
    Annotations
    @inline()
  34. final def filteredDiSuccessors(node: NodeT, isVisited: (NodeT) ⇒ Boolean, reverse: Boolean): Iterable[NodeT]

    Computes the filtered direct successors of node.

    Computes the filtered direct successors of node. It also calls edgeVisitor but does not call nodeVisitor.

    node

    the node the direct successors are to be calculated of.

    isVisited

    function returning whether a specific node has already been visited during the current traversal.

    reverse

    whether to sort in reverse order. Only applicable when ordering is different from noOrdering.

    Attributes
    protected[scalax.collection]
    Definition Classes
    TraversalTraversal
    Annotations
    @inline()
  35. final def filteredNeighbors(node: NodeT, isVisited: (NodeT) ⇒ Boolean, reverse: Boolean): Iterable[NodeT]

    Computes the filtered neighbors of node.

    Computes the filtered neighbors of node. It also calls edgeVisitor but does not call nodeVisitor.

    node

    the node the adjacent are to be calculated of.

    isVisited

    function returning whether a specific node has already been visited during the current traversal.

    reverse

    whether to sort in reverse order. Only applicable when ordering is different from noOrdering.

    Attributes
    protected[scalax.collection]
    Definition Classes
    TraversalTraversal
    Annotations
    @inline()
  36. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  37. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from Traversal to StringFormat[Traversal] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  38. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  39. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  40. def isDefined: Boolean

    Implicit information
    This member is added by an implicit conversion from Traversal to OuterNode[Traversal] performed by method anyToNode in scalax.collection.GraphPredef.
    Definition Classes
    Param
  41. def isEdge: Boolean

    Implicit information
    This member is added by an implicit conversion from Traversal to OuterNode[Traversal] performed by method anyToNode in scalax.collection.GraphPredef.
    Definition Classes
    NodeParam
  42. def isIn: Boolean

    Implicit information
    This member is added by an implicit conversion from Traversal to OuterNode[Traversal] performed by method anyToNode in scalax.collection.GraphPredef.
    Definition Classes
    InParamParam
  43. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  44. def isNode: Boolean

    Implicit information
    This member is added by an implicit conversion from Traversal to OuterNode[Traversal] performed by method anyToNode in scalax.collection.GraphPredef.
    Definition Classes
    NodeParam
  45. def isOut: Boolean

    Implicit information
    This member is added by an implicit conversion from Traversal to OuterNode[Traversal] performed by method anyToNode in scalax.collection.GraphPredef.
    Definition Classes
    InParamParam
  46. val n1: Traversal

    Implicit information
    This member is added by an implicit conversion from Traversal to EdgeAssoc[Traversal] performed by method EdgeAssoc in scalax.collection.GraphPredef.
    Definition Classes
    EdgeAssoc
  47. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  48. final val noAction: (NodeT) ⇒ Unit

    Definition Classes
    Traversal
  49. final val nodeOrdering: GraphTraversalImpl.NodeOrdering

    Attributes
    protected
  50. final val notVisited: (NodeT) ⇒ Boolean

    Definition Classes
    Traversal
  51. final def notify(): Unit

    Definition Classes
    AnyRef
  52. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  53. final val reverseEdgeOrdering: Ordering[GraphTraversalImpl.EdgeT]

    Attributes
    protected
  54. final val reverseNodeOrdering: Ordering[NodeT]

    Attributes
    protected
  55. def stringPrefix: String

    Implicit information
    This member is added by an implicit conversion from Traversal to OuterNode[Traversal] performed by method anyToNode in scalax.collection.GraphPredef.
    Definition Classes
    NodeParam
  56. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  57. def toParArray: ParArray[T]

    Implicit information
    This member is added by an implicit conversion from Traversal to CollectionsHaveToParArray[Traversal, T] performed by method CollectionsHaveToParArray in scala.collection.parallel. This conversion will take place only if an implicit value of type (Traversal) ⇒ GenTraversableOnce[T] is in scope.
    Definition Classes
    CollectionsHaveToParArray
  58. def toString(): String

    Definition Classes
    AnyRef → Any
  59. val value: Traversal

    Implicit information
    This member is added by an implicit conversion from Traversal to OuterNode[Traversal] performed by method anyToNode in scalax.collection.GraphPredef.
    Definition Classes
    OuterNodeNodeParam
  60. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  61. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  62. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  63. def ~[N >: N1, N2 <: N](n2: N2): UnDiEdge[N]

    Implicit information
    This member is added by an implicit conversion from Traversal to EdgeAssoc[Traversal] performed by method EdgeAssoc in scalax.collection.GraphPredef.
    Definition Classes
    EdgeAssoc
    Annotations
    @inline()
  64. def ~>[N >: N1, N2 <: N](n2: N2): DiEdge[N]

    Implicit information
    This member is added by an implicit conversion from Traversal to EdgeAssoc[Traversal] performed by method EdgeAssoc in scalax.collection.GraphPredef.
    Definition Classes
    EdgeAssoc
    Annotations
    @inline()
  65. def [B](y: B): (Traversal, B)

    Implicit information
    This member is added by an implicit conversion from Traversal to ArrowAssoc[Traversal] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. def toString(): String

    Implicit information
    This member is added by an implicit conversion from Traversal to OuterNode[Traversal] 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:
    (traversal: OuterNode[Traversal]).toString()
    Definition Classes
    NodeParam → AnyRef → Any

Inherited from GraphTraversalImpl.Traversal

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion anyToNode from Traversal to OuterNode[Traversal]

Inherited by implicit conversion CollectionsHaveToParArray from Traversal to CollectionsHaveToParArray[Traversal, T]

Inherited by implicit conversion EdgeAssoc from Traversal to EdgeAssoc[Traversal]

Inherited by implicit conversion any2stringadd from Traversal to any2stringadd[Traversal]

Inherited by implicit conversion StringFormat from Traversal to StringFormat[Traversal]

Inherited by implicit conversion Ensuring from Traversal to Ensuring[Traversal]

Inherited by implicit conversion ArrowAssoc from Traversal to ArrowAssoc[Traversal]

Ungrouped