Graph Core
2.0.3
API
Generated with
Graph Core/scalax.collection/GraphTraversal/OuterElemTraverser

OuterElemTraverser

scalax.collection.GraphTraversal.OuterElemTraverser
trait OuterElemTraverser extends Traverser[OuterElem, 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.Iterable on this instance.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Show all
Known subtypes

Members list

Value members

Concrete methods

final protected def sizeHint: Int

Inherited methods

final def ++[B >: OuterElem](suffix: IterableOnce[B]): Iterable[B]

Attributes

Inherited from:
IterableOps
final override def addString(b: StringBuilder, start: String, sep: String, end: String): b.type

Attributes

Definition Classes
Inherited from:
ForeachBasedDetachingIterable
final def addString(b: StringBuilder): b.type

Attributes

Inherited from:
IterableOnceOps
final def addString(b: StringBuilder, sep: String): b.type

Attributes

Inherited from:
IterableOnceOps
protected def autarkicForeach[U](f: OuterElem => U): Unit

Attributes

Inherited from:
Traverser
final override def collect[B](pf: PartialFunction[OuterElem, B]): Iterable[B]

Attributes

Definition Classes
Inherited from:
ForeachBasedDetachingIterable
final override def collectFirst[B](pf: PartialFunction[OuterElem, B]): Option[B]

Attributes

Definition Classes
Inherited from:
ForeachBasedDetachingIterable
def concat[B >: OuterElem](suffix: IterableOnce[B]): Iterable[B]

Attributes

Inherited from:
IterableOps
def copyToArray[B >: OuterElem](xs: Array[B], start: Int, len: Int): Int

Attributes

Inherited from:
IterableOnceOps
def copyToArray[B >: OuterElem](xs: Array[B], start: Int): Int

Attributes

Inherited from:
IterableOnceOps
def copyToArray[B >: OuterElem](xs: Array[B]): Int

Attributes

Inherited from:
IterableOnceOps
def corresponds[B](that: IterableOnce[B])(p: (OuterElem, B) => Boolean): Boolean

Attributes

Inherited from:
IterableOnceOps
final override def count(p: OuterElem => Boolean): Int

Attributes

Definition Classes
Inherited from:
ForeachBasedDetachingIterable
final override def drop(n: Int): Vector[OuterElem]

Attributes

Definition Classes
Inherited from:
ForeachBasedDetachingIterable
def dropRight(n: Int): Iterable[OuterElem]

Attributes

Inherited from:
IterableOps
final override def dropWhile(p: OuterElem => Boolean): Vector[OuterElem]

Attributes

Definition Classes
Inherited from:
ForeachBasedDetachingIterable
override def empty: Iterable[OuterElem]

Attributes

Definition Classes
Inherited from:
IterableFactoryDefaults
final override def exists(p: OuterElem => Boolean): Boolean

Attributes

Definition Classes
Inherited from:
ForeachBasedDetachingIterable
final override def filter(p: OuterElem => Boolean): Vector[OuterElem]

Attributes

Definition Classes
Inherited from:
ForeachBasedDetachingIterable
final override def filterNot(p: OuterElem => Boolean): Vector[OuterElem]

Attributes

Definition Classes
Inherited from:
ForeachBasedDetachingIterable
final override def find(p: OuterElem => Boolean): Option[OuterElem]

Attributes

Definition Classes
Inherited from:
ForeachBasedDetachingIterable
final def findConnected[U](pred: NodePredicate)(implicit visitor: OuterElem => U): Option[NodeT]

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

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

Value parameters

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.

Attributes

Returns

A node with the predicate pred or None if either a. there is no node with pred or a. there exists no connection to such a node or a. there exists a connection to such a node but due to withSubgraph settings this path was out of scope.

Inherited from:
TraverserMethods (hidden)
final def findPredecessor[U](pred: NodePredicate)(implicit visitor: OuterElem => U): Option[NodeT]

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

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

Value parameters

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.

Attributes

Returns

A node with the predicate pred or None if either a. there is no node with pred or a. there exists no path from such a node to this node or a. there exists a path from such a node to root but due to withSubgraph settings this path was out of scope.

Inherited from:
TraverserMethods (hidden)
final def findSuccessor[U](pred: NodePredicate)(implicit visitor: OuterElem => U): Option[NodeT]

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

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

Value parameters

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.

Attributes

Returns

A node with the predicate pred or None if either a. there is no node with pred or a. there exists no path to such a node or a. there exists a path to such a node but due to withSubgraph settings this path was out of scope.

Inherited from:
TraverserMethods (hidden)
final override def flatMap[B](f: OuterElem => IterableOnce[B]): Iterable[B]

Attributes

Definition Classes
Inherited from:
ForeachBasedDetachingIterable
def flatten[B](implicit asIterable: OuterElem => IterableOnce[B]): Iterable[B]

Attributes

Inherited from:
IterableOps
def fold[A1 >: OuterElem](z: A1)(op: (A1, A1) => A1): A1

Attributes

Inherited from:
IterableOnceOps
final override def foldLeft[B](z: B)(op: (B, OuterElem) => B): B

Attributes

Definition Classes
Inherited from:
ForeachBasedDetachingIterable
def foldRight[B](z: B)(op: (OuterElem, B) => B): B

Attributes

Inherited from:
IterableOnceOps
final override def forall(p: OuterElem => Boolean): Boolean

Attributes

Definition Classes
Inherited from:
ForeachBasedDetachingIterable
final override def foreach[U](f: OuterElem => U): Unit

Attributes

Definition Classes
Inherited from:
ForeachBasedDetachingIterable
protected def fromSpecific(coll: IterableOnce[OuterElem]): Iterable[OuterElem]

Attributes

Inherited from:
IterableFactoryDefaults
def groupBy[K](f: OuterElem => K): Map[K, Iterable[OuterElem]]

Attributes

Inherited from:
IterableOps
def groupMap[K, B](key: OuterElem => K)(f: OuterElem => B): Map[K, Iterable[B]]

Attributes

Inherited from:
IterableOps
def groupMapReduce[K, B](key: OuterElem => K)(f: OuterElem => B)(reduce: (B, B) => B): Map[K, B]

Attributes

Inherited from:
IterableOps
def grouped(size: Int): Iterator[Iterable[OuterElem]]

Attributes

Inherited from:
IterableOps
final def hasPredecessor[U](potentialPredecessor: NodeT)(implicit visitor: OuterElem => U): Boolean

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

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

Value parameters

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.

Attributes

Returns

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

Inherited from:
TraverserMethods (hidden)
final def hasSuccessor[U](potentialSuccessor: NodeT)(implicit visitor: OuterElem => U): Boolean

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

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

Value parameters

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.

Attributes

Returns

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

Inherited from:
TraverserMethods (hidden)
final override def head: OuterElem

Attributes

Definition Classes
Inherited from:
ForeachBasedDetachingIterable
final override def headOption: Option[OuterElem]

Attributes

Definition Classes
Inherited from:
ForeachBasedDetachingIterable
def init: Iterable[OuterElem]

Attributes

Inherited from:
IterableOps
def inits: Iterator[Iterable[OuterElem]]

Attributes

Inherited from:
IterableOps
final def isConnectedWith[U](potentialConnected: NodeT)(implicit visitor: OuterElem => U): Boolean

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

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

Value parameters

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.

Attributes

Returns

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

Inherited from:
TraverserMethods (hidden)
final override def isEmpty: Boolean

Attributes

Definition Classes
Inherited from:
ForeachBasedDetachingIterable
final def isPredecessorOf[U](potentialSuccessor: NodeT)(implicit visitor: OuterElem => U): Boolean

Same as hasSuccessor.

Same as hasSuccessor.

Attributes

Inherited from:
TraverserMethods (hidden)
final def isSuccessorOf[U](potentialPredecessor: NodeT)(implicit visitor: OuterElem => U): Boolean

Same as hasPredecessor.

Same as hasPredecessor.

Attributes

Inherited from:
TraverserMethods (hidden)
override def isTraversableAgain: Boolean

Attributes

Definition Classes
Inherited from:
IterableOps
def iterator: Iterator[OuterElem]

Attributes

Inherited from:
ForeachBasedDetachingIterable
def knownSize: Int

Attributes

Inherited from:
IterableOnce
def last: OuterElem

Attributes

Inherited from:
IterableOps
def lastOption: Option[OuterElem]

Attributes

Inherited from:
IterableOps
def lazyZip[B](that: Iterable[B]): LazyZip2[OuterElem, B, Iterable.this.type]

Attributes

Inherited from:
Iterable
final override def map[B](f: OuterElem => B): Iterable[B]

Attributes

Definition Classes
Inherited from:
ForeachBasedDetachingIterable
final override def max[B >: OuterElem](implicit ord: Ordering[B]): OuterElem

Attributes

Definition Classes
Inherited from:
ForeachBasedDetachingIterable
final override def maxBy[B](f: OuterElem => B)(implicit cmp: Ordering[B]): OuterElem

Attributes

Definition Classes
Inherited from:
ForeachBasedDetachingIterable
final override def maxByOption[B](f: OuterElem => B)(implicit cmp: Ordering[B]): Option[OuterElem]

Attributes

Definition Classes
Inherited from:
ForeachBasedDetachingIterable
final override def maxOption[B >: OuterElem](implicit ord: Ordering[B]): Option[OuterElem]

Attributes

Definition Classes
Inherited from:
ForeachBasedDetachingIterable
def maxWeight: Option[Weight]

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.

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.

Attributes

Inherited from:
Properties (hidden)
final override def min[B >: OuterElem](implicit ord: Ordering[B]): OuterElem

Attributes

Definition Classes
Inherited from:
ForeachBasedDetachingIterable
final override def minBy[B](f: OuterElem => B)(implicit cmp: Ordering[B]): OuterElem

Attributes

Definition Classes
Inherited from:
ForeachBasedDetachingIterable
final override def minByOption[B](f: OuterElem => B)(implicit cmp: Ordering[B]): Option[OuterElem]

Attributes

Definition Classes
Inherited from:
ForeachBasedDetachingIterable
final override def minOption[B >: OuterElem](implicit ord: Ordering[B]): Option[OuterElem]

Attributes

Definition Classes
Inherited from:
ForeachBasedDetachingIterable
final def mkString: String

Attributes

Inherited from:
IterableOnceOps
final def mkString(sep: String): String

Attributes

Inherited from:
IterableOnceOps
final def mkString(start: String, sep: String, end: String): String

Attributes

Inherited from:
IterableOnceOps
protected def newSpecificBuilder: Builder[OuterElem, Iterable[OuterElem]]

Attributes

Inherited from:
IterableFactoryDefaults
def nonEmpty: Boolean

Attributes

Inherited from:
IterableOnceOps
final protected def nonOverflowingOrderMultipliedBy_2: Int

Attributes

Inherited from:
Traverser
def partition(p: OuterElem => Boolean): (Iterable[OuterElem], Iterable[OuterElem])

Attributes

Inherited from:
IterableOps
def partitionMap[A1, A2](f: OuterElem => Either[A1, A2]): (Iterable[A1], Iterable[A2])

Attributes

Inherited from:
IterableOps
final def pathTo[U](potentialSuccessor: NodeT)(implicit visitor: OuterElem => U): Option[Path]

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

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

Value parameters

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.

Attributes

Returns

A path to potentialSuccessor or None if either a. there is no node with pred or a. there exists no path to such a node

Inherited from:
TraverserMethods (hidden)
final override def product[B >: OuterElem](implicit num: Numeric[B]): B

Attributes

Definition Classes
Inherited from:
ForeachBasedDetachingIterable
final override def reduce[B >: OuterElem](op: (B, B) => B): B

Attributes

Definition Classes
Inherited from:
ForeachBasedDetachingIterable
final override def reduceLeft[B >: OuterElem](op: (B, OuterElem) => B): B

Attributes

Definition Classes
Inherited from:
ForeachBasedDetachingIterable
final override def reduceLeftOption[B >: OuterElem](op: (B, OuterElem) => B): Option[B]

Attributes

Definition Classes
Inherited from:
ForeachBasedDetachingIterable
final override def reduceOption[B >: OuterElem](op: (B, B) => B): Option[B]

Attributes

Definition Classes
Inherited from:
ForeachBasedDetachingIterable
def reduceRight[B >: OuterElem](op: (OuterElem, B) => B): B

Attributes

Inherited from:
IterableOnceOps
def reduceRightOption[B >: OuterElem](op: (OuterElem, B) => B): Option[B]

Attributes

Inherited from:
IterableOnceOps
final protected def requireSuccessors[A](block: => A): A

Attributes

Inherited from:
TraverserMethods (hidden)
protected def reversed: Iterable[OuterElem]

Attributes

Inherited from:
IterableOnceOps
def scan[B >: OuterElem](z: B)(op: (B, B) => B): Iterable[B]

Attributes

Inherited from:
IterableOps
final override def scanLeft[B](z: B)(op: (B, OuterElem) => B): Vector[B]

Attributes

Definition Classes
Inherited from:
ForeachBasedDetachingIterable
def scanRight[B](z: B)(op: (OuterElem, B) => B): Iterable[B]

Attributes

Inherited from:
IterableOps
final def shortestPathTo[T : Numeric](potentialSuccessor: NodeT, weight: EdgeT => T): Option[Path]

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

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

Value parameters

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.

Attributes

Returns

The shortest path to potentialSuccessor or None if either a. there exists no path to potentialSuccessor or a. there exists a path to potentialSuccessor but due to withSubgraph settings this path was out of scope.

Inherited from:
TraverserMethods (hidden)
final def shortestPathTo[U](potentialSuccessor: NodeT)(implicit visitor: OuterElem => U): Option[Path]

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

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

Value parameters

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.

Attributes

Returns

The shortest path to potentialSuccessor or None if either a. there exists no path to potentialSuccessor or a. there exists a path to potentialSuccessor but due to withSubgraph settings this path was out of scope.

Inherited from:
TraverserMethods (hidden)
final override def size: Int

Attributes

Definition Classes
Inherited from:
ForeachBasedDetachingIterable
def sizeCompare(that: Iterable[_]): Int

Attributes

Inherited from:
IterableOps
def sizeCompare(otherSize: Int): Int

Attributes

Inherited from:
IterableOps
final def sizeIs: SizeCompareOps

Attributes

Inherited from:
IterableOps
final override def slice(from: Int, until: Int): Vector[OuterElem]

Attributes

Definition Classes
Inherited from:
ForeachBasedDetachingIterable
def sliding(size: Int, step: Int): Iterator[Iterable[OuterElem]]

Attributes

Inherited from:
IterableOps
def sliding(size: Int): Iterator[Iterable[OuterElem]]

Attributes

Inherited from:
IterableOps
final override def span(p: OuterElem => Boolean): (Vector[OuterElem], Vector[OuterElem])

Attributes

Definition Classes
Inherited from:
ForeachBasedDetachingIterable
final override def splitAt(n: Int): (Vector[OuterElem], Vector[OuterElem])

Attributes

Definition Classes
Inherited from:
ForeachBasedDetachingIterable
def stepper[S <: Stepper[_]](implicit shape: StepperShape[OuterElem, S]): S

Attributes

Inherited from:
IterableOnce
final override def sum[B >: OuterElem](implicit num: Numeric[B]): B

Attributes

Definition Classes
Inherited from:
ForeachBasedDetachingIterable
def tail: Iterable[OuterElem]

Attributes

Inherited from:
IterableOps
def tails: Iterator[Iterable[OuterElem]]

Attributes

Inherited from:
IterableOps
final override def take(n: Int): Iterable[OuterElem]

Attributes

Definition Classes
Inherited from:
ForeachBasedDetachingIterable
def takeRight(n: Int): Iterable[OuterElem]

Attributes

Inherited from:
IterableOps
final override def takeWhile(p: OuterElem => Boolean): Vector[OuterElem]

Attributes

Definition Classes
Inherited from:
ForeachBasedDetachingIterable
override def tapEach[U](f: OuterElem => U): Iterable[OuterElem]

Attributes

Definition Classes
Inherited from:
IterableOps
final def to[CC <: ([N, E <: Edge[N]] =>> AnyGraph[N, E] & GraphLike[N, E, LazyRef(...)])](factory: GenericGraphCoreFactory[CC]): CC[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.

Attributes

Inherited from:
Traverser
final override def to[C1](factory: Factory[OuterElem, C1]): C1

Attributes

Definition Classes
Inherited from:
ForeachBasedDetachingIterable
def toArray[B >: OuterElem : ClassTag]: Array[B]

Attributes

Inherited from:
IterableOnceOps
final def toBuffer[B >: OuterElem]: Buffer[B]

Attributes

Inherited from:
IterableOnceOps
def toIndexedSeq: IndexedSeq[OuterElem]

Attributes

Inherited from:
IterableOnceOps
final def toInnerElemTraverser(root: NodeT): InnerElemTraverser

Attributes

Inherited from:
FluentProperties (hidden)
def toList: List[OuterElem]

Attributes

Inherited from:
IterableOnceOps
def toMap[K, V](implicit ev: OuterElem <:< (K, V)): Map[K, V]

Attributes

Inherited from:
IterableOnceOps
def toSeq: Seq[OuterElem]

Attributes

Inherited from:
IterableOnceOps
def toSet[B >: OuterElem]: Set[B]

Attributes

Inherited from:
IterableOnceOps
override def toString(): String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Iterable -> Any
Inherited from:
Iterable
def toVector: Vector[OuterElem]

Attributes

Inherited from:
IterableOnceOps
def transpose[B](implicit asIterable: OuterElem => Iterable[B]): Iterable[Iterable[B]]

Attributes

Inherited from:
IterableOps
def unzip[A1, A2](implicit asPair: OuterElem => (A1, A2)): (Iterable[A1], Iterable[A2])

Attributes

Inherited from:
IterableOps
def unzip3[A1, A2, A3](implicit asTriple: OuterElem => (A1, A2, A3)): (Iterable[A1], Iterable[A2], Iterable[A3])

Attributes

Inherited from:
IterableOps
def view: View[OuterElem]

Attributes

Inherited from:
IterableOps
final def withDirection(direction: Direction): OuterElemTraverser

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

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

Attributes

Inherited from:
FluentProperties (hidden)
def withFilter(p: OuterElem => Boolean): WithFilter[OuterElem, Iterable]

Attributes

Inherited from:
IterableOps
final def withKind(kind: Kind): OuterElemTraverser

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

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

Attributes

Inherited from:
FluentProperties (hidden)
final def withMaxDepth(maxDepth: Int): OuterElemTraverser

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

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

Attributes

Inherited from:
FluentProperties (hidden)
final def withMaxWeight(max: Long): OuterElemTraverser

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

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

Attributes

Inherited from:
FluentProperties (hidden)
final def withMaxWeight[W : Numeric](max: W, edgeWeight: EdgeT => W): OuterElemTraverser

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

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

Attributes

Inherited from:
FluentProperties (hidden)
def withMaxWeight(maxWeight: Option[Weight]): OuterElemTraverser

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

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

Attributes

Inherited from:
FluentProperties (hidden)
final def withOrdering(ordering: ElemOrdering): OuterElemTraverser

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

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

Attributes

Inherited from:
FluentProperties (hidden)
final def withParameters(parameters: Parameters): OuterElemTraverser

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

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

Attributes

Inherited from:
FluentProperties (hidden)
final def withRoot(root: NodeT): OuterElemTraverser

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

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

Attributes

Inherited from:
TraverserMethods (hidden)
final def withSubgraph(nodes: NodePredicate, edges: EdgePredicate): OuterElemTraverser

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

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

Attributes

Inherited from:
FluentProperties (hidden)
def zip[B](that: IterableOnce[B]): Iterable[(OuterElem, B)]

Attributes

Inherited from:
IterableOps
def zipAll[A1 >: OuterElem, B](that: Iterable[B], thisElem: A1, thatElem: B): Iterable[(A1, B)]

Attributes

Inherited from:
IterableOps
final override def zipWithIndex: Vector[(OuterElem, Int)]

Attributes

Definition Classes
Inherited from:
ForeachBasedDetachingIterable

Inherited and Abstract methods

protected def apply[U](pred: NodePredicate, visitor: OuterElem => U): Option[NodeT]

Attributes

Inherited from:
TraverserMethods (hidden)
protected def edgeVisitor[U](f: OuterElem => U): EdgeT => U

Attributes

Inherited from:
TraverserMethods (hidden)
def findCycle[U](implicit visitor: OuterElem => U): Option[Cycle]

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

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

Value parameters

visitor

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

Attributes

Returns

A cycle or None if either a. there exists no cycle in the component depicting by root or a. there exists a cycle in the component but due to withSubgraph settings this path was out of scope.

Inherited from:
TraverserMethods (hidden)
protected def newTraverser: (NodeT, Parameters, NodePredicate, EdgePredicate, ElemOrdering, Option[Weight]) => OuterElemTraverser

Attributes

Inherited from:
FluentProperties (hidden)
protected def nodeVisitor[U](f: OuterElem => U): NodeT => U

Attributes

Inherited from:
TraverserMethods (hidden)
def ordering: ElemOrdering

If a NodeOrdering or EdgeOrdering different from NoOrdering is supplied neighbor nodes will visited during the traversal according to this ordering.

If a NodeOrdering or EdgeOrdering different from NoOrdering is supplied neighbor nodes will visited during the traversal according to this ordering.

Attributes

Inherited from:
Properties (hidden)
def parameters: Parameters

The properties controlling subsequent traversals.

The properties controlling subsequent traversals.

Attributes

Inherited from:
Properties (hidden)
def partOfCycle[U](implicit visitor: OuterElem => U): Option[Cycle]

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

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

Value parameters

visitor

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

Attributes

Returns

A cycle containing root or None if either a. there exists no cycle containing root or a. there exists such a cycle but due to withSubgraph settings this path was out of scope.

Inherited from:
TraverserMethods (hidden)
def pathUntil[U](pred: NodePredicate)(implicit visitor: OuterElem => U): Option[Path]

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

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

Value parameters

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.

Attributes

Returns

A path to a node with the predicate pred or None if either a. there is no node with pred or a. there exists no path to such a node or a. there exists a path to such a node but due to withSubgraph settings this path was out of scope.

Inherited from:
TraverserMethods (hidden)
def root: NodeT

The node where subsequent graph traversals start.

The node where subsequent graph traversals start.

Attributes

Inherited from:
Properties (hidden)
def shortestPathTo[T : Numeric, U](potentialSuccessor: NodeT, weight: EdgeT => T, visitor: OuterElem => U): Option[Path]

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

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

Value parameters

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.

weight

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

Attributes

Returns

The shortest path to potentialSuccessor or None if either a. there exists no path to potentialSuccessor or a. there exists a path to potentialSuccessor but due to withSubgraph settings this path was out of scope.

Inherited from:
TraverserMethods (hidden)
def strongComponents[U](implicit visitor: OuterElem => U): Iterable[Component]

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

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

Value parameters

visitor

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

Attributes

Inherited from:
TraverserMethods (hidden)
def subgraphEdges: EdgePredicate

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.

Attributes

Inherited from:
SubgraphProperties (hidden)
def subgraphNodes: NodePredicate

Restricts subsequent graph traversals to visit only nodes holding this predicate.

Restricts subsequent graph traversals to visit only nodes holding this predicate.

Attributes

Inherited from:
SubgraphProperties (hidden)
def topologicalSort[U](ignorePredecessors: Boolean)(implicit visitor: InnerElem => U): TopologicalSort

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

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

Value parameters

ignorePredecessors

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

visitor

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

Attributes

Inherited from:
TraverserMethods (hidden)
def weakComponent[U](implicit visitor: OuterElem => U): Component

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

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

Value parameters

visitor

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

Attributes

Inherited from:
TraverserMethods (hidden)

Deprecated and Inherited methods

def ++:[B >: OuterElem](that: IterableOnce[B]): Iterable[B]

Attributes

Deprecated
[Since version 2.13.0] Use ++ instead of ++: for collections of type Iterable
Inherited from:
IterableOps
final def /:[B](z: B)(op: (B, OuterElem) => B): B

Attributes

Deprecated
[Since version 2.13.0] Use foldLeft instead of /:
Inherited from:
IterableOnceOps
final def :\[B](z: B)(op: (OuterElem, B) => B): B

Attributes

Deprecated
[Since version 2.13.0] Use foldRight instead of :\\
Inherited from:
IterableOnceOps
def aggregate[B](z: => B)(seqop: (B, OuterElem) => B, combop: (B, B) => B): B

Attributes

Deprecated
[Since version 2.13.0] For sequential collections, prefer `foldLeft(z)(seqop)`. For parallel collections, use `ParIterableLike#aggregate`.
Inherited from:
IterableOnceOps
def companion: IterableFactory[Iterable]

Attributes

Deprecated
[Since version 2.13.0] Use iterableFactory instead
Inherited from:
IterableOps
final def copyToBuffer[B >: OuterElem](dest: Buffer[B]): Unit

Attributes

Deprecated
[Since version 2.13.0] Use `dest ++= coll` instead
Inherited from:
IterableOnceOps
def hasDefiniteSize: Boolean

Attributes

Deprecated
[Since version 2.13.0] Check .knownSize instead of .hasDefiniteSize for more actionable information (see scaladoc for details)
Inherited from:
IterableOnceOps
final def repr: Iterable[OuterElem]

Attributes

Deprecated
[Since version 2.13.0] Use coll instead of repr in a collection implementation, use the collection value itself from the outside
Inherited from:
IterableOps
def seq: Iterable.this.type

Attributes

Deprecated
[Since version 2.13.0] Iterable.seq always returns the iterable itself
Inherited from:
Iterable
final def toIterable: Iterable.this.type

Attributes

Deprecated
[Since version 2.13.7] toIterable is internal and will be made protected; its name is similar to `toList` or `toSeq`, but it doesn\'t copy non-immutable collections
Inherited from:
Iterable
final def toIterator: Iterator[OuterElem]

Attributes

Deprecated
[Since version 2.13.0] Use .iterator instead of .toIterator
Inherited from:
IterableOnceOps
final def toStream: Stream[OuterElem]

Attributes

Deprecated
[Since version 2.13.0] Use .to(LazyList) instead of .toStream
Inherited from:
IterableOnceOps
final def toTraversable: Iterable[OuterElem]

Attributes

Deprecated
[Since version 2.13.0] toTraversable is internal and will be made protected; its name is similar to `toList` or `toSeq`, but it doesn\'t copy non-immutable collections
Inherited from:
IterableOps
def view(from: Int, until: Int): View[OuterElem]

Attributes

Deprecated
[Since version 2.13.0] Use .view.slice(from, until) instead of .view(from, until)
Inherited from:
IterableOps
Generated with