Packages

abstract class TraverserMethods[A, +CC <: TraverserMethods[A, CC]] extends FluentProperties[CC]

The root-related methods Traverser will inherit.

Attributes
protected
Self Type
CC with Properties
Linear Supertypes
FluentProperties[CC], AnyRef, Any
Known Subclasses
InnerEdgeTraverser, InnerElemTraverser, InnerNodeDownUpTraverser, InnerNodeTraverser, OuterEdgeTraverser, OuterElemTraverser, OuterNodeDownUpTraverser, OuterNodeTraverser, Traverser, DownUpTraverser, InnerEdgeTraverserImpl, InnerElemTraverserImpl, InnerNodeDownUpTraverserImpl, InnerNodeTraverserImpl, OuterEdgeTraverserImpl, OuterElemTraverserImpl, OuterNodeDownUpTraverserImpl, OuterNodeTraverserImpl, Impl
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TraverserMethods
  2. FluentProperties
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new TraverserMethods()

Abstract Value Members

  1. abstract def apply[U](pred: GraphTraversal.NodePredicate = noNode, visitor: (A) => U = empty): Option[NodeT]
    Attributes
    protected
  2. abstract def edgeVisitor[U](f: (A) => U): (GraphTraversal.EdgeT) => U
    Attributes
    protected
  3. abstract def findCycle[U](implicit visitor: (A) => U = empty): Option[Cycle]

    Finds a cycle starting the search at root taking optional properties like subgraph restriction, ordering or maximum depth into account., if any.

    Finds a cycle starting the search at root taking optional properties like subgraph restriction, ordering or maximum depth into account., if any. The resulting cycle may start at any node connected with this node.

    visitor

    An optional function that is applied for its side-effect to every element visited during graph traversal.

    returns

    A cycle or None if either

    1. there exists no cycle in the component depicting by root or
    2. there exists a cycle in the component but due to withSubgraph settings this path was out of scope.
  4. abstract def newTraverser: (NodeT, Parameters, GraphTraversal.NodePredicate, GraphTraversal.EdgePredicate, GraphTraversal.ElemOrdering, Option[Weight]) => CC
    Attributes
    protected
    Definition Classes
    FluentProperties
  5. abstract def nodeVisitor[U](f: (A) => U): (NodeT) => U
    Attributes
    protected
  6. abstract def partOfCycle[U](implicit visitor: (A) => U = empty): Option[Cycle]

    Finds a cycle that contains root taking optional properties like subgraph restriction, ordering or maximum depth into account..

    Finds a cycle that contains root taking optional properties like subgraph restriction, ordering or maximum depth into account.. Irrespective of the current setting for kind, DepthFirst is used internally.

    visitor

    An optional function that is applied for its side-effect to every element visited during graph traversal.

    returns

    A cycle containing root or None if either

    1. there exists no cycle containing root or
    2. there exists such a cycle but due to withSubgraph settings this path was out of scope.
  7. abstract def pathUntil[U](pred: GraphTraversal.NodePredicate)(implicit visitor: (A) => U = empty): Option[Path]

    Finds a path from root to a successor of root for which pred holds considering all traversal properties passed to the traverser factory method like scalax.collection.GraphTraversal#innerNodeTraverser or altered by any with* method.

    Finds a path from root to a successor of root for which pred holds considering all traversal properties passed to the traverser factory method like scalax.collection.GraphTraversal#innerNodeTraverser or altered by any with* method. root itself does not count as a match. This is also true if it has a hook. If several successors exist the algorithm selects any one of these.

    pred

    The predicate which must hold true for the successor.

    visitor

    An optional function that is applied for its side-effect to every element visited during graph traversal.

    returns

    A path to a node with the predicate pred or None if either

    1. there is no node with pred or
    2. there exists no path to such a node or
    3. there exists a path to such a node but due to withSubgraph settings this path was out of scope.
  8. abstract def root: NodeT
  9. abstract def shortestPathTo[T, U](potentialSuccessor: NodeT, weight: (GraphTraversal.EdgeT) => T, visitor: (A) => U)(implicit arg0: Numeric[T]): Option[Path]

    Finds the shortest path from root to potentialSuccessor considering all traversal properties passed to the traverser factory method like scalax.collection.GraphTraversal#innerNodeTraverser or altered by any with* method.

    Finds the shortest path from root to potentialSuccessor considering all traversal properties passed to the traverser factory method like scalax.collection.GraphTraversal#innerNodeTraverser or altered by any with* method. The calculation is based on the weight of the edges on the path. Edges have a default weight of 1L that can be overridden by custom edges. A weight function yielding any numeric type may also be passed to shortestPathTo.

    potentialSuccessor

    The node the shortest path is to be found to.

    weight

    Function to determine the weight of edges. If supplied, this function takes precedence over edge weights.

    visitor

    An optional function that is applied for its side-effect to every element visited during graph traversal.

    returns

    The shortest path to potentialSuccessor or None if either

    1. there exists no path to potentialSuccessor or
    2. there exists a path to potentialSuccessor but due to withSubgraph settings this path was out of scope.
  10. abstract def strongComponents[U](implicit visitor: (A) => U = empty): Iterable[Component]

    Finds all strongly connected components reachable from this node.

    Finds all strongly connected components reachable from this node. See componentTraverser for more control by means of FluentProperties.

    visitor

    Function to be called for each inner node or inner edge visited during the search.

  11. abstract def topologicalSort[U](ignorePredecessors: Boolean = false)(implicit visitor: (GraphTraversal.InnerElem) => U = empty): TopologicalSort

    Sorts the component designated by this node topologically.

    Sorts the component designated by this node topologically. Only nodes connected with this node will be included in the resulting topological order. If the graph is known to be connected choose GraphTraversal#topologicalSort instead. See componentTraverser for more control by means of FluentProperties.

    ignorePredecessors

    If true, the topological sort will be partial in that it will only include successors of root. withSubgraph restricts the successor nodes to be included but not predecessors that will be excluded in total.

    visitor

    Function to be called for each inner node or inner edge visited during the sort.

  12. abstract def weakComponent[U](implicit visitor: (A) => U = empty): Component

    Determines the weak component that contains this node.

    Determines the weak component that contains this node. See componentTraverser for more control by means of FluentProperties.

    visitor

    Function to be called for each inner node or inner edge visited during the search.

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 TraverserMethods[A, CC] toany2stringadd[TraverserMethods[A, CC]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (TraverserMethods[A, CC], B)
    Implicit
    This member is added by an implicit conversion from TraverserMethods[A, CC] toArrowAssoc[TraverserMethods[A, CC]] 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 asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. def ensuring(cond: (TraverserMethods[A, CC]) => Boolean, msg: => Any): TraverserMethods[A, CC]
    Implicit
    This member is added by an implicit conversion from TraverserMethods[A, CC] toEnsuring[TraverserMethods[A, CC]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (TraverserMethods[A, CC]) => Boolean): TraverserMethods[A, CC]
    Implicit
    This member is added by an implicit conversion from TraverserMethods[A, CC] toEnsuring[TraverserMethods[A, CC]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): TraverserMethods[A, CC]
    Implicit
    This member is added by an implicit conversion from TraverserMethods[A, CC] toEnsuring[TraverserMethods[A, CC]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): TraverserMethods[A, CC]
    Implicit
    This member is added by an implicit conversion from TraverserMethods[A, CC] toEnsuring[TraverserMethods[A, CC]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. final def findConnected[U](pred: GraphTraversal.NodePredicate)(implicit visitor: (A) => U = empty): Option[NodeT]

    Finds a node connected with root by any number of edges with any direction for which the predicate pred holds considering all traversal properties passed to the traverser factory method like scalax.collection.GraphTraversal#innerNodeTraverser or altered by any with* method.

    Finds a node connected with root by any number of edges with any direction for which the predicate pred holds considering all traversal properties passed to the traverser factory method like scalax.collection.GraphTraversal#innerNodeTraverser or altered by any with* method. For directed or mixed graphs the node to be found is weakly connected with this node. root itself does not count as a match. This is also true if it has a hook. If several connected nodes exist with pred the algorithm selects any one of these.

    pred

    The predicate which must hold true for the resulting node.

    visitor

    An optional function that is applied for its side-effect to every element visited during graph traversal.

    returns

    A node with the predicate pred or None if either

    1. there is no node with pred or
    2. there exists no connection to such a node or
    3. there exists a connection to such a node but due to withSubgraph settings this path was out of scope.
  15. final def findPredecessor[U](pred: GraphTraversal.NodePredicate)(implicit visitor: (A) => U = empty): Option[NodeT]

    Finds a predecessor of root for which the predicate pred holds considering all traversal properties passed to the traverser factory method like scalax.collection.GraphTraversal#innerNodeTraverser or altered by any with* method.

    Finds a predecessor of root for which the predicate pred holds considering all traversal properties passed to the traverser factory method like scalax.collection.GraphTraversal#innerNodeTraverser or altered by any with* method. root itself does not count as a match. This is also true if it has a hook. If several predecessors exist the algorithm selects the first of them found.

    pred

    The predicate which must hold true for the resulting node.

    visitor

    An optional function that is applied for its side-effect to every element visited during graph traversal.

    returns

    A node with the predicate pred or None if either

    1. there is no node with pred or
    2. there exists no path from such a node to this node or
    3. there exists a path from such a node to root but due to withSubgraph settings this path was out of scope.
  16. final def findSuccessor[U](pred: GraphTraversal.NodePredicate)(implicit visitor: (A) => U = empty): Option[NodeT]

    Finds a successor of root for which the predicate pred holds considering all traversal properties passed to the traverser factory method like scalax.collection.GraphTraversal#innerNodeTraverser or altered by any with* method.

    Finds a successor of root for which the predicate pred holds considering all traversal properties passed to the traverser factory method like scalax.collection.GraphTraversal#innerNodeTraverser or altered by any with* method. root itself does not count as a match. This is also true if it has a hook. If several successors holding pred exist any one of them may be returned.

    pred

    The predicate which must hold for the resulting node.

    visitor

    An optional function that is applied for its side-effect to every element visited during graph traversal.

    returns

    A node with the predicate pred or None if either

    1. there is no node with pred or
    2. there exists no path to such a node or
    3. there exists a path to such a node but due to withSubgraph settings this path was out of scope.
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. final def hasPredecessor[U](potentialPredecessor: NodeT)(implicit visitor: (A) => U = empty): Boolean

    Checks whether potentialPredecessor is a predecessor of root considering all traversal properties passed to the traverser factory method like scalax.collection.GraphTraversal#innerNodeTraverser or altered by any with* method.

    Checks whether potentialPredecessor is a predecessor of root considering all traversal properties passed to the traverser factory method like scalax.collection.GraphTraversal#innerNodeTraverser or altered by any with* method. Same as isSuccessorOf.

    potentialPredecessor

    The node which is potentially a predecessor of root.

    visitor

    An optional function that is applied for its side-effect to every element visited during graph traversal.

    returns

    true if a path exists from potentialPredecessor to root and it had not to be excluded due to subgraph properties.

    Annotations
    @inline()
  19. final def hasSuccessor[U](potentialSuccessor: NodeT)(implicit visitor: (A) => U = empty): Boolean

    Checks whether potentialSuccessor is a successor of this node considering all traversal properties passed to the traverser factory method like scalax.collection.GraphTraversal#innerNodeTraverser or altered by any with* method.

    Checks whether potentialSuccessor is a successor of this node considering all traversal properties passed to the traverser factory method like scalax.collection.GraphTraversal#innerNodeTraverser or altered by any with* method. Same as isPredecessorOf.

    potentialSuccessor

    The node which is potentially a successor of this node.

    visitor

    An optional function that is applied for its side-effect to every element visited during graph traversal.

    returns

    true if a path exists from this node to potentialSuccessor and it had not to be excluded due to a subgraph* restriction.

    Annotations
    @inline()
  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. final def isConnectedWith[U](potentialConnected: NodeT)(implicit visitor: (A) => U = empty): Boolean

    Checks whether potentialConnected is a node (not necessarily directly) connected with root by any number of edges with any direction considering all traversal properties passed to the traverser factory method like scalax.collection.GraphTraversal#innerNodeTraverser or altered by any with* method.

    Checks whether potentialConnected is a node (not necessarily directly) connected with root by any number of edges with any direction considering all traversal properties passed to the traverser factory method like scalax.collection.GraphTraversal#innerNodeTraverser or altered by any with* method. For directed or mixed graphs it is satisfactory that potentialConnected is weakly connected with root.

    potentialConnected

    The node which is potentially connected with root.

    visitor

    An optional function that is applied for its side-effect to every element visited during graph traversal.

    returns

    true if a path exists from this node to potentialConnected and it had not to be excluded due to subgraph properties.

    Annotations
    @inline()
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. final def isPredecessorOf[U](potentialSuccessor: NodeT)(implicit visitor: (A) => U = empty): Boolean

    Same as hasSuccessor.

    Same as hasSuccessor.

    Annotations
    @inline()
  24. final def isSuccessorOf[U](potentialPredecessor: NodeT)(implicit visitor: (A) => U = empty): Boolean

    Same as hasPredecessor.

    Same as hasPredecessor.

    Annotations
    @inline()
  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. final def pathTo[U](potentialSuccessor: NodeT)(implicit visitor: (A) => U = empty): Option[Path]

    Finds a path from root to potentialSuccessor considering all traversal properties passed to the traverser factory method like scalax.collection.GraphTraversal#innerNodeTraverser or altered by any with* method.

    Finds a path from root to potentialSuccessor considering all traversal properties passed to the traverser factory method like scalax.collection.GraphTraversal#innerNodeTraverser or altered by any with* method.

    potentialSuccessor

    The node a path is to be found to.

    visitor

    An optional function that is applied for its side-effect to every element visited during graph traversal.

    returns

    A path to potentialSuccessor or None if either

    1. there is no node with pred or
    2. there exists no path to such a node
  29. final def requireSuccessors[A](block: => A): A
    Attributes
    protected
  30. final def shortestPathTo[T](potentialSuccessor: NodeT, weight: (GraphTraversal.EdgeT) => T)(implicit arg0: Numeric[T]): Option[Path]

    Finds the shortest path from root to potentialSuccessor considering all traversal properties passed to the traverser factory method like scalax.collection.GraphTraversal#innerNodeTraverser or altered by any with* method.

    Finds the shortest path from root to potentialSuccessor considering all traversal properties passed to the traverser factory method like scalax.collection.GraphTraversal#innerNodeTraverser or altered by any with* method. The calculation is based on the weight of the edges on the path. Edges have a default weight of 1L that can be overridden by custom edges. A weight function yielding any numeric type may also be passed to shortestPathTo.

    potentialSuccessor

    The node the shortest path is to be found to.

    weight

    Function to determine the weight of edges. If supplied, this function takes precedence over edge weights.

    returns

    The shortest path to potentialSuccessor or None if either

    1. there exists no path to potentialSuccessor or
    2. there exists a path to potentialSuccessor but due to withSubgraph settings this path was out of scope.
    Annotations
    @inline()
  31. final def shortestPathTo[U](potentialSuccessor: NodeT)(implicit visitor: (A) => U = empty): Option[Path]

    Finds the shortest path from root to potentialSuccessor considering all traversal properties passed to the traverser factory method like scalax.collection.GraphTraversal#innerNodeTraverser or altered by any with* method.

    Finds the shortest path from root to potentialSuccessor considering all traversal properties passed to the traverser factory method like scalax.collection.GraphTraversal#innerNodeTraverser or altered by any with* method. The calculation is based on the weight of the edges on the path. Edges have a default weight of 1L that can be overridden by custom edges. A weight function yielding any numeric type may also be passed to shortestPathTo.

    potentialSuccessor

    The node the shortest path is to be found to.

    visitor

    An optional function that is applied for its side-effect to every element visited during graph traversal.

    returns

    The shortest path to potentialSuccessor or None if either

    1. there exists no path to potentialSuccessor or
    2. there exists a path to potentialSuccessor but due to withSubgraph settings this path was out of scope.
    Annotations
    @inline()
  32. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  33. final def toInnerElemTraverser(root: NodeT): InnerElemTraverser
    Definition Classes
    FluentProperties
  34. def toString(): String
    Definition Classes
    AnyRef → Any
  35. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  36. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  37. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  38. final def withDirection(direction: Direction): CC

    Creates a new FluentProperties based on this except for an updated direction.

    Creates a new FluentProperties based on this except for an updated direction. Note that methods returning a Cycle or Path accept only Successors.

    Definition Classes
    FluentProperties
  39. final def withKind(kind: Kind): CC

    Creates a new FluentProperties based on this except for an updated kind.

    Creates a new FluentProperties based on this except for an updated kind.

    Definition Classes
    FluentProperties
  40. final def withMaxDepth(maxDepth: Int): CC

    Creates a new FluentProperties based on this except for an updated maxDepth.

    Creates a new FluentProperties based on this except for an updated maxDepth.

    Definition Classes
    FluentProperties
  41. final def withMaxWeight(max: Long): CC

    Creates a new FluentProperties based on this except for an updated maxWeight having the given max and the default weight function returning edge.weight.

    Creates a new FluentProperties based on this except for an updated maxWeight having the given max and the default weight function returning edge.weight.

    Definition Classes
    FluentProperties
  42. final def withMaxWeight[W](max: W, edgeWeight: (GraphTraversal.EdgeT) => W)(implicit arg0: Numeric[W]): CC

    Creates a new FluentProperties based on this except for an updated maxWeight having the given max value and the given weight function.

    Creates a new FluentProperties based on this except for an updated maxWeight having the given max value and the given weight function.

    Definition Classes
    FluentProperties
  43. def withMaxWeight(maxWeight: Option[Weight]): CC

    Creates a new FluentProperties based on this except for an updated maxWeight.

    Creates a new FluentProperties based on this except for an updated maxWeight.

    Definition Classes
    FluentProperties
  44. final def withOrdering(ordering: GraphTraversal.ElemOrdering): CC

    Creates a new FluentProperties based on this except for an updated ordering.

    Creates a new FluentProperties based on this except for an updated ordering.

    Definition Classes
    FluentProperties
  45. final def withParameters(parameters: Parameters): CC

    Creates a new FluentProperties based on this except for an updated parameters.

    Creates a new FluentProperties based on this except for an updated parameters.

    Definition Classes
    FluentProperties
  46. final def withRoot(root: NodeT): CC

    Creates a new FluentProperties based on this except for an updated root.

  47. final def withSubgraph(nodes: GraphTraversal.NodePredicate = anyNode, edges: GraphTraversal.EdgePredicate = anyEdge): CC

    Creates a new FluentProperties based on this except for an updated subgraphNodes and/or subgraphEdges.

    Creates a new FluentProperties based on this except for an updated subgraphNodes and/or subgraphEdges.

    Definition Classes
    FluentProperties

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 TraverserMethods[A, CC] toStringFormat[TraverserMethods[A, CC]] 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): (TraverserMethods[A, CC], B)
    Implicit
    This member is added by an implicit conversion from TraverserMethods[A, CC] toArrowAssoc[TraverserMethods[A, CC]] 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 FluentProperties[CC]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromTraverserMethods[A, CC] to any2stringadd[TraverserMethods[A, CC]]

Inherited by implicit conversion StringFormat fromTraverserMethods[A, CC] to StringFormat[TraverserMethods[A, CC]]

Inherited by implicit conversion Ensuring fromTraverserMethods[A, CC] to Ensuring[TraverserMethods[A, CC]]

Inherited by implicit conversion ArrowAssoc fromTraverserMethods[A, CC] to ArrowAssoc[TraverserMethods[A, CC]]

Ungrouped