trait OuterElemTraverser extends TraverserMethods[OuterElem[N, E], OuterElemTraverser] with Traverser[OuterElem[N, E], OuterElemTraverser]
Controls the properties of outer-element graph traversals. To start a traversal call one of the graph traversal methods or any appropriate method inherited from scala.collection.Traversable on this instance.
- Alphabetic
- By Inheritance
- OuterElemTraverser
- Traverser
- Traversable
- GenTraversable
- GenericTraversableTemplate
- TraversableLike
- GenTraversableLike
- Parallelizable
- TraversableOnce
- GenTraversableOnce
- FilterMonadic
- HasNewBuilder
- Properties
- SubgraphProperties
- TraverserMethods
- FluentProperties
- AnyRef
- Any
- by anyToNode
- by CollectionsHaveToParArray
- by MonadOps
- by EdgeAssoc
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- by alternateImplicit
- Hide All
- Show All
- Public
- All
Type Members
-
type
Self = Traversable[OuterElem[N, E]]
- Attributes
- protected[this]
- Definition Classes
- TraversableLike
-
class
WithFilter extends FilterMonadic[A, Repr]
- Definition Classes
- TraversableLike
Abstract Value Members
-
abstract
def
apply[U](pred: GraphTraversal.NodeFilter = noNode, visitor: (OuterElem[N, E]) ⇒ U = empty): Option[NodeT]
- Attributes
- protected
- Definition Classes
- TraverserMethods
-
abstract
def
edgeVisitor[U](f: (OuterElem[N, E]) ⇒ U): (GraphTraversal.EdgeT) ⇒ U
- Attributes
- protected
- Definition Classes
- TraverserMethods
-
abstract
def
findCycle[U](implicit visitor: (OuterElem[N, E]) ⇒ 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
- Definition Classes
- TraverserMethods
-
abstract
def
newTraverser: (NodeT, Parameters, GraphTraversal.NodeFilter, GraphTraversal.EdgeFilter, GraphTraversal.ElemOrdering, Option[Weight]) ⇒ OuterElemTraverser
- Attributes
- protected
- Definition Classes
- FluentProperties
-
abstract
def
nodeVisitor[U](f: (OuterElem[N, E]) ⇒ U): (NodeT) ⇒ U
- Attributes
- protected
- Definition Classes
- TraverserMethods
-
abstract
def
ordering: GraphTraversal.ElemOrdering
If a
NodeOrdering
orEdgeOrdering
different fromNoOrdering
is supplied neighbor nodes will visited during the traversal according to this ordering.If a
NodeOrdering
orEdgeOrdering
different fromNoOrdering
is supplied neighbor nodes will visited during the traversal according to this ordering.- Definition Classes
- Properties
-
abstract
def
parameters: Parameters
The properties controlling subsequent traversals.
The properties controlling subsequent traversals.
- Definition Classes
- Properties
-
abstract
def
partOfCycle[U](implicit visitor: (OuterElem[N, E]) ⇒ 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
- Definition Classes
- TraverserMethods
-
abstract
def
pathUntil[U](pred: GraphTraversal.NodeFilter)(implicit visitor: (OuterElem[N, E]) ⇒ 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
- Definition Classes
- TraverserMethods
-
abstract
def
root: NodeT
The node where subsequent graph traversals start.
The node where subsequent graph traversals start.
- Definition Classes
- Properties
-
abstract
def
shortestPathTo[T, U](potentialSuccessor: NodeT, weight: (GraphTraversal.EdgeT) ⇒ T, visitor: (OuterElem[N, E]) ⇒ 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
- Definition Classes
- TraverserMethods
-
abstract
def
strongComponents[U](implicit visitor: (OuterElem[N, E]) ⇒ 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.
- Definition Classes
- TraverserMethods
-
abstract
def
subgraphEdges: GraphTraversal.EdgeFilter
Restricts subsequent graph traversals to walk only along edges that hold this predicate.
Restricts subsequent graph traversals to walk only along edges that hold this predicate.
- Definition Classes
- SubgraphProperties
-
abstract
def
subgraphNodes: GraphTraversal.NodeFilter
Restricts subsequent graph traversals to visit only nodes holding this predicate.
Restricts subsequent graph traversals to visit only nodes holding this predicate.
- Definition Classes
- SubgraphProperties
-
abstract
def
topologicalSort[U](ignorePredecessors: Boolean = false)(implicit visitor: (GraphTraversal.InnerElem) ⇒ U = empty): CycleNodeOrTopologicalOrder
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.
- Definition Classes
- TraverserMethods
-
abstract
def
weakComponent[U](implicit visitor: (OuterElem[N, E]) ⇒ 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.
- Definition Classes
- TraverserMethods
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 OuterElemTraverser to any2stringadd[OuterElemTraverser] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
++[B >: OuterElem[N, E], That](that: GenTraversableOnce[B])(implicit bf: CanBuildFrom[Traversable[OuterElem[N, E]], B, That]): That
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
++:[B >: OuterElem[N, E], That](that: Traversable[B])(implicit bf: CanBuildFrom[Traversable[OuterElem[N, E]], B, That]): That
- Definition Classes
- TraversableLike
-
def
++:[B >: OuterElem[N, E], That](that: TraversableOnce[B])(implicit bf: CanBuildFrom[Traversable[OuterElem[N, E]], B, That]): That
- Definition Classes
- TraversableLike
-
def
->[B](y: B): (OuterElemTraverser, B)
- Implicit
- This member is added by an implicit conversion from OuterElemTraverser to ArrowAssoc[OuterElemTraverser] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
-
def
/:[B](z: B)(op: (B, OuterElem[N, E]) ⇒ B): B
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
:\[B](z: B)(op: (OuterElem[N, E], B) ⇒ B): B
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
addString(b: StringBuilder): StringBuilder
- Definition Classes
- TraversableOnce
-
def
addString(b: StringBuilder, sep: String): StringBuilder
- Definition Classes
- TraversableOnce
-
def
addString(b: StringBuilder, start: String, sep: String, end: String): StringBuilder
- Definition Classes
- TraversableOnce
-
def
aggregate[B](z: ⇒ B)(seqop: (B, OuterElem[N, E]) ⇒ B, combop: (B, B) ⇒ B): B
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
def
collect[B, That](pf: PartialFunction[OuterElem[N, E], B])(implicit bf: CanBuildFrom[Traversable[OuterElem[N, E]], B, That]): That
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
collectFirst[B](pf: PartialFunction[OuterElem[N, E], B]): Option[B]
- Definition Classes
- TraversableOnce
-
def
companion: GenericCompanion[Traversable]
- Definition Classes
- Traversable → GenTraversable → GenericTraversableTemplate
-
def
copyToArray[B >: OuterElem[N, E]](xs: Array[B], start: Int, len: Int): Unit
- Definition Classes
- TraversableLike → TraversableOnce → GenTraversableOnce
-
def
copyToArray[B >: OuterElem[N, E]](xs: Array[B]): Unit
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
copyToArray[B >: OuterElem[N, E]](xs: Array[B], start: Int): Unit
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
copyToBuffer[B >: OuterElem[N, E]](dest: Buffer[B]): Unit
- Definition Classes
- TraversableOnce
-
def
count(p: (OuterElem[N, E]) ⇒ Boolean): Int
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
drop(n: Int): Traversable[OuterElem[N, E]]
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
dropWhile(p: (OuterElem[N, E]) ⇒ Boolean): Traversable[OuterElem[N, E]]
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
ensuring(cond: (OuterElemTraverser) ⇒ Boolean, msg: ⇒ Any): OuterElemTraverser
- Implicit
- This member is added by an implicit conversion from OuterElemTraverser to Ensuring[OuterElemTraverser] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (OuterElemTraverser) ⇒ Boolean): OuterElemTraverser
- Implicit
- This member is added by an implicit conversion from OuterElemTraverser to Ensuring[OuterElemTraverser] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): OuterElemTraverser
- Implicit
- This member is added by an implicit conversion from OuterElemTraverser to Ensuring[OuterElemTraverser] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): OuterElemTraverser
- Implicit
- This member is added by an implicit conversion from OuterElemTraverser to Ensuring[OuterElemTraverser] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
exists(p: (OuterElem[N, E]) ⇒ Boolean): Boolean
- Definition Classes
- TraversableLike → TraversableOnce → GenTraversableOnce
-
def
filter(p: (OuterElem[N, E]) ⇒ Boolean): Traversable[OuterElem[N, E]]
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
filterNot(p: (OuterElem[N, E]) ⇒ Boolean): Traversable[OuterElem[N, E]]
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
find(p: (OuterElem[N, E]) ⇒ Boolean): Option[OuterElem[N, E]]
- Definition Classes
- TraversableLike → TraversableOnce → GenTraversableOnce
-
final
def
findConnected[U](pred: GraphTraversal.NodeFilter)(implicit visitor: (OuterElem[N, E]) ⇒ 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
- Definition Classes
- TraverserMethods
-
final
def
findPredecessor[U](pred: GraphTraversal.NodeFilter)(implicit visitor: (OuterElem[N, E]) ⇒ 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
- Definition Classes
- TraverserMethods
-
final
def
findSuccessor[U](pred: GraphTraversal.NodeFilter)(implicit visitor: (OuterElem[N, E]) ⇒ 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
- Definition Classes
- TraverserMethods
-
def
flatMap[B, That](f: (OuterElem[N, E]) ⇒ GenTraversableOnce[B])(implicit bf: CanBuildFrom[Traversable[OuterElem[N, E]], B, That]): That
- Definition Classes
- TraversableLike → GenTraversableLike → FilterMonadic
-
def
flatten[B](implicit asTraversable: (OuterElem[N, E]) ⇒ GenTraversableOnce[B]): Traversable[B]
- Definition Classes
- GenericTraversableTemplate
-
def
fold[A1 >: OuterElem[N, E]](z: A1)(op: (A1, A1) ⇒ A1): A1
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
foldLeft[B](z: B)(op: (B, OuterElem[N, E]) ⇒ B): B
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
foldRight[B](z: B)(op: (OuterElem[N, E], B) ⇒ B): B
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
forall(p: (OuterElem[N, E]) ⇒ Boolean): Boolean
- Definition Classes
- TraversableLike → TraversableOnce → GenTraversableOnce
-
def
foreach[U](f: (OuterElem[N, E]) ⇒ U): Unit
- Definition Classes
- Traverser → GenericTraversableTemplate → TraversableLike → GenTraversableLike → TraversableOnce → GenTraversableOnce → FilterMonadic
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from OuterElemTraverser to StringFormat[OuterElemTraverser] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
-
def
genericBuilder[B]: Builder[B, Traversable[B]]
- Definition Classes
- GenericTraversableTemplate
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
groupBy[K](f: (OuterElem[N, E]) ⇒ K): Map[K, Traversable[OuterElem[N, E]]]
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
hasDefiniteSize: Boolean
- Definition Classes
- TraversableLike → TraversableOnce → GenTraversableOnce
-
final
def
hasPredecessor[U](potentialPredecessor: NodeT)(implicit visitor: (OuterElem[N, E]) ⇒ 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.
- Definition Classes
- TraverserMethods
- Annotations
- @inline()
-
final
def
hasSuccessor[U](potentialSuccessor: NodeT)(implicit visitor: (OuterElem[N, E]) ⇒ 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.
- Definition Classes
- TraverserMethods
- Annotations
- @inline()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
head: OuterElem[N, E]
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
headOption: Option[OuterElem[N, E]]
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
init: Traversable[OuterElem[N, E]]
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
inits: Iterator[Traversable[OuterElem[N, E]]]
- Definition Classes
- TraversableLike
-
final
def
isConnectedWith[U](potentialConnected: NodeT)(implicit visitor: (OuterElem[N, E]) ⇒ 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.
- Definition Classes
- TraverserMethods
- Annotations
- @inline()
-
def
isDefined: Boolean
- Implicit
- This member is added by an implicit conversion from OuterElemTraverser to OuterNode[OuterElemTraverser] performed by method anyToNode in scalax.collection.GraphPredef.
- Definition Classes
- Param
-
def
isEdge: Boolean
- Implicit
- This member is added by an implicit conversion from OuterElemTraverser to OuterNode[OuterElemTraverser] performed by method anyToNode in scalax.collection.GraphPredef.
- Definition Classes
- NodeParam
-
def
isEmpty: Boolean
- Definition Classes
- TraversableLike → TraversableOnce → GenTraversableOnce
-
def
isIn: Boolean
- Implicit
- This member is added by an implicit conversion from OuterElemTraverser to OuterNode[OuterElemTraverser] performed by method anyToNode in scalax.collection.GraphPredef.
- Definition Classes
- InParam → Param
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
isNode: Boolean
- Implicit
- This member is added by an implicit conversion from OuterElemTraverser to OuterNode[OuterElemTraverser] performed by method anyToNode in scalax.collection.GraphPredef.
- Definition Classes
- NodeParam
-
def
isOut: Boolean
- Implicit
- This member is added by an implicit conversion from OuterElemTraverser to OuterNode[OuterElemTraverser] performed by method anyToNode in scalax.collection.GraphPredef.
- Definition Classes
- InParam → Param
-
final
def
isPredecessorOf[U](potentialSuccessor: NodeT)(implicit visitor: (OuterElem[N, E]) ⇒ U = empty): Boolean
Same as
hasSuccessor
.Same as
hasSuccessor
.- Definition Classes
- TraverserMethods
- Annotations
- @inline()
-
final
def
isSuccessorOf[U](potentialPredecessor: NodeT)(implicit visitor: (OuterElem[N, E]) ⇒ U = empty): Boolean
Same as
hasPredecessor
.Same as
hasPredecessor
.- Definition Classes
- TraverserMethods
- Annotations
- @inline()
-
final
def
isTraversableAgain: Boolean
- Definition Classes
- TraversableLike → GenTraversableLike → GenTraversableOnce
-
def
last: OuterElem[N, E]
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
lastOption: Option[OuterElem[N, E]]
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
map[B, That](f: (OuterElem[N, E]) ⇒ B)(implicit bf: CanBuildFrom[Traversable[OuterElem[N, E]], B, That]): That
- Definition Classes
- TraversableLike → GenTraversableLike → FilterMonadic
-
def
max[B >: OuterElem[N, E]](implicit cmp: Ordering[B]): OuterElem[N, E]
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
maxBy[B](f: (OuterElem[N, E]) ⇒ B)(implicit cmp: Ordering[B]): OuterElem[N, E]
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
maxWeight: Option[Weight]
An optional maximum weight that limits the scope of the traversal or search.
An optional maximum weight that limits the scope of the traversal or search. If defined and the sum of edge weights between the root of the traversal and a node exceeds the given maximum, that node will no more be visited.
- Definition Classes
- Properties
-
def
min[B >: OuterElem[N, E]](implicit cmp: Ordering[B]): OuterElem[N, E]
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
minBy[B](f: (OuterElem[N, E]) ⇒ B)(implicit cmp: Ordering[B]): OuterElem[N, E]
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
mkString: String
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
mkString(sep: String): String
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
mkString(start: String, sep: String, end: String): String
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
val
n1: OuterElemTraverser
- Implicit
- This member is added by an implicit conversion from OuterElemTraverser to EdgeAssoc[OuterElemTraverser] performed by method EdgeAssoc in scalax.collection.GraphPredef.
- Definition Classes
- EdgeAssoc
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
newBuilder: Builder[OuterElem[N, E], Traversable[OuterElem[N, E]]]
- Attributes
- protected[this]
- Definition Classes
- GenericTraversableTemplate → HasNewBuilder
-
def
nonEmpty: Boolean
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
par: ParIterable[OuterElem[N, E]]
- Definition Classes
- Parallelizable
-
def
parCombiner: Combiner[OuterElem[N, E], ParIterable[OuterElem[N, E]]]
- Attributes
- protected[this]
- Definition Classes
- TraversableLike → Parallelizable
-
def
partition(p: (OuterElem[N, E]) ⇒ Boolean): (Traversable[OuterElem[N, E]], Traversable[OuterElem[N, E]])
- Definition Classes
- TraversableLike → GenTraversableLike
-
final
def
pathTo[U](potentialSuccessor: NodeT)(implicit visitor: (OuterElem[N, E]) ⇒ 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
- Definition Classes
- TraverserMethods
-
def
product[B >: OuterElem[N, E]](implicit num: Numeric[B]): B
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
reduce[A1 >: OuterElem[N, E]](op: (A1, A1) ⇒ A1): A1
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
reduceLeft[B >: OuterElem[N, E]](op: (B, OuterElem[N, E]) ⇒ B): B
- Definition Classes
- TraversableOnce
-
def
reduceLeftOption[B >: OuterElem[N, E]](op: (B, OuterElem[N, E]) ⇒ B): Option[B]
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
reduceOption[A1 >: OuterElem[N, E]](op: (A1, A1) ⇒ A1): Option[A1]
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
reduceRight[B >: OuterElem[N, E]](op: (OuterElem[N, E], B) ⇒ B): B
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
reduceRightOption[B >: OuterElem[N, E]](op: (OuterElem[N, E], B) ⇒ B): Option[B]
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
repr: Traversable[OuterElem[N, E]]
- Definition Classes
- TraversableLike → GenTraversableLike
-
final
def
requireSuccessors[A](block: ⇒ A): A
- Attributes
- protected
- Definition Classes
- TraverserMethods
-
def
reversed: List[OuterElem[N, E]]
- Attributes
- protected[this]
- Definition Classes
- TraversableOnce
-
def
scan[B >: OuterElem[N, E], That](z: B)(op: (B, B) ⇒ B)(implicit cbf: CanBuildFrom[Traversable[OuterElem[N, E]], B, That]): That
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
scanLeft[B, That](z: B)(op: (B, OuterElem[N, E]) ⇒ B)(implicit bf: CanBuildFrom[Traversable[OuterElem[N, E]], B, That]): That
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
scanRight[B, That](z: B)(op: (OuterElem[N, E], B) ⇒ B)(implicit bf: CanBuildFrom[Traversable[OuterElem[N, E]], B, That]): That
- Definition Classes
- TraversableLike → GenTraversableLike
- Annotations
- @migration
- Migration
(Changed in version 2.9.0) The behavior of
scanRight
has changed. The previous behavior can be reproduced with scanRight.reverse.
-
def
seq: Traversable[OuterElem[N, E]]
- Definition Classes
- Traversable → GenTraversable → Parallelizable → TraversableOnce → GenTraversableOnce
-
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
- Definition Classes
- TraverserMethods
- Annotations
- @inline()
-
final
def
shortestPathTo[U](potentialSuccessor: NodeT)(implicit visitor: (OuterElem[N, E]) ⇒ 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
- Definition Classes
- TraverserMethods
- Annotations
- @inline()
-
def
size: Int
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
sizeHintIfCheap: Int
- Attributes
- protected[scala.collection]
- Definition Classes
- GenTraversableOnce
-
def
slice(from: Int, until: Int): Traversable[OuterElem[N, E]]
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
span(p: (OuterElem[N, E]) ⇒ Boolean): (Traversable[OuterElem[N, E]], Traversable[OuterElem[N, E]])
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
splitAt(n: Int): (Traversable[OuterElem[N, E]], Traversable[OuterElem[N, E]])
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
stringPrefix: String
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
sum[B >: OuterElem[N, E]](implicit num: Numeric[B]): B
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
tail: Traversable[OuterElem[N, E]]
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
tails: Iterator[Traversable[OuterElem[N, E]]]
- Definition Classes
- TraversableLike
-
def
take(n: Int): Traversable[OuterElem[N, E]]
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
takeWhile(p: (OuterElem[N, E]) ⇒ Boolean): Traversable[OuterElem[N, E]]
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
thisCollection: Traversable[OuterElem[N, E]]
- Attributes
- protected[this]
- Definition Classes
- TraversableLike
-
def
to[Col[_]](implicit cbf: CanBuildFrom[Nothing, OuterElem[N, E], Col[OuterElem[N, E]]]): Col[OuterElem[N, E]]
- Definition Classes
- TraversableLike → TraversableOnce → GenTraversableOnce
-
def
toArray[B >: OuterElem[N, E]](implicit arg0: ClassTag[B]): Array[B]
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
toBuffer[B >: OuterElem[N, E]]: Buffer[B]
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
toCollection(repr: Traversable[OuterElem[N, E]]): Traversable[OuterElem[N, E]]
- Attributes
- protected[this]
- Definition Classes
- TraversableLike
-
final
def
toGraph: Graph[N, E]
Completes a traversal and creates a new connected graph populated with the elements visited.
Completes a traversal and creates a new connected graph populated with the elements visited.
- Definition Classes
- Traverser
-
def
toIndexedSeq: IndexedSeq[OuterElem[N, E]]
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
final
def
toInnerElemTraverser(root: NodeT): InnerElemTraverser
- Definition Classes
- FluentProperties
-
def
toIterable: Iterable[OuterElem[N, E]]
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
toIterator: Iterator[OuterElem[N, E]]
- Definition Classes
- TraversableLike → GenTraversableOnce
-
def
toList: List[OuterElem[N, E]]
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
toMap[T, U](implicit ev: <:<[OuterElem[N, E], (T, U)]): Map[T, U]
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
toParArray: ParArray[T]
- Implicit
- This member is added by an implicit conversion from OuterElemTraverser to CollectionsHaveToParArray[OuterElemTraverser, T] performed by method CollectionsHaveToParArray in scala.collection.parallel. This conversion will take place only if an implicit value of type (OuterElemTraverser) ⇒ GenTraversableOnce[T] is in scope.
- Definition Classes
- CollectionsHaveToParArray
-
def
toSeq: Seq[OuterElem[N, E]]
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
toSet[B >: OuterElem[N, E]]: Set[B]
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
toStream: Stream[OuterElem[N, E]]
- Definition Classes
- TraversableLike → GenTraversableOnce
-
def
toString(): String
- Definition Classes
- TraversableLike → Any
-
def
toTraversable: Traversable[OuterElem[N, E]]
- Definition Classes
- TraversableLike → TraversableOnce → GenTraversableOnce
- Annotations
- @deprecatedOverriding( ... , "2.11.0" )
-
def
toVector: Vector[OuterElem[N, E]]
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
transpose[B](implicit asTraversable: (OuterElem[N, E]) ⇒ GenTraversableOnce[B]): Traversable[Traversable[B]]
- Definition Classes
- GenericTraversableTemplate
- Annotations
- @migration
- Migration
(Changed in version 2.9.0)
transpose
throws anIllegalArgumentException
if collections are not uniformly sized.
-
def
unzip[A1, A2](implicit asPair: (OuterElem[N, E]) ⇒ (A1, A2)): (Traversable[A1], Traversable[A2])
- Definition Classes
- GenericTraversableTemplate
-
def
unzip3[A1, A2, A3](implicit asTriple: (OuterElem[N, E]) ⇒ (A1, A2, A3)): (Traversable[A1], Traversable[A2], Traversable[A3])
- Definition Classes
- GenericTraversableTemplate
-
val
value: OuterElemTraverser
- Implicit
- This member is added by an implicit conversion from OuterElemTraverser to OuterNode[OuterElemTraverser] performed by method anyToNode in scalax.collection.GraphPredef.
- Definition Classes
- OuterNode → NodeParam
-
def
view(from: Int, until: Int): TraversableView[OuterElem[N, E], Traversable[OuterElem[N, E]]]
- Definition Classes
- TraversableLike
-
def
view: TraversableView[OuterElem[N, E], Traversable[OuterElem[N, E]]]
- Definition Classes
- TraversableLike
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
withDirection(direction: Direction): OuterElemTraverser
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
.- Definition Classes
- FluentProperties
-
def
withFilter(p: (OuterElem[N, E]) ⇒ Boolean): FilterMonadic[OuterElem[N, E], Traversable[OuterElem[N, E]]]
- Definition Classes
- TraversableLike → FilterMonadic
-
final
def
withKind(kind: Kind): OuterElemTraverser
Creates a new FluentProperties based on
this
except for an updatedkind
.Creates a new FluentProperties based on
this
except for an updatedkind
.- Definition Classes
- FluentProperties
-
final
def
withMaxDepth(maxDepth: Int): OuterElemTraverser
Creates a new FluentProperties based on
this
except for an updatedmaxDepth
.Creates a new FluentProperties based on
this
except for an updatedmaxDepth
.- Definition Classes
- FluentProperties
-
final
def
withMaxWeight(max: Long): OuterElemTraverser
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
.- Definition Classes
- FluentProperties
-
final
def
withMaxWeight[W](max: W, edgeWeight: (GraphTraversal.EdgeT) ⇒ W)(implicit arg0: Numeric[W]): OuterElemTraverser
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.- Definition Classes
- FluentProperties
-
def
withMaxWeight(maxWeight: Option[Weight]): OuterElemTraverser
Creates a new FluentProperties based on
this
except for an updatedmaxWeight
.Creates a new FluentProperties based on
this
except for an updatedmaxWeight
.- Definition Classes
- FluentProperties
-
final
def
withOrdering(ordering: GraphTraversal.ElemOrdering): OuterElemTraverser
Creates a new FluentProperties based on
this
except for an updatedordering
.Creates a new FluentProperties based on
this
except for an updatedordering
.- Definition Classes
- FluentProperties
-
final
def
withParameters(parameters: Parameters): OuterElemTraverser
Creates a new FluentProperties based on
this
except for an updatedparameters
.Creates a new FluentProperties based on
this
except for an updatedparameters
.- Definition Classes
- FluentProperties
-
final
def
withRoot(root: NodeT): OuterElemTraverser
Creates a new FluentProperties based on
this
except for an updatedroot
.Creates a new FluentProperties based on
this
except for an updatedroot
.- Definition Classes
- TraverserMethods
-
final
def
withSubgraph(nodes: GraphTraversal.NodeFilter = anyNode, edges: GraphTraversal.EdgeFilter = anyEdge): OuterElemTraverser
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
.- Definition Classes
- FluentProperties
-
def
~[N >: N1](n2: N): UnDiEdge[N]
- Implicit
- This member is added by an implicit conversion from OuterElemTraverser to EdgeAssoc[OuterElemTraverser] performed by method EdgeAssoc in scalax.collection.GraphPredef.
- Definition Classes
- EdgeAssoc
- Annotations
- @inline()
-
def
~>[N >: N1](n2: N): DiEdge[N]
- Implicit
- This member is added by an implicit conversion from OuterElemTraverser to EdgeAssoc[OuterElemTraverser] performed by method EdgeAssoc in scalax.collection.GraphPredef.
- Definition Classes
- EdgeAssoc
- Annotations
- @inline()
-
def
→[B](y: B): (OuterElemTraverser, B)
- Implicit
- This member is added by an implicit conversion from OuterElemTraverser to ArrowAssoc[OuterElemTraverser] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
Shadowed Implicit Value Members
-
def
filter(p: (OuterElem[N, E]) ⇒ Boolean): TraversableOnce[OuterElem[N, E]]
- Implicit
- This member is added by an implicit conversion from OuterElemTraverser to MonadOps[OuterElem[N, E]] performed by method MonadOps in scala.collection.TraversableOnce.
- 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:(outerElemTraverser: MonadOps[OuterElem[N, E]]).filter(p)
- Definition Classes
- MonadOps
-
def
flatMap[B](f: (OuterElem[N, E]) ⇒ GenTraversableOnce[B]): TraversableOnce[B]
- Implicit
- This member is added by an implicit conversion from OuterElemTraverser to MonadOps[OuterElem[N, E]] performed by method MonadOps in scala.collection.TraversableOnce.
- 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:(outerElemTraverser: MonadOps[OuterElem[N, E]]).flatMap(f)
- Definition Classes
- MonadOps
-
def
map[B](f: (OuterElem[N, E]) ⇒ B): TraversableOnce[B]
- Implicit
- This member is added by an implicit conversion from OuterElemTraverser to MonadOps[OuterElem[N, E]] performed by method MonadOps in scala.collection.TraversableOnce.
- 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:(outerElemTraverser: MonadOps[OuterElem[N, E]]).map(f)
- Definition Classes
- MonadOps
-
def
stringPrefix: String
- Implicit
- This member is added by an implicit conversion from OuterElemTraverser to OuterNode[OuterElemTraverser] 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:(outerElemTraverser: OuterNode[OuterElemTraverser]).stringPrefix
- Definition Classes
- NodeParam
-
def
toString(): String
- Implicit
- This member is added by an implicit conversion from OuterElemTraverser to OuterNode[OuterElemTraverser] 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:(outerElemTraverser: OuterNode[OuterElemTraverser]).toString()
- Definition Classes
- NodeParam → AnyRef → Any
-
def
withFilter(p: (OuterElem[N, E]) ⇒ Boolean): Iterator[OuterElem[N, E]]
- Implicit
- This member is added by an implicit conversion from OuterElemTraverser to MonadOps[OuterElem[N, E]] performed by method MonadOps in scala.collection.TraversableOnce.
- 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:(outerElemTraverser: MonadOps[OuterElem[N, E]]).withFilter(p)
- Definition Classes
- MonadOps
Welcome to the Graph for Scala API reference. Some suggested navigation entry points:
Graph
mutable.Graph
and its inner nodes.GraphEdge
objectedge
packageGraphPredef
object andImplicits
object.GraphTraversal
andTraverserInnerNode
.RandomGraph
.GraphGen
.