trait TraverserInnerNode extends BaseInnerNode
- Alphabetic
- By Inheritance
- TraverserInnerNode
- BaseInnerNode
- InnerNode
- InnerElem
- Node
- Serializable
- AnyRef
- Any
- by toDefaultTraverser
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def addDiPredecessors(edge: GraphTraversal.EdgeT, add: (NodeT) => Unit): Unit
- Attributes
- protected[collection]
- Definition Classes
- BaseInnerNode
- abstract def addDiSuccessors(edge: GraphTraversal.EdgeT, add: (NodeT) => Unit): Unit
- Attributes
- protected[collection]
- Definition Classes
- BaseInnerNode
- abstract def addNeighbors(edge: GraphTraversal.EdgeT, add: (NodeT) => Unit): Unit
- Attributes
- protected[collection]
- Definition Classes
- BaseInnerNode
- abstract def asNodeT: NodeT
- Attributes
- protected[collection]
- Definition Classes
- InnerNode
- abstract def connectionsWith(other: NodeT): Set[GraphTraversal.EdgeT] with FilterableSet[GraphTraversal.EdgeT]
All edges connecting this node with
other
including outgoing and incoming edges.All edges connecting this node with
other
including outgoing and incoming edges. This method is useful in case of multigraphs.- other
A node which is possibly connected with this node.
- returns
All edges connecting this node with
other
. Ifother
equals this node all hooks are returned. Ifother
is not connected with this node an empty set is returned.
- Definition Classes
- BaseInnerNode
- abstract def degree: Int
The degree of this node.
The degree of this node.
- returns
the number of edges that connect to this node. An edge that connects to this node at more than one ends (loop) is counted as much times as it is connected to this node.
- Definition Classes
- BaseInnerNode
- abstract def diPredecessors: Set[NodeT]
All direct predecessors of this node, also called predecessor set or open in-neighborhood: source nodes of directed incident edges and / or adjacent nodes of undirected incident edges excluding this node.
All direct predecessors of this node, also called predecessor set or open in-neighborhood: source nodes of directed incident edges and / or adjacent nodes of undirected incident edges excluding this node.
- returns
set of all direct predecessors of this node.
- Definition Classes
- BaseInnerNode
- abstract def diSuccessors: Set[NodeT]
All direct successors of this node, also called successor set or open out-neighborhood: target nodes of directed incident edges and / or adjacent nodes of undirected incident edges excluding this node.
All direct successors of this node, also called successor set or open out-neighborhood: target nodes of directed incident edges and / or adjacent nodes of undirected incident edges excluding this node.
- returns
set of all direct successors of this node.
- Definition Classes
- BaseInnerNode
- abstract def edges: ExtSet[GraphTraversal.EdgeT]
All edges at this node - commonly denoted as E(v).
All edges at this node - commonly denoted as E(v).
- returns
all edges connecting to this node.
- Definition Classes
- BaseInnerNode
- abstract def findIncomingFrom(from: NodeT): Option[GraphTraversal.EdgeT]
An edge at
from
having this node as a successor.An edge at
from
having this node as a successor.- from
The node being at an edge which has this node as a successor.
- returns
An edges at
from
having this node as a successor. Iffrom
equals this node a hook may be returned. Iffrom
is not an adjacent nodeNone
is returned.
- Definition Classes
- BaseInnerNode
- abstract def findOutgoingTo(to: NodeT): Option[GraphTraversal.EdgeT]
An outgoing edge connecting this node with
to
.An outgoing edge connecting this node with
to
.- to
The node which is the end point of an edge starting at this node.
- returns
One of possibly several edges connecting this node with
to
. Ifto
equals this node a hook may be returned. Ifto
is not an adjacent nodeNone
is returned.
- Definition Classes
- BaseInnerNode
- abstract def hasOnlyHooks: Boolean
Checks whether this node has only hooks or no edges at all.
Checks whether this node has only hooks or no edges at all.
- returns
true
if this node has only hooks or it isolated.
- Definition Classes
- BaseInnerNode
- abstract def hasPredecessors: Boolean
Whether this node has any predecessors.
Whether this node has any predecessors.
- Definition Classes
- BaseInnerNode
- abstract def hasSuccessors: Boolean
Whether this node has any successors.
Whether this node has any successors.
- Definition Classes
- BaseInnerNode
- abstract def hook: Option[GraphTraversal.EdgeT]
- returns
A looping edge out of one or more at this node or
None
if this node has no looping edge.
- Definition Classes
- BaseInnerNode
- abstract def inDegree(nodeFilter: GraphTraversal.NodePredicate, edgeFilter: GraphTraversal.EdgePredicate = anyEdge, includeHooks: Boolean = false, ignoreMultiEdges: Boolean = true): Int
The incoming degree of this node after applying some filters to the incoming edges and predecessors.
The incoming degree of this node after applying some filters to the incoming edges and predecessors.
- Definition Classes
- BaseInnerNode
- abstract def inDegree: Int
The incoming degree of this node.
The incoming degree of this node.
- returns
the number of edges that come in to this node including undirected edges. Loops count once each.
- Definition Classes
- BaseInnerNode
- abstract def incoming: Set[GraphTraversal.EdgeT] with FilterableSet[GraphTraversal.EdgeT]
Incoming edges of this node.
Incoming edges of this node.
- returns
set of all edges incoming to of this including undirected edges.
- Definition Classes
- BaseInnerNode
- abstract def incomingFrom(from: NodeT): Set[GraphTraversal.EdgeT] with FilterableSet[GraphTraversal.EdgeT]
All incoming edges connecting
from
with this node.All incoming edges connecting
from
with this node.- from
The node with zero, one or more edges having this node as a direct successor.
- returns
All edges at
from
having this node as a direct successor. Iffrom
equals this node all hooks are returned. Iffrom
is not an adjacent node an empty set is returned.
- Definition Classes
- BaseInnerNode
- abstract def isDirectPredecessorOf(that: NodeT): Boolean
Whether
that
is an adjacent (direct successor) to this node.Whether
that
is an adjacent (direct successor) to this node.- that
The node to check for adjacency.
- returns
true
ifthat
is adjacent to this node.
- Definition Classes
- BaseInnerNode
- abstract def isIndependentOf(that: NodeT): Boolean
Whether
that
is independent of this node meaning that there exists no edge connecting this node withthat
.Whether
that
is independent of this node meaning that there exists no edge connecting this node withthat
.- that
The node to check for independency.
- returns
true
ifthat
node is independent of this node.
- Definition Classes
- BaseInnerNode
- abstract def neighbors: Set[NodeT]
All adjacent nodes (direct successors and predecessors) of this node, also called open neighborhood excluding this node.
All adjacent nodes (direct successors and predecessors) of this node, also called open neighborhood excluding this node.
- returns
set of all neighbors.
- Definition Classes
- BaseInnerNode
- abstract def outDegree(nodeFilter: GraphTraversal.NodePredicate, edgeFilter: GraphTraversal.EdgePredicate = anyEdge, includeHooks: Boolean = false, ignoreMultiEdges: Boolean = true): Int
The outgoing degree of this node after applying some filters to the outgoing edges and successors.
The outgoing degree of this node after applying some filters to the outgoing edges and successors.
- Definition Classes
- BaseInnerNode
- abstract def outDegree: Int
The outgoing degree of this node.
The outgoing degree of this node.
- returns
the number of edges that go out from this node including undirected edges. Loops count once each.
- Definition Classes
- BaseInnerNode
- abstract def outer: N
The outer node as supplied by instantiation or addition.
The outer node as supplied by instantiation or addition.
- Definition Classes
- InnerNode
- abstract def outgoing: Set[GraphTraversal.EdgeT] with FilterableSet[GraphTraversal.EdgeT]
All edges outgoing from this node.
All edges outgoing from this node.
- returns
set of all edges outgoing from this node including undirected edges and hooks.
- Definition Classes
- BaseInnerNode
- abstract def outgoingTo(to: NodeT): Set[GraphTraversal.EdgeT] with FilterableSet[GraphTraversal.EdgeT]
All outgoing edges connecting this node with
to
.All outgoing edges connecting this node with
to
.- to
The node which is the end point of zero, one or more edges starting at this node.
- returns
All edges connecting this node with
to
. Ifto
equals this node all hooks are returned. Ifto
is not an adjacent an empty set is returned.
- Definition Classes
- BaseInnerNode
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from TraverserInnerNode toany2stringadd[TraverserInnerNode] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (TraverserInnerNode, B)
- Implicit
- This member is added by an implicit conversion from TraverserInnerNode toArrowAssoc[TraverserInnerNode] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def canEqual(that: Any): Boolean
- Definition Classes
- BaseInnerNode
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def ensuring(cond: (TraverserInnerNode) => Boolean, msg: => Any): TraverserInnerNode
- Implicit
- This member is added by an implicit conversion from TraverserInnerNode toEnsuring[TraverserInnerNode] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (TraverserInnerNode) => Boolean): TraverserInnerNode
- Implicit
- This member is added by an implicit conversion from TraverserInnerNode toEnsuring[TraverserInnerNode] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): TraverserInnerNode
- Implicit
- This member is added by an implicit conversion from TraverserInnerNode toEnsuring[TraverserInnerNode] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): TraverserInnerNode
- Implicit
- This member is added by an implicit conversion from TraverserInnerNode toEnsuring[TraverserInnerNode] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(other: Any): Boolean
- Definition Classes
- BaseInnerNode → AnyRef → Any
- final def findConnected[U](pred: GraphTraversal.NodePredicate)(implicit visitor: (NodeT) => U = empty): Option[NodeT]
Finds a node connected with
root
by any number of edges with any direction for which the predicatepred
holds considering all traversal properties passed to the traverser factory method like scalax.collection.GraphTraversal#innerNodeTraverser or altered by anywith*
method.Finds a node connected with
root
by any number of edges with any direction for which the predicatepred
holds considering all traversal properties passed to the traverser factory method like scalax.collection.GraphTraversal#innerNodeTraverser or altered by anywith*
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 withpred
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
orNone
if either- there is no node with
pred
or - there exists no connection to such a node or
- there exists a connection to such a node but due to withSubgraph settings this path was out of scope.
- there is no node with
- Implicit
- This member is added by an implicit conversion from TraverserInnerNode toTraverserMethods[NodeT, InnerNodeTraverser] performed by method toDefaultTraverser in scalax.collection.GraphTraversal.TraverserInnerNode.
- Definition Classes
- TraverserMethods
- def findCycle[U](implicit visitor: (NodeT) => 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 withthis
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- there exists no cycle in the component depicting by
root
or - there exists a cycle in the component but due to withSubgraph settings this path was out of scope.
- there exists no cycle in the component depicting by
- Implicit
- This member is added by an implicit conversion from TraverserInnerNode toTraverserMethods[NodeT, InnerNodeTraverser] performed by method toDefaultTraverser in scalax.collection.GraphTraversal.TraverserInnerNode.
- Definition Classes
- TraverserMethods
- final def findPredecessor[U](pred: GraphTraversal.NodePredicate)(implicit visitor: (NodeT) => U = empty): Option[NodeT]
Finds a predecessor of
root
for which the predicatepred
holds considering all traversal properties passed to the traverser factory method like scalax.collection.GraphTraversal#innerNodeTraverser or altered by anywith*
method.Finds a predecessor of
root
for which the predicatepred
holds considering all traversal properties passed to the traverser factory method like scalax.collection.GraphTraversal#innerNodeTraverser or altered by anywith*
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
orNone
if either- there is no node with
pred
or - there exists no path from such a node to this node or
- there exists a path from such a node to
root
but due to withSubgraph settings this path was out of scope.
- there is no node with
- Implicit
- This member is added by an implicit conversion from TraverserInnerNode toTraverserMethods[NodeT, InnerNodeTraverser] performed by method toDefaultTraverser in scalax.collection.GraphTraversal.TraverserInnerNode.
- Definition Classes
- TraverserMethods
- final def findSuccessor[U](pred: GraphTraversal.NodePredicate)(implicit visitor: (NodeT) => U = empty): Option[NodeT]
Finds a successor of
root
for which the predicatepred
holds considering all traversal properties passed to the traverser factory method like scalax.collection.GraphTraversal#innerNodeTraverser or altered by anywith*
method.Finds a successor of
root
for which the predicatepred
holds considering all traversal properties passed to the traverser factory method like scalax.collection.GraphTraversal#innerNodeTraverser or altered by anywith*
method.root
itself does not count as a match. This is also true if it has a hook. If several successors holdingpred
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
orNone
if either- there is no node with
pred
or - there exists no path to such a node or
- there exists a path to such a node but due to withSubgraph settings this path was out of scope.
- there is no node with
- Implicit
- This member is added by an implicit conversion from TraverserInnerNode toTraverserMethods[NodeT, InnerNodeTraverser] performed by method toDefaultTraverser in scalax.collection.GraphTraversal.TraverserInnerNode.
- Definition Classes
- TraverserMethods
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def hasPredecessor[U](potentialPredecessor: NodeT)(implicit visitor: (NodeT) => U = empty): Boolean
Checks whether
potentialPredecessor
is a predecessor ofroot
considering all traversal properties passed to the traverser factory method like scalax.collection.GraphTraversal#innerNodeTraverser or altered by anywith*
method.Checks whether
potentialPredecessor
is a predecessor ofroot
considering all traversal properties passed to the traverser factory method like scalax.collection.GraphTraversal#innerNodeTraverser or altered by anywith*
method. Same asisSuccessorOf
.- 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 frompotentialPredecessor
toroot
and it had not to be excluded due tosubgraph
properties.
- Implicit
- This member is added by an implicit conversion from TraverserInnerNode toTraverserMethods[NodeT, InnerNodeTraverser] performed by method toDefaultTraverser in scalax.collection.GraphTraversal.TraverserInnerNode.
- Definition Classes
- TraverserMethods
- Annotations
- @inline()
- final def hasSuccessor[U](potentialSuccessor: NodeT)(implicit visitor: (NodeT) => 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 anywith*
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 anywith*
method. Same asisPredecessorOf
.- 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 topotentialSuccessor
and it had not to be excluded due to asubgraph*
restriction.
- Implicit
- This member is added by an implicit conversion from TraverserInnerNode toTraverserMethods[NodeT, InnerNodeTraverser] performed by method toDefaultTraverser in scalax.collection.GraphTraversal.TraverserInnerNode.
- Definition Classes
- TraverserMethods
- Annotations
- @inline()
- def hashCode(): Int
- Definition Classes
- BaseInnerNode → AnyRef → Any
- final def inNeighbors: Set[NodeT]
Synonym for
diPredecessors
.Synonym for
diPredecessors
.- Definition Classes
- BaseInnerNode
- Annotations
- @inline()
- final def innerEdgeTraverser(implicit parameters: Parameters = Parameters()): InnerEdgeTraverser
Instantiates an InnerEdgeTraverser which extends
scala.collection.Iterable
with elements of typeEdgeT
and sets itsroot
to this node.Instantiates an InnerEdgeTraverser which extends
scala.collection.Iterable
with elements of typeEdgeT
and sets itsroot
to this node. To start a traversal call one of the graph traversal methods or any appropriate method inherited from scala.collection.Iterable on this instance.- parameters
The properties controlling subsequent traversals.
- Annotations
- @inline()
- final def innerElemTraverser(implicit parameters: Parameters = Parameters()): InnerElemTraverser
Instantiates an InnerElemTraverser which extends
scala.collection.Iterable
with elements of typeInnerElem
and sets itsroot
to this node.Instantiates an InnerElemTraverser which extends
scala.collection.Iterable
with elements of typeInnerElem
and sets itsroot
to this node. To start a traversal call one of the graph traversal methods or any appropriate method inherited from scala.collection.Iterable on this instance.- parameters
The properties controlling subsequent traversals.
- Annotations
- @inline()
- final def innerNodeDownUpTraverser(implicit parameters: Parameters = Parameters()): InnerNodeDownUpTraverser
Instantiates an InnerNodeDownUpTraverser which extends
scala.collection.Iterable
with elements of type(Boolean, NodeT)
and sets itsroot
to this node.Instantiates an InnerNodeDownUpTraverser which extends
scala.collection.Iterable
with elements of type(Boolean, NodeT)
and sets itsroot
to this node. To start a traversal call one of the graph traversal methods or any appropriate method inherited from scala.collection.Iterable on this instance.- parameters
The properties controlling subsequent traversals.
- Annotations
- @inline()
- final def innerNodeTraverser(implicit parameters: Parameters = Parameters()): InnerNodeTraverser
Instantiates an InnerNodeTraverser which extends
scala.collection.Iterable
with elements of typeNodeT
and sets itsroot
to this node.Instantiates an InnerNodeTraverser which extends
scala.collection.Iterable
with elements of typeNodeT
and sets itsroot
to this node. To start a traversal call one of the graph traversal methods or any appropriate method inherited from scala.collection.Iterable on this instance.- parameters
The properties controlling subsequent traversals.
- Annotations
- @inline()
- final def isConnectedWith[U](potentialConnected: NodeT)(implicit visitor: (NodeT) => U = empty): Boolean
Checks whether
potentialConnected
is a node (not necessarily directly) connected withroot
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 anywith*
method.Checks whether
potentialConnected
is a node (not necessarily directly) connected withroot
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 anywith*
method. For directed or mixed graphs it is satisfactory thatpotentialConnected
is weakly connected withroot
.- 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 topotentialConnected
and it had not to be excluded due tosubgraph
properties.
- Implicit
- This member is added by an implicit conversion from TraverserInnerNode toTraverserMethods[NodeT, InnerNodeTraverser] performed by method toDefaultTraverser in scalax.collection.GraphTraversal.TraverserInnerNode.
- Definition Classes
- TraverserMethods
- Annotations
- @inline()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def isIsolated: Boolean
true
if this node's degree equals to 0.true
if this node's degree equals to 0.- Definition Classes
- BaseInnerNode
- Annotations
- @inline()
- final def isLeaf: Boolean
true
if this node's degree equals to 1.true
if this node's degree equals to 1.- Definition Classes
- BaseInnerNode
- Annotations
- @inline()
- final def isPredecessorOf[U](potentialSuccessor: NodeT)(implicit visitor: (NodeT) => U = empty): Boolean
Same as
hasSuccessor
.Same as
hasSuccessor
.- Implicit
- This member is added by an implicit conversion from TraverserInnerNode toTraverserMethods[NodeT, InnerNodeTraverser] performed by method toDefaultTraverser in scalax.collection.GraphTraversal.TraverserInnerNode.
- Definition Classes
- TraverserMethods
- Annotations
- @inline()
- final def isSuccessorOf[U](potentialPredecessor: NodeT)(implicit visitor: (NodeT) => U = empty): Boolean
Same as
hasPredecessor
.Same as
hasPredecessor
.- Implicit
- This member is added by an implicit conversion from TraverserInnerNode toTraverserMethods[NodeT, InnerNodeTraverser] performed by method toDefaultTraverser in scalax.collection.GraphTraversal.TraverserInnerNode.
- Definition Classes
- TraverserMethods
- Annotations
- @inline()
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def outNeighbors: Set[NodeT]
Synonym for
diSuccessors
.Synonym for
diSuccessors
.- Definition Classes
- BaseInnerNode
- Annotations
- @inline()
- final def outerEdgeTraverser(implicit parameters: Parameters = Parameters()): OuterEdgeTraverser
Instantiates an OuterEdgeTraverser which extends
scala.collection.Iterable
with elements of typeE[N]
and sets itsroot
to this node.Instantiates an OuterEdgeTraverser which extends
scala.collection.Iterable
with elements of typeE[N]
and sets itsroot
to this node. To start a traversal call one of the graph traversal methods or any appropriate method inherited from scala.collection.Iterable on this instance.- parameters
The properties controlling subsequent traversals.
- Annotations
- @inline()
- final def outerElemTraverser(implicit parameters: Parameters = Parameters()): OuterElemTraverser
Instantiates an OuterElemTraverser which extends
scala.collection.Iterable
with elements of typeOuterElem
and sets itsroot
to this node.Instantiates an OuterElemTraverser which extends
scala.collection.Iterable
with elements of typeOuterElem
and sets itsroot
to this node. To start a traversal call one of the graph traversal methods or any appropriate method inherited from scala.collection.Iterable on this instance.- parameters
The properties controlling subsequent traversals.
- Annotations
- @inline()
- final def outerNodeDownUpTraverser(implicit parameters: Parameters = Parameters()): OuterNodeDownUpTraverser
Instantiates an OuterNodeDownUpTraverser which extends
scala.collection.Iterable
with elements of type(Boolean, N)
and sets itsroot
to this node.Instantiates an OuterNodeDownUpTraverser which extends
scala.collection.Iterable
with elements of type(Boolean, N)
and sets itsroot
to this node. To start a traversal call one of the graph traversal methods or any appropriate method inherited from scala.collection.Iterable on this instance.- parameters
The properties controlling subsequent traversals.
- Annotations
- @inline()
- final def outerNodeTraverser(implicit parameters: Parameters = Parameters()): OuterNodeTraverser
Instantiates an OuterNodeTraverser which extends
scala.collection.Iterable
with elements of typeN
and sets itsroot
to this node.Instantiates an OuterNodeTraverser which extends
scala.collection.Iterable
with elements of typeN
and sets itsroot
to this node. To start a traversal call one of the graph traversal methods or any appropriate method inherited from scala.collection.Iterable on this instance.- parameters
The properties controlling subsequent traversals.
- Annotations
- @inline()
- def partOfCycle[U](implicit visitor: (NodeT) => 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 forkind
,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
orNone
if either- there exists no cycle containing
root
or - there exists such a cycle but due to withSubgraph settings this path was out of scope.
- there exists no cycle containing
- Implicit
- This member is added by an implicit conversion from TraverserInnerNode toTraverserMethods[NodeT, InnerNodeTraverser] performed by method toDefaultTraverser in scalax.collection.GraphTraversal.TraverserInnerNode.
- Definition Classes
- TraverserMethods
- final def pathTo[U](potentialSuccessor: NodeT)(implicit visitor: (NodeT) => U = empty): Option[Path]
Finds a path from
root
topotentialSuccessor
considering all traversal properties passed to the traverser factory method like scalax.collection.GraphTraversal#innerNodeTraverser or altered by anywith*
method.Finds a path from
root
topotentialSuccessor
considering all traversal properties passed to the traverser factory method like scalax.collection.GraphTraversal#innerNodeTraverser or altered by anywith*
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
orNone
if either- there is no node with
pred
or - there exists no path to such a node
- there is no node with
- Implicit
- This member is added by an implicit conversion from TraverserInnerNode toTraverserMethods[NodeT, InnerNodeTraverser] performed by method toDefaultTraverser in scalax.collection.GraphTraversal.TraverserInnerNode.
- Definition Classes
- TraverserMethods
- def pathUntil[U](pred: GraphTraversal.NodePredicate)(implicit visitor: (NodeT) => U = empty): Option[Path]
Finds a path from
root
to a successor ofroot
for whichpred
holds considering all traversal properties passed to the traverser factory method like scalax.collection.GraphTraversal#innerNodeTraverser or altered by anywith*
method.Finds a path from
root
to a successor ofroot
for whichpred
holds considering all traversal properties passed to the traverser factory method like scalax.collection.GraphTraversal#innerNodeTraverser or altered by anywith*
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
orNone
if either- there is no node with
pred
or - there exists no path to such a node or
- there exists a path to such a node but due to withSubgraph settings this path was out of scope.
- there is no node with
- Implicit
- This member is added by an implicit conversion from TraverserInnerNode toTraverserMethods[NodeT, InnerNodeTraverser] performed by method toDefaultTraverser in scalax.collection.GraphTraversal.TraverserInnerNode.
- Definition Classes
- TraverserMethods
- def root: NodeT
- Implicit
- This member is added by an implicit conversion from TraverserInnerNode toTraverserMethods[NodeT, InnerNodeTraverser] performed by method toDefaultTraverser in scalax.collection.GraphTraversal.TraverserInnerNode.
- Definition Classes
- TraverserMethods
- final def shortestPathTo[T](potentialSuccessor: NodeT, weight: (GraphTraversal.EdgeT) => T)(implicit arg0: Numeric[T]): Option[Path]
Finds the shortest path from
root
topotentialSuccessor
considering all traversal properties passed to the traverser factory method like scalax.collection.GraphTraversal#innerNodeTraverser or altered by anywith*
method.Finds the shortest path from
root
topotentialSuccessor
considering all traversal properties passed to the traverser factory method like scalax.collection.GraphTraversal#innerNodeTraverser or altered by anywith*
method. The calculation is based on the weight of the edges on the path. Edges have a default weight of1L
that can be overridden by custom edges. A weight function yielding any numeric type may also be passed toshortestPathTo
.- 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
orNone
if either- there exists no path to
potentialSuccessor
or - there exists a path to
potentialSuccessor
but due to withSubgraph settings this path was out of scope.
- there exists no path to
- Implicit
- This member is added by an implicit conversion from TraverserInnerNode toTraverserMethods[NodeT, InnerNodeTraverser] performed by method toDefaultTraverser in scalax.collection.GraphTraversal.TraverserInnerNode.
- Definition Classes
- TraverserMethods
- Annotations
- @inline()
- final def shortestPathTo[U](potentialSuccessor: NodeT)(implicit visitor: (NodeT) => U = empty): Option[Path]
Finds the shortest path from
root
topotentialSuccessor
considering all traversal properties passed to the traverser factory method like scalax.collection.GraphTraversal#innerNodeTraverser or altered by anywith*
method.Finds the shortest path from
root
topotentialSuccessor
considering all traversal properties passed to the traverser factory method like scalax.collection.GraphTraversal#innerNodeTraverser or altered by anywith*
method. The calculation is based on the weight of the edges on the path. Edges have a default weight of1L
that can be overridden by custom edges. A weight function yielding any numeric type may also be passed toshortestPathTo
.- 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
orNone
if either- there exists no path to
potentialSuccessor
or - there exists a path to
potentialSuccessor
but due to withSubgraph settings this path was out of scope.
- there exists no path to
- Implicit
- This member is added by an implicit conversion from TraverserInnerNode toTraverserMethods[NodeT, InnerNodeTraverser] performed by method toDefaultTraverser in scalax.collection.GraphTraversal.TraverserInnerNode.
- Definition Classes
- TraverserMethods
- Annotations
- @inline()
- def shortestPathTo[T, U](potentialSuccessor: NodeT, weight: (GraphTraversal.EdgeT) => T, visitor: (NodeT) => U)(implicit arg0: Numeric[T]): Option[Path]
Finds the shortest path from
root
topotentialSuccessor
considering all traversal properties passed to the traverser factory method like scalax.collection.GraphTraversal#innerNodeTraverser or altered by anywith*
method.Finds the shortest path from
root
topotentialSuccessor
considering all traversal properties passed to the traverser factory method like scalax.collection.GraphTraversal#innerNodeTraverser or altered by anywith*
method. The calculation is based on the weight of the edges on the path. Edges have a default weight of1L
that can be overridden by custom edges. A weight function yielding any numeric type may also be passed toshortestPathTo
.- 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
orNone
if either- there exists no path to
potentialSuccessor
or - there exists a path to
potentialSuccessor
but due to withSubgraph settings this path was out of scope.
- there exists no path to
- Implicit
- This member is added by an implicit conversion from TraverserInnerNode toTraverserMethods[NodeT, InnerNodeTraverser] performed by method toDefaultTraverser in scalax.collection.GraphTraversal.TraverserInnerNode.
- Definition Classes
- TraverserMethods
- def strongComponents[U](implicit visitor: (NodeT) => 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 ofFluentProperties
.- visitor
Function to be called for each inner node or inner edge visited during the search.
- Implicit
- This member is added by an implicit conversion from TraverserInnerNode toTraverserMethods[NodeT, InnerNodeTraverser] performed by method toDefaultTraverser in scalax.collection.GraphTraversal.TraverserInnerNode.
- Definition Classes
- TraverserMethods
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def toInnerElemTraverser(root: NodeT): InnerElemTraverser
- Implicit
- This member is added by an implicit conversion from TraverserInnerNode toTraverserMethods[NodeT, InnerNodeTraverser] performed by method toDefaultTraverser in scalax.collection.GraphTraversal.TraverserInnerNode.
- Definition Classes
- FluentProperties
- def toString(): String
- Definition Classes
- BaseInnerNode → AnyRef → Any
- 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 ofFluentProperties
.- ignorePredecessors
If
true
, the topological sort will be partial in that it will only include successors ofroot
.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.
- Implicit
- This member is added by an implicit conversion from TraverserInnerNode toTraverserMethods[NodeT, InnerNodeTraverser] performed by method toDefaultTraverser in scalax.collection.GraphTraversal.TraverserInnerNode.
- Definition Classes
- TraverserMethods
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def weakComponent[U](implicit visitor: (NodeT) => 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 ofFluentProperties
.- visitor
Function to be called for each inner node or inner edge visited during the search.
- Implicit
- This member is added by an implicit conversion from TraverserInnerNode toTraverserMethods[NodeT, InnerNodeTraverser] performed by method toDefaultTraverser in scalax.collection.GraphTraversal.TraverserInnerNode.
- Definition Classes
- TraverserMethods
- final def withDirection(direction: Direction): InnerNodeTraverser
Creates a new FluentProperties based on
this
except for an updateddirection
.Creates a new FluentProperties based on
this
except for an updateddirection
. Note that methods returning a Cycle or Path accept onlySuccessors
.- Implicit
- This member is added by an implicit conversion from TraverserInnerNode toTraverserMethods[NodeT, InnerNodeTraverser] performed by method toDefaultTraverser in scalax.collection.GraphTraversal.TraverserInnerNode.
- Definition Classes
- FluentProperties
- final def withKind(kind: Kind): InnerNodeTraverser
Creates a new FluentProperties based on
this
except for an updatedkind
.Creates a new FluentProperties based on
this
except for an updatedkind
.- Implicit
- This member is added by an implicit conversion from TraverserInnerNode toTraverserMethods[NodeT, InnerNodeTraverser] performed by method toDefaultTraverser in scalax.collection.GraphTraversal.TraverserInnerNode.
- Definition Classes
- FluentProperties
- final def withMaxDepth(maxDepth: Int): InnerNodeTraverser
Creates a new FluentProperties based on
this
except for an updatedmaxDepth
.Creates a new FluentProperties based on
this
except for an updatedmaxDepth
.- Implicit
- This member is added by an implicit conversion from TraverserInnerNode toTraverserMethods[NodeT, InnerNodeTraverser] performed by method toDefaultTraverser in scalax.collection.GraphTraversal.TraverserInnerNode.
- Definition Classes
- FluentProperties
- final def withMaxWeight(max: Long): InnerNodeTraverser
Creates a new FluentProperties based on
this
except for an updatedmaxWeight
having the givenmax
and the default weight function returningedge.weight
.Creates a new FluentProperties based on
this
except for an updatedmaxWeight
having the givenmax
and the default weight function returningedge.weight
.- Implicit
- This member is added by an implicit conversion from TraverserInnerNode toTraverserMethods[NodeT, InnerNodeTraverser] performed by method toDefaultTraverser in scalax.collection.GraphTraversal.TraverserInnerNode.
- Definition Classes
- FluentProperties
- final def withMaxWeight[W](max: W, edgeWeight: (GraphTraversal.EdgeT) => W)(implicit arg0: Numeric[W]): InnerNodeTraverser
Creates a new FluentProperties based on
this
except for an updatedmaxWeight
having the givenmax
value and the given weight function.Creates a new FluentProperties based on
this
except for an updatedmaxWeight
having the givenmax
value and the given weight function.- Implicit
- This member is added by an implicit conversion from TraverserInnerNode toTraverserMethods[NodeT, InnerNodeTraverser] performed by method toDefaultTraverser in scalax.collection.GraphTraversal.TraverserInnerNode.
- Definition Classes
- FluentProperties
- def withMaxWeight(maxWeight: Option[Weight]): InnerNodeTraverser
Creates a new FluentProperties based on
this
except for an updatedmaxWeight
.Creates a new FluentProperties based on
this
except for an updatedmaxWeight
.- Implicit
- This member is added by an implicit conversion from TraverserInnerNode toTraverserMethods[NodeT, InnerNodeTraverser] performed by method toDefaultTraverser in scalax.collection.GraphTraversal.TraverserInnerNode.
- Definition Classes
- FluentProperties
- final def withOrdering(ordering: GraphTraversal.ElemOrdering): InnerNodeTraverser
Creates a new FluentProperties based on
this
except for an updatedordering
.Creates a new FluentProperties based on
this
except for an updatedordering
.- Implicit
- This member is added by an implicit conversion from TraverserInnerNode toTraverserMethods[NodeT, InnerNodeTraverser] performed by method toDefaultTraverser in scalax.collection.GraphTraversal.TraverserInnerNode.
- Definition Classes
- FluentProperties
- final def withParameters(parameters: Parameters): InnerNodeTraverser
Creates a new FluentProperties based on
this
except for an updatedparameters
.Creates a new FluentProperties based on
this
except for an updatedparameters
.- Implicit
- This member is added by an implicit conversion from TraverserInnerNode toTraverserMethods[NodeT, InnerNodeTraverser] performed by method toDefaultTraverser in scalax.collection.GraphTraversal.TraverserInnerNode.
- Definition Classes
- FluentProperties
- final def withRoot(root: NodeT): InnerNodeTraverser
Creates a new FluentProperties based on
this
except for an updatedroot
.Creates a new FluentProperties based on
this
except for an updatedroot
.- Implicit
- This member is added by an implicit conversion from TraverserInnerNode toTraverserMethods[NodeT, InnerNodeTraverser] performed by method toDefaultTraverser in scalax.collection.GraphTraversal.TraverserInnerNode.
- Definition Classes
- TraverserMethods
- final def withSubgraph(nodes: GraphTraversal.NodePredicate = anyNode, edges: GraphTraversal.EdgePredicate = anyEdge): InnerNodeTraverser
Creates a new FluentProperties based on
this
except for an updatedsubgraphNodes
and/orsubgraphEdges
.Creates a new FluentProperties based on
this
except for an updatedsubgraphNodes
and/orsubgraphEdges
.- Implicit
- This member is added by an implicit conversion from TraverserInnerNode toTraverserMethods[NodeT, InnerNodeTraverser] performed by method toDefaultTraverser in scalax.collection.GraphTraversal.TraverserInnerNode.
- Definition Classes
- FluentProperties
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from TraverserInnerNode toStringFormat[TraverserInnerNode] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)
instead ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- def →[B](y: B): (TraverserInnerNode, B)
- Implicit
- This member is added by an implicit conversion from TraverserInnerNode toArrowAssoc[TraverserInnerNode] 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.
Welcome to the Graph for Scala API reference. Some suggested entry points:
AnyGraph
immutable.Graph
and its inner nodesmutable.Graph
and its inner nodes.edges
package and its subpackageshyperedges
package and its subpackages.labeled edges
packagemultilabeled edges
packagelabeled hyperedges
packagemultilabeled hyperedges
packageordered labeled hyperedges
packageordered multilabeled hyperedges
objectgeneric
package.GraphTraversal
andTraverserInnerNode
.RandomGraph
.GraphGen
.