Graph Core
2.0.2
API
Generated with
Graph Core/scalax.collection/GraphTraversal

GraphTraversal

scalax.collection.GraphTraversal
See theGraphTraversal companion object
trait GraphTraversal[N, E <: Edge[N]] extends GraphBase[N, E, [N, E <: Edge[N]] =>> GraphTraversal[N, E]]

Graph-related functionality such as traversals, path finding, cycle detection etc. All algorithms including breadth-first, depth-first, white-gray-black search and Dijkstra's algorithm are tail recursive.

Before starting a traversal a Traverser such as scalax.collection.GraphTraversal#InnerNodeTraverser is instantiated explicitly or implicitly. It holds settings like maxDepth, subgraph or ordering providing a fine-grained control of the traversal. Traversers also extend scala.collection.Iterable meaning that you can process the visited nodes and edges in a functional way.

Attributes

See also
Companion
object
Graph
Supertypes
trait GraphBase[N, E, [N, E <: Edge[N]] =>> GraphTraversal[N, E]]
trait Serializable
trait GraphOps[N, E, [N, E <: Edge[N]] =>> GraphTraversal[N, E]]
trait OuterElems[N, E]
class Object
trait Matchable
class Any
Show all
Known subtypes
trait GraphLike[N, E, CC]
trait AdjacencyListBase[N, E, CC]
trait AdjacencyListGraph[N, E, CC]
class DefaultGraphImpl[N, E]
trait AdjacencyListGraph[N, E, CC]
class DefaultGraphImpl[N, E]
trait Graph[N, E]
trait GraphLike[N, E, CC]
trait Graph[N, E]
trait AnyGraph[N, E]
trait GraphTraversalImpl[N, E]
Show all
Self type

Members list

Type members

Classlikes

sealed abstract class AbstractTopologicalOrder[+A, +T] extends AbstractIterable[T]

Topologically ordered nodes or layers of a topological order of a graph or of an isolated graph component.

Topologically ordered nodes or layers of a topological order of a graph or of an isolated graph component.

Type parameters

A

one of NodeT, N

T

one of A or (Int, Iterable[A])

Attributes

Supertypes
class AbstractIterable[T]
trait Iterable[T]
trait IterableOps[T, Iterable, Iterable[T]]
trait IterableOnce[T]
class Object
trait Matchable
class Any
Show all
Known subtypes
class TopologicalOrder[A]
abstract class Component()

Represents a component of this graph. Edges and bridges are computed lazily. Components will be instantiated by componentTraverser or strongComponentTraverser.

Represents a component of this graph. Edges and bridges are computed lazily. Components will be instantiated by componentTraverser or strongComponentTraverser.

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
abstract class ComponentTraverser() extends Iterable[Component]

Controls the properties of graph traversals with no specific root and allows you to produce the (weakly) connected components by a traversal or call methods like findCycle that work component-wise.

Controls the properties of graph traversals with no specific root and allows you to produce the (weakly) connected components by a traversal or call methods like findCycle that work component-wise.

Attributes

Supertypes
class Object
trait Matchable
class Any
Show all
Known subtypes
object Cycle

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Cycle.type
trait Cycle extends Path

Represents a cycle in this graph listing the nodes and connecting edges on it with the following syntax:

Represents a cycle in this graph listing the nodes and connecting edges on it with the following syntax:

cycle ::= ''start-end-node'' { ''edge'' ''node'' } ''edge'' ''start-end-node''

All nodes and edges on the path are distinct except the start and end nodes that are equal. A cycle contains at least a start node followed by any number of consecutive pairs of an edge and a node and the end node equaling to the start node. The first element is the start node, the second is an edge with its tail being the start node and its head being the third element etc.

Attributes

Companion
object
Supertypes
trait Path
trait Walk
class Object
trait Matchable
class Any
Show all
Known subtypes
object ExtendedNodeVisitor

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
trait ExtendedNodeVisitor[U] extends NodeT => U

Template for extended node visitors. While the default node visitor of the type NodeT => U passes solely the inner node being visited, extended node visitors pass the following traversal state information:

Template for extended node visitors. While the default node visitor of the type NodeT => U passes solely the inner node being visited, extended node visitors pass the following traversal state information:

  1. the inner node currently visited as with a standard node visitor
  2. the number of nodes visited so far and
  3. the current depth in terms of the underlying algorithm and
  4. a reference to a specific informer that may be pattern matched to collect even further data specific to the implementation.

Attributes

Companion
object
Supertypes
trait NodeT => U
class Object
trait Matchable
class Any
object Informer

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Informer.type
abstract class InnerEdgeTraverser extends Traverser[EdgeT, InnerEdgeTraverser]

Controls the properties of inner-edge 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.

Controls the properties of inner-edge 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

Supertypes
trait Iterable[EdgeT]
class Object
trait Matchable
class Any
Show all
Known subtypes
abstract class InnerNodeDownUpTraverser extends Traverser[(Boolean, NodeT), InnerNodeDownUpTraverser]

Controls the properties of inner-node down-up 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.

Controls the properties of inner-node down-up 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

Supertypes
trait Iterable[(Boolean, NodeT)]
class Object
trait Matchable
class Any
Show all
Known subtypes
abstract class InnerNodeTraverser extends Traverser[NodeT, InnerNodeTraverser]

Controls the properties of inner-node 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.

Controls the properties of inner-node 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

Supertypes
trait Iterable[NodeT]
class Object
trait Matchable
class Any
Show all
Known subtypes
case class Layer

Represents a topological sort layer.

Represents a topological sort layer.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final class LayeredTopologicalOrder[+A] extends AbstractTopologicalOrder[A, (Int, Iterable[A])]

Layers of a topological order of a graph or of an isolated graph component. The layers of a topological sort can roughly be defined as follows: a. layer 0 contains all nodes having no predecessors, a. layer n contains those nodes that have only predecessors in ancestor layers with at least one of them contained in layer n - 1

Layers of a topological order of a graph or of an isolated graph component. The layers of a topological sort can roughly be defined as follows: a. layer 0 contains all nodes having no predecessors, a. layer n contains those nodes that have only predecessors in ancestor layers with at least one of them contained in layer n - 1

Type parameters

A

one of NodeT, N

Attributes

Supertypes
trait Iterable[(Int, Iterable[A])]
trait IterableOnce[(Int, Iterable[A])]
class Object
trait Matchable
class Any
Show all
abstract class OuterEdgeTraverser extends Traverser[E, OuterEdgeTraverser]

Controls the properties of outer-edge 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.

Controls the properties of outer-edge 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

Supertypes
trait Iterable[E]
trait IterableOps[E, Iterable, Iterable[E]]
trait IterableOnce[E]
class Object
trait Matchable
class Any
Show all
Known subtypes
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.

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

Supertypes
class Object
trait Matchable
class Any
Show all
Known subtypes
abstract class OuterNodeDownUpTraverser extends Traverser[(Boolean, N), OuterNodeDownUpTraverser]

Controls the properties of outer-node down-up 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.

Controls the properties of outer-node down-up 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

Supertypes
trait Iterable[(Boolean, N)]
trait IterableOnce[(Boolean, N)]
class Object
trait Matchable
class Any
Show all
Known subtypes
abstract class OuterNodeTraverser extends Traverser[N, OuterNodeTraverser]

Controls the properties of outer-node 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.

Controls the properties of outer-node 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

Supertypes
trait Iterable[N]
trait IterableOps[N, Iterable, Iterable[N]]
trait IterableOnce[N]
class Object
trait Matchable
class Any
Show all
Known subtypes
object Path extends Serializable

Attributes

Companion
trait
Supertypes
trait Serializable
class Object
trait Matchable
class Any
Self type
Path.type
trait Path extends Walk

Represents a path in this graph where

Represents a path in this graph where

path ::= ''node'' { ''edge'' ''node'' }

Nodes and edges on the path are distinct. A walk/path contains at least one node followed by any number of consecutive pairs of an edge and a node. The first element is the start node, the second is an edge with its source being the start node and its target being the third element etc.

Attributes

Companion
object
Supertypes
trait Walk
class Object
trait Matchable
class Any
Show all
Known subtypes
trait Cycle
class LazyPath
Show all
trait PathBuilder extends WalkBuilder, Builder[InnerElem, Path]

A Builder for valid paths in this graph.

A Builder for valid paths in this graph.

Nodes and edges may be added either alternating or node by node respectively edge by edge. Either way, the builder ensures that the added elements build a valid path.

A node addition fails if either the node to be added is already contained or the node is not a direct successor of the previously added node or of the target node of the previously added edge. An edge addition fails if either the edge to be added is is already contained or the edge is not an outgoing edge from the previously added node or of the target node of the previously added edge.

It is recommended using add instead of += to track failed additions.

Attributes

Supertypes
trait WalkBuilder
trait Clearable
class Object
trait Matchable
class Any
Show all
Known subtypes
abstract class StrongComponentTraverser() extends Iterable[Component]

Controls the properties of graph traversals with no specific root and allows you to produce the strongly connected components by a traversal.

Controls the properties of graph traversals with no specific root and allows you to produce the strongly connected components by a traversal.

Attributes

Supertypes
class Object
trait Matchable
class Any
Show all
Known subtypes
final class TopologicalOrder[+A] extends AbstractTopologicalOrder[A, A]

A traversable topological order of nodes of a graph or of an isolated graph component.

A traversable topological order of nodes of a graph or of an isolated graph component.

Type parameters

A

one of NodeT, N

Attributes

Supertypes
class AbstractIterable[A]
trait Iterable[A]
trait IterableOps[A, Iterable, Iterable[A]]
trait IterableOnce[A]
class Object
trait Matchable
class Any
Show all
case class TopologicalSortFailure

Failure result of a topological sort with a possible hint of candidate cycle nodes.

Failure result of a topological sort with a possible hint of candidate cycle nodes.

Value parameters

candidateCycleNodes
  • If the set is not empty, at least one of the candidate nodes lies on a cycle.
  • An empty set is only returned if, in any of the components, no node without a predecessor exists so the algorithm was stopped before any cycle node could have been determined.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
trait Traverser[A, +CC <: Traverser[A, CC]] extends ForeachBasedDetachingIterable[A]

Controls the properties of consecutive graph traversals starting at a root node. Provides methods to refine the properties and to invoke traversals. Instances will be created by innerNodeTraverser etc.

Controls the properties of consecutive graph traversals starting at a root node. Provides methods to refine the properties and to invoke traversals. Instances will be created by innerNodeTraverser etc.

Attributes

Supertypes
trait Iterable[A]
trait IterableOps[A, Iterable, Iterable[A]]
trait IterableOnce[A]
class Object
trait Matchable
class Any
Show all
Known subtypes
Show all
Self type
CC
object TraverserInnerNode

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
trait TraverserInnerNode extends BaseInnerNode

Attributes

Companion
object
Supertypes
trait InnerNode
trait InnerElem
trait Node
trait Serializable
class Object
trait Matchable
class Any
Show all
Known subtypes
trait NodeBase
Show all
Self type
object Walk

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Walk.type
trait Walk extends Iterable[InnerElem]

Represents a walk in this graph where walk ::= ''node'' { ''edge'' ''node'' } A walk/path contains at least one node followed by any number of consecutive pairs of an edge and a node. The first element is the start node, the second is an edge with its source being the start node and its target being the third element etc.

Represents a walk in this graph where walk ::= ''node'' { ''edge'' ''node'' } A walk/path contains at least one node followed by any number of consecutive pairs of an edge and a node. The first element is the start node, the second is an edge with its source being the start node and its target being the third element etc.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Show all
Known subtypes
trait Path
trait Cycle
class LazyPath
Show all
trait WalkBuilder extends Builder[InnerElem, Walk]

A Builder for valid walks in this graph.

A Builder for valid walks in this graph.

Nodes and edges may be added either alternating or node by node respectively edge by edge. Either way, the builder ensures that the added elements build a valid walk.

A node addition fails if the node to be added is not a direct successor of the previously added node or of the target node of the previously added edge. An edge addition fails if the edge to be added is not an outgoing edge from the previously added node or of the target node of the previously added edge.

It is recommended using add instead of += to track failed additions.

Attributes

Supertypes
trait Clearable
class Object
trait Matchable
class Any
Show all
Known subtypes
trait PathBuilder
class Weight(val value: Double, val edgeWeight: EdgeT => Double)

Stores a value and an edge weight function for use in weight-based traversals that may be defined by withMaxWeight.

Stores a value and an edge weight function for use in weight-based traversals that may be defined by withMaxWeight.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object Weight

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
Weight.type

Inherited classlikes

object BaseInnerEdge

Attributes

Inherited from:
GraphBase
Supertypes
class Object
trait Matchable
class Any
trait BaseInnerEdge extends InnerEdge, Equals

Attributes

Inherited from:
GraphBase
Supertypes
trait InnerEdge
trait InnerElem
trait Edge[NodeT]
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
trait BaseInnerNode extends Node, InnerNode

Attributes

Inherited from:
GraphBase
Supertypes
trait InnerNode
trait InnerElem
trait Node
trait Serializable
class Object
trait Matchable
class Any
Show all
Known subtypes
trait NodeBase
Show all
object EdgeOrdering extends Serializable

Ordering for the path dependent type EdgeT.

Ordering for the path dependent type EdgeT.

Attributes

Inherited from:
GraphBase
Supertypes
trait Serializable
class Object
trait Matchable
class Any
sealed trait EdgeOrdering extends Ordering[EdgeT]

Ordering for the path dependent type EdgeT.

Ordering for the path dependent type EdgeT.

Attributes

Inherited from:
GraphBase
Supertypes
trait Ordering[EdgeT]
trait Equiv[EdgeT]
trait Serializable
trait Comparator[EdgeT]
class Object
trait Matchable
class Any
Show all
Known subtypes
object ArityOrdering.type
object WeightOrdering.type
object None.type
trait EdgeSet extends Set[EdgeT], ExtSetMethods[EdgeT], Serializable

Attributes

Inherited from:
GraphBase
Supertypes
trait Serializable
trait Set[EdgeT]
trait Equals
trait SetOps[EdgeT, Set, Set[EdgeT]]
trait EdgeT => Boolean
trait Iterable[EdgeT]
class Object
trait Matchable
class Any
Show all
Known subtypes
trait GraphEdgeSet
object InnerEdge

Attributes

Inherited from:
GraphOps
Supertypes
class Object
trait Matchable
class Any
trait InnerEdge extends InnerElem

Attributes

Inherited from:
GraphOps
Supertypes
trait InnerElem
class Object
trait Matchable
class Any
Known subtypes
sealed trait InnerElem

Attributes

Inherited from:
GraphOps
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait InnerEdge
trait InnerNode
trait NodeBase
Show all
object InnerNode

Attributes

Inherited from:
GraphOps
Supertypes
class Object
trait Matchable
class Any
trait InnerNode extends InnerElem

Attributes

Inherited from:
GraphOps
Supertypes
trait InnerElem
class Object
trait Matchable
class Any
Known subtypes
trait NodeBase
Show all
object NoOrdering extends Serializable

The empty ElemOrdering.

The empty ElemOrdering.

Attributes

Inherited from:
GraphBase
Supertypes
trait Serializable
class Object
trait Matchable
class Any
object Node

Attributes

Inherited from:
GraphBase
Supertypes
class Object
trait Matchable
class Any
trait Node extends Serializable

Attributes

Inherited from:
GraphBase
Supertypes
trait Serializable
class Object
trait Matchable
class Any
Known subtypes
trait NodeBase
Show all
object NodeOrdering

Attributes

Inherited from:
GraphBase
Supertypes
class Object
trait Matchable
class Any
sealed trait NodeOrdering extends Ordering[NodeT]

Ordering for the path dependent type NodeT.

Ordering for the path dependent type NodeT.

Attributes

Inherited from:
GraphBase
Supertypes
trait Ordering[NodeT]
trait Equiv[NodeT]
trait Serializable
trait Comparator[NodeT]
class Object
trait Matchable
class Any
Show all
Known subtypes
object None.type
trait NodeSet extends Set[NodeT], ExtSetMethods[NodeT]

Attributes

Inherited from:
GraphBase
Supertypes
trait Set[NodeT]
trait Equals
trait SetOps[NodeT, Set, Set[NodeT]]
trait NodeT => Boolean
trait Iterable[NodeT]
class Object
trait Matchable
class Any
Show all
Known subtypes
trait GraphNodeSet
sealed case class OuterEdge(edge: E) extends OuterElem

To be mixed in by edge classes to allow passing them to Graph(...).

To be mixed in by edge classes to allow passing them to Graph(...).

Attributes

Inherited from:
OuterElems
Supertypes
trait Serializable
trait Product
trait Equals
trait OuterElem
class Object
trait Matchable
class Any
Show all
trait OuterElem

Attributes

Inherited from:
OuterElems
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class OuterEdge
class OuterNode
sealed case class OuterNode(node: N) extends OuterElem

Wraps any type to be accepted when calling Graph(...).

Wraps any type to be accepted when calling Graph(...).

Attributes

Inherited from:
OuterElems
Supertypes
trait Serializable
trait Product
trait Equals
trait OuterElem
class Object
trait Matchable
class Any
Show all

Types

type Layers = Iterable[Layer]

The result of a topological sort in the layered view.

The result of a topological sort in the layered view.

Attributes

Inherited types

type EdgePredicate = EdgeT => Boolean

Attributes

Inherited from:
GraphOps
type EdgeSetT <: EdgeSet

Attributes

Inherited from:
GraphBase
type EdgeT <: InnerEdgeLike[NodeT] & BaseInnerEdge

Attributes

Inherited from:
GraphBase
type NodePredicate = NodeT => Boolean

Attributes

Inherited from:
GraphOps
type NodeSetT <: NodeSet

Attributes

Inherited from:
GraphBase

Value members

Abstract methods

def componentTraverser(parameters: Parameters, subgraphNodes: NodePredicate, subgraphEdges: EdgePredicate, ordering: ElemOrdering, maxWeight: Option[Weight]): ComponentTraverser

Creates a ComponentTraverser responsible for invoking graph traversal methods in all (weakly) connected components of this possibly disconnected graph.

Creates a ComponentTraverser responsible for invoking graph traversal methods in all (weakly) connected components of this possibly disconnected graph.

Value parameters

maxWeight

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.

ordering

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

parameters

The properties controlling subsequent traversals.

subgraphEdges

Restricts subsequent graph traversals to walk only along edges that hold this predicate.

subgraphNodes

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

Attributes

def innerEdgeTraverser(root: NodeT, parameters: Parameters, subgraphNodes: NodePredicate, subgraphEdges: EdgePredicate, ordering: ElemOrdering, maxWeight: Option[Weight]): InnerEdgeTraverser

Creates a InnerEdgeTraverser based on scala.collection.Iterable[EdgeT].

Creates a InnerEdgeTraverser based on scala.collection.Iterable[EdgeT].

Value parameters

ordering

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

parameters

The properties controlling subsequent traversals.

root

The node where subsequent graph traversals start.

subgraphEdges

Restricts subsequent graph traversals to walk only along edges that hold this predicate.

subgraphNodes

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

Attributes

def innerElemTraverser(root: NodeT, parameters: Parameters, subgraphNodes: NodePredicate, subgraphEdges: EdgePredicate, ordering: ElemOrdering, maxWeight: Option[Weight]): InnerElemTraverser

Creates a InnerElemTraverser based on scala.collection.Iterable[InnerElem].

Creates a InnerElemTraverser based on scala.collection.Iterable[InnerElem].

Value parameters

maxWeight

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.

ordering

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

parameters

The properties controlling subsequent traversals.

root

The node where subsequent graph traversals start.

subgraphEdges

Restricts subsequent graph traversals to walk only along edges that hold this predicate.

subgraphNodes

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

Attributes

def innerNodeDownUpTraverser(root: NodeT, parameters: Parameters, subgraphNodes: NodePredicate, subgraphEdges: EdgePredicate, ordering: ElemOrdering, maxWeight: Option[Weight]): InnerNodeDownUpTraverser

Creates a InnerNodeDownUpTraverser based on scala.collection.Iterable[(Boolean, NodeT)] where the Boolean parameter is true if the traversal takes place in downward and false if it takes place in upward direction.

Creates a InnerNodeDownUpTraverser based on scala.collection.Iterable[(Boolean, NodeT)] where the Boolean parameter is true if the traversal takes place in downward and false if it takes place in upward direction.

Value parameters

maxWeight

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.

ordering

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

parameters

The properties controlling subsequent traversals. A kind different from DepthFirst will be ignored.

root

The node where subsequent graph traversals start.

subgraphEdges

Restricts subsequent graph traversals to walk only along edges that hold this predicate.

subgraphNodes

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

Attributes

def innerNodeTraverser(root: NodeT, parameters: Parameters, subgraphNodes: NodePredicate, subgraphEdges: EdgePredicate, ordering: ElemOrdering, maxWeight: Option[Weight]): InnerNodeTraverser

Creates a InnerNodeTraverser based on scala.collection.Iterable[NodeT].

Creates a InnerNodeTraverser based on scala.collection.Iterable[NodeT].

Value parameters

maxWeight

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.

ordering

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

parameters

The properties controlling subsequent traversals.

root

The node where subsequent graph traversals start.

subgraphEdges

Restricts subsequent graph traversals to walk only along edges that hold this predicate.

subgraphNodes

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

Attributes

def newPathBuilder(start: NodeT)(implicit sizeHint: Int, edgeSelector: (NodeT, NodeT) => Option[EdgeT]): PathBuilder

Instantiates a PathBuilder for this graph.

Instantiates a PathBuilder for this graph.

Value parameters

edgeSelector

Determines the edge to be selected between neighbor nodes if an edge is not supplied explicitly. This is only relevant in case of multigraphs.

sizeHint

Expected maximum number of nodes on this path.

start

The node this path starts at.

Attributes

def newWalkBuilder(start: NodeT)(implicit sizeHint: Int, edgeSelector: (NodeT, NodeT) => Option[EdgeT]): WalkBuilder

Instantiates a WalkBuilder for this graph.

Instantiates a WalkBuilder for this graph.

Value parameters

edgeSelector

Determines the edge to be selected between neighbor nodes if an edge is not supplied explicitly. This is only relevant in case of multigraphs.

sizeHint

Expected maximum number of nodes on this walk.

start

The node this walk starts at.

Attributes

def outerEdgeTraverser(root: NodeT, parameters: Parameters, subgraphNodes: NodePredicate, subgraphEdges: EdgePredicate, ordering: ElemOrdering, maxWeight: Option[Weight]): OuterEdgeTraverser

Creates a OuterEdgeTraverser based on scala.collection.Iterable[E[N]].

Creates a OuterEdgeTraverser based on scala.collection.Iterable[E[N]].

Value parameters

maxWeight

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.

ordering

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

parameters

The properties controlling subsequent traversals.

root

The node where subsequent graph traversals start.

subgraphEdges

Restricts subsequent graph traversals to walk only along edges that hold this predicate.

subgraphNodes

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

Attributes

def outerElemTraverser(root: NodeT, parameters: Parameters, subgraphNodes: NodePredicate, subgraphEdges: EdgePredicate, ordering: ElemOrdering, maxWeight: Option[Weight]): OuterElemTraverser

Creates a OuterElemTraverser based on scala.collection.Iterable[OuterElem].

Creates a OuterElemTraverser based on scala.collection.Iterable[OuterElem].

Value parameters

maxWeight

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.

ordering

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

parameters

The properties controlling subsequent traversals.

root

The node where subsequent graph traversals start.

subgraphEdges

Restricts subsequent graph traversals to walk only along edges that hold this predicate.

subgraphNodes

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

Attributes

def outerNodeDownUpTraverser(root: NodeT, parameters: Parameters, subgraphNodes: NodePredicate, subgraphEdges: EdgePredicate, ordering: ElemOrdering, maxWeight: Option[Weight]): OuterNodeDownUpTraverser

Creates a OuterNodeDownUpTraverser based on scala.collection.Iterable[(Boolean, N)] where the Boolean parameter is true if the traversal takes place in downward and false if it takes place in upward direction.

Creates a OuterNodeDownUpTraverser based on scala.collection.Iterable[(Boolean, N)] where the Boolean parameter is true if the traversal takes place in downward and false if it takes place in upward direction.

Value parameters

ordering

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

parameters

The properties controlling subsequent traversals. A kind different from DepthFirst will be ignored.

root

The node where subsequent graph traversals start.

subgraphEdges

Restricts subsequent graph traversals to walk only along edges that hold this predicate.

subgraphNodes

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

Attributes

def outerNodeTraverser(root: NodeT, parameters: Parameters, subgraphNodes: NodePredicate, subgraphEdges: EdgePredicate, ordering: ElemOrdering, maxWeight: Option[Weight]): OuterNodeTraverser

Creates a OuterNodeTraverser based on scala.collection.Iterable[N].

Creates a OuterNodeTraverser based on scala.collection.Iterable[N].

Value parameters

maxWeight

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.

ordering

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

parameters

The properties controlling subsequent traversals.

root

The node where subsequent graph traversals start.

subgraphEdges

Restricts subsequent graph traversals to walk only along edges that hold this predicate.

subgraphNodes

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

Attributes

def strongComponentTraverser(parameters: Parameters, subgraphNodes: NodePredicate, subgraphEdges: EdgePredicate, ordering: ElemOrdering, maxWeight: Option[Weight]): StrongComponentTraverser

Creates a StrongComponentTraverser.

Creates a StrongComponentTraverser.

Value parameters

maxWeight

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.

ordering

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

parameters

The properties controlling subsequent traversals.

subgraphEdges

Restricts subsequent graph traversals to walk only along edges that hold this predicate.

subgraphNodes

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

Attributes

Concrete methods

final def anyEdgeSelector(from: NodeT, to: NodeT): Option[EdgeT]

An arbitrary edge between from and to that is available most efficiently.

An arbitrary edge between from and to that is available most efficiently.

Attributes

final def findCycle[U](implicit visitor: InnerElem => U): Option[Cycle]

Finds a cycle in this graph in any of its components and calls visitor for each inner element visited during the search. See componentTraverser for more control by means of FluentProperties.

Finds a cycle in this graph in any of its components and calls visitor for each inner element visited during the search. See componentTraverser for more control by means of FluentProperties.

Attributes

final def findCycleContaining[U](node: NodeT)(implicit visitor: InnerElem => U): Option[Cycle]

Finds a cycle that contains node and calls visitor for each inner element visited during the search.

Finds a cycle that contains node and calls visitor for each inner element visited during the search.

Attributes

final def isAcyclic: Boolean

Whether this graph has no cycle.

Whether this graph has no cycle.

Attributes

def isComplete: Boolean

Whether all nodes are pairwise adjacent.

Whether all nodes are pairwise adjacent.

Attributes

Returns

true if this graph is complete, false if this graph contains any independent nodes.

def isConnected: Boolean

Whether this graph is connected if it is undirected or weakly connected if it is directed.

Whether this graph is connected if it is undirected or weakly connected if it is directed.

Attributes

final def isCyclic: Boolean

Whether this graph has at least one cycle in any of its components.

Whether this graph has at least one cycle in any of its components.

Attributes

final def topologicalSort[U](implicit visitor: InnerElem => U): TopologicalSort

Sorts this graph topologically. Hooks are ignored.

Sorts this graph topologically. Hooks are ignored.

Value parameters

visitor

called for each inner node or inner edge visited during the sort. See componentTraverser for more control by means of FluentProperties.

Attributes

final def topologicalSortByComponent[U](implicit visitor: InnerElem => U): Iterable[TopologicalSort]

Sorts every isolated component of this graph topologically. Hooks are ignored.

Sorts every isolated component of this graph topologically. Hooks are ignored.

Value parameters

visitor

called for each inner node or inner edge visited during the sort. See componentTraverser for more control by means of FluentProperties.

Attributes

Inherited methods

final def &(that: AnyGraph[N, E]): CC[N, E]

Alias for intersect.

Alias for intersect.

Attributes

Inherited from:
GraphOps
final def &~(that: AnyGraph[N, E]): CC[N, E]

Alias for diff.

Alias for diff.

Attributes

Inherited from:
GraphOps
final def ++[N2 >: N, E2 >: E <: Edge[N2]](edges: IterableOnce[E2])(implicit e: E2 <:< Edge[N2]): CC[N2, E2]

Alias for concat(edges).

Alias for concat(edges).

Attributes

Inherited from:
GraphOps
final def ++[N2 >: N, E2 >: E <: Edge[N2]](isolatedNodes: IterableOnce[N2], edges: IterableOnce[E2])(implicit e: E2 <:< Edge[N2]): CC[N2, E2]

Alias for concat(isolatedNodes, edges).

Alias for concat(isolatedNodes, edges).

Attributes

Inherited from:
GraphOps
final def apply(edge: E): Boolean

Whether the given edge is contained in this graph.

Whether the given edge is contained in this graph.

Attributes

Inherited from:
GraphOps
final def apply(node: N): Boolean

Whether the given node is contained in this graph.

Whether the given node is contained in this graph.

Attributes

Inherited from:
GraphOps
def concat[N2 >: N, E2 >: E <: Edge[N2]](edges: IterableOnce[E2])(implicit e: E2 <:< Edge[N2]): CC[N2, E2]

Same as concat(isolatedNodes, edges) but with empty isolatedNodes. This method is useful if you don't need to pass any isolated node.

Same as concat(isolatedNodes, edges) but with empty isolatedNodes. This method is useful if you don't need to pass any isolated node.

Attributes

Inherited from:
GraphOps
def concat[N2 >: N, E2 >: E <: Edge[N2]](isolatedNodes: IterableOnce[N2], edges: IterableOnce[E2])(implicit e: E2 <:< Edge[N2]): CC[N2, E2]

Creates a new graph by adding all edges and isolatedNodes omitting duplicates. The new graph is upcasted if any of the arguments is an upcast of N respectively E. Use union to concatenate all nodes and edges of another graph.

Creates a new graph by adding all edges and isolatedNodes omitting duplicates. The new graph is upcasted if any of the arguments is an upcast of N respectively E. Use union to concatenate all nodes and edges of another graph.

Value parameters

edges

to be concatenated.

isolatedNodes

to be concatenated. Nodes that are implicitly defined by any edge in edges will be ignored.

Attributes

Inherited from:
GraphOps
def contains(edge: E): Boolean

Whether the given outer edge is contained in this graph.

Whether the given outer edge is contained in this graph.

Attributes

Inherited from:
GraphOps
def contains(node: N): Boolean

Whether the given outer node is contained in this graph.

Whether the given outer node is contained in this graph.

Attributes

Inherited from:
GraphOps
final def diff(that: AnyGraph[N, E]): CC[N, E]

Computes a new graph that is the difference of this graph and that graph.

Computes a new graph that is the difference of this graph and that graph.

Attributes

Inherited from:
GraphOps
def edges: EdgeSetT

The edge set of this Graph commonly referred to as E(G).

The edge set of this Graph commonly referred to as E(G).

Attributes

Returns

Set of all contained edges.

Inherited from:
GraphBase
final def elementCount: Int

The number of nodes and edges.

The number of nodes and edges.

Attributes

Inherited from:
GraphOps
def filter(nodeP: NodePredicate, edgeP: EdgePredicate): CC[N, E]

Computes a new graph with nodes satisfying nodeP and edges satisfying edgeP. If both nodeP and edgeP have default values the original graph is retained.

Computes a new graph with nodes satisfying nodeP and edges satisfying edgeP. If both nodeP and edgeP have default values the original graph is retained.

Attributes

Inherited from:
GraphOps
def filterNot(nodeP: NodePredicate, edgeP: EdgePredicate): CC[N, E]

Computes a new graph without nodes satisfying nodeP and without edges satisfying ePred. If both nodeP and ePred have default values the original graph is retained.

Computes a new graph without nodes satisfying nodeP and without edges satisfying ePred. If both nodeP and ePred have default values the original graph is retained.

Attributes

Inherited from:
GraphOps
def find(edge: E): Option[EdgeT]

Searches this graph for an inner edge that wraps an outer edge equalling to the given outer edge.

Searches this graph for an inner edge that wraps an outer edge equalling to the given outer edge.

Attributes

Inherited from:
GraphOps
def find(node: N): Option[NodeT]

Searches this graph for an inner node that wraps an outer node equalling to the given outer node.

Searches this graph for an inner node that wraps an outer node equalling to the given outer node.

Attributes

Inherited from:
GraphOps
final def flatMap[NN, EC <: (Edge)](fNode: NodeT => Seq[NN], fEdge: (Seq[NN], Seq[NN]) => Seq[EC[NN]])(implicit w: E <:< AnyEdge[N]): CC[NN, EC[NN]]

Creates a new graph with nodes and edges returned by fNode respectively fEdge.

Creates a new graph with nodes and edges returned by fNode respectively fEdge.

See overload except the parameter

Value parameters

fEdge

has a simplified signature in this overload leaving out the inner edge. This comes in handy whenever you don't need to inspect inner edges.

Attributes

Inherited from:
GraphOps
def flatMap[NN, EC <: (Edge)](fNode: NodeT => Seq[NN], fEdge: (EdgeT, Seq[NN], Seq[NN]) => Seq[EC[NN]])(implicit w: E <:< AnyEdge[N]): CC[NN, EC[NN]]

Creates a new graph with nodes and edges returned by fNode respectively fEdge.

Creates a new graph with nodes and edges returned by fNode respectively fEdge.

You can call this flavor only if this graph's edge type is generic. Otherwise see flatMapBound.

Type parameters

EC

The higher kind of the generic edge type parameter of this graph.

NN

The node type of the resulting graph which may be unchanged or different from this graph's node type.

Value parameters

fEdge

To apply to all edges of this graph. This function is passed the current inner edge and its ends after being mapped by fNode. Since the inner edge is passed you can also examine its context. Call outer to get the outer edge of type E.

fNode

To apply to all nodes of this graph. Since the inner node is passed you can also examine the node context. Call outer to get the value of type N of the node.

Attributes

Returns

A new graph of possibly changed node and edge types and of any new structure depending on your edge mapper(s).

Inherited from:
GraphOps
def flatMap[NN, EC <: (Edge)](fNode: NodeT => Seq[NN])(implicit w1: E <:< GenericMapper, w2: EC[N] =:= E, t: ClassTag[EC[NN]]): CC[NN, EC[NN]]

Creates a new graph with nodes returned by fNode and an edge structure that remains intact where possible.

Creates a new graph with nodes returned by fNode and an edge structure that remains intact where possible.

You can call this flavor only if this graph's edge type is generic. Otherwise see flatMapBound.

If this graph also contains typed edges, the typed edge's partial map function will be called to replace the ends. If the partial function is not defined, there will be an attempt to fall back to a generic edge. If that attempt also fails the edge will be dropped. So, if you have a mixed graph with generic and typed edges, prefer mapping edges directly to avoid leaving edges out.

Type parameters

EC

The higher kind of the generic edge type parameter of this graph.

NN

The node type of the resulting graph which may be unchanged or different from this graph's node type.

Value parameters

fNode

To apply to all nodes of this graph. Since the inner node is passed you can also examine the node context. Call outer to get the value of type N of the node. If fNode returns several new nodes with none equaling to the original node, the first new node is accepted to be the result of the node transformation. For more flexibility pass your own edge mapper to the overload.

Attributes

Returns

A new graph of possibly changed node and edge types and of any new structure depending on your edge mapper(s).

Inherited from:
GraphOps
final def flatMapBound[NN, EC <: Edge[NN]](fNode: NodeT => Seq[NN], fEdge: (Seq[NN], Seq[NN]) => Seq[EC])(implicit w: E <:< AnyEdge[N]): CC[NN, EC]

Creates a new graph with nodes and edges returned by fNode respectively fEdge.

Creates a new graph with nodes and edges returned by fNode respectively fEdge.

You can call this flavor only if this graph's edge type is typed. Otherwise see flatMap.

See overload except the parameter

Value parameters

fEdge

has a simplified signature in this overload leaving out the inner edge. This comes in handy whenever you don't need to inspect inner edges.

Attributes

Inherited from:
GraphOps
def flatMapBound[NN, EC <: Edge[NN]](fNode: NodeT => Seq[NN], fEdge: (EdgeT, Seq[NN], Seq[NN]) => Seq[EC])(implicit w: E <:< AnyEdge[N]): CC[NN, EC]

Creates a new graph with nodes and edges returned by fNode respectively fEdge.

Creates a new graph with nodes and edges returned by fNode respectively fEdge.

You can call this flavor only if this graph's edge type is typed. Otherwise see flatMap.

Type parameters

EC

The edge type parameter of this graph.

NN

The node type of the resulting graph which may be unchanged or different from this graph's node type.

Value parameters

fEdge

To apply to all edges of this graph. This function is passed the current inner edge and its ends after being mapped by fNode. Since the inner edge is passed you can also examine its context. Call outer to get the outer edge of type E.

fNode

To apply to all nodes of this graph. Since the inner node is passed you can also examine the node context. Call outer to get the value of type N of the node.

Attributes

Returns

A new graph of possibly changed node and edge types and of any new structure depending on your edge mapper(s).

Inherited from:
GraphOps
def flatMapBound(fNode: NodeT => Seq[N])(implicit w1: E <:< PartialMapper): CC[N, E]

Creates a new graph with nodes returned by fNode and an edge structure that remains intact where possible.

Creates a new graph with nodes returned by fNode and an edge structure that remains intact where possible.

You can call this flavor only if this graph's edge type is typed. Otherwise see flatMap.

Value parameters

fNode

To apply to all nodes of this graph. Since the inner node is passed you can also examine the node context. Call outer to get the value of type N of the node. If fNode returns several new nodes with none equaling to the original node, the first new node is accepted to be the result of the node transformation. For more flexibility pass your own edge mapper to the overload.

Attributes

Inherited from:
GraphOps
final def flatMapDiHyper[NN, EC <: (Edge)](fNode: NodeT => Seq[NN], fDiHyperEdge: (Seq[NN], Seq[NN]) => Seq[EC[NN]], fEdge: Option[(Seq[NN], Seq[NN]) => Seq[EC[NN]]])(implicit w: E <:< AnyDiHyperEdge[N]): CC[NN, EC[NN]]

Creates a new graph with nodes and edges returned by fNode respectively fEdge.

Creates a new graph with nodes and edges returned by fNode respectively fEdge.

You can call this flavor only if this graph's edge type is generic. Otherwise see flatMapDiHyperBound.

See overload except the parameter

Value parameters

fDiHyperEdge

has a simplified signature in this overload leaving out the inner edge. This comes in handy whenever you don't need to inspect inner edges.

Attributes

Inherited from:
GraphOps
def flatMapDiHyper[NN, EC <: (Edge)](fNode: NodeT => Seq[NN], fDiHyperEdge: (EdgeT, Seq[NN], Seq[NN]) => Seq[EC[NN]], fEdge: Option[(EdgeT, Seq[NN], Seq[NN]) => Seq[EC[NN]]])(implicit w: E <:< AnyDiHyperEdge[N]): CC[NN, EC[NN]]

Creates a new graph with nodes and edges returned by fNode respectively fEdge.

Creates a new graph with nodes and edges returned by fNode respectively fEdge.

You can call this flavor only if this graph's edge type is generic. Otherwise see flatMapDiHyperBound.

Type parameters

EC

The higher kind of the generic edge type parameter of this graph.

NN

The node type of the resulting graph which may be unchanged or different from this graph's node type.

Value parameters

fDiHyperEdge

To apply to all directed hyperedges in this graph. This function is passed the existing inner directed hyperedge and its sources and targets after being mapped by fNode. Since the inner directed hyperedge is passed you can also examine the edge context. Call outer to get the outer directed hyperedge of type E.

fEdge

To apply to any directed or undirected edge in this possibly mixed graph. If not present simple edges will be mapped by the mandatory edge mapper you supply. You are recommended supplying Some unless you know that the graph does not contain any simple edge.

fNode

To apply to all nodes of this graph. Since the inner node is passed you can also examine the node context. Call outer to get the value of type N of the node.

Attributes

Returns

A new graph of possibly changed node and edge types and of any new structure depending on your edge mapper(s).

Inherited from:
GraphOps
final def flatMapDiHyperBound[NN, EC <: Edge[NN]](fNode: NodeT => Seq[NN], fDiHyperEdge: (Seq[NN], Seq[NN]) => Seq[EC], fEdge: Option[(Seq[NN], Seq[NN]) => Seq[EC]])(implicit w: E <:< AnyDiHyperEdge[N]): CC[NN, EC]

Creates a new graph with nodes and edges returned by fNode respectively fEdge.

Creates a new graph with nodes and edges returned by fNode respectively fEdge.

You can call this flavor only if this graph's edge type is typed. Otherwise see flatMapDiHyper.

See overload except the parameter

Value parameters

fDiHyperEdge

has a simplified signature in this overload leaving out the inner edge. This comes in handy whenever you don't need to inspect inner edges.

Attributes

Inherited from:
GraphOps
def flatMapDiHyperBound[NN, EC <: Edge[NN]](fNode: NodeT => Seq[NN], fDiHyperEdge: (EdgeT, Seq[NN], Seq[NN]) => Seq[EC], fEdge: Option[(EdgeT, Seq[NN], Seq[NN]) => Seq[EC]])(implicit w: E <:< AnyDiHyperEdge[N]): CC[NN, EC]

Creates a new graph with nodes and edges returned by fNode respectively fEdge.

Creates a new graph with nodes and edges returned by fNode respectively fEdge.

You can call this flavor only if this graph's edge type is typed. Otherwise see flatMapDiHyper.

Type parameters

EC

The edge type parameter of this graph.

NN

The node type of the resulting graph which may be unchanged or different from this graph's node type.

Value parameters

fDiHyperEdge

To apply to all directed hyperedges in this graph. This function is passed the existing inner directed hyperedge and its sources and targets after being mapped by fNode. Since the inner directed hyperedge is passed you can also examine the edge context. Call outer to get the outer directed hyperedge of type E.

fEdge

To apply to any directed or undirected edge in this possibly mixed graph. If not present simple edges will be mapped by the mandatory edge mapper you supply. You are recommended supplying Some unless you know that the graph does not contain any simple edge.

fNode

To apply to all nodes of this graph. Since the inner node is passed you can also examine the node context. Call outer to get the value of type N of the node.

Attributes

Returns

A new graph of possibly changed node and edge types and of any new structure depending on your edge mapper(s).

Inherited from:
GraphOps
final def flatMapHyper[NN, EC <: (Edge)](fNode: NodeT => Seq[NN], fHyperEdge: Seq[NN] => Seq[EC[NN]], fDiHyperEdge: Option[(Seq[NN], Seq[NN]) => Seq[EC[NN]]], fEdge: Option[(Seq[NN], Seq[NN]) => Seq[EC[NN]]])(implicit w: E <:< AnyHyperEdge[N]): CC[NN, EC[NN]]

Creates a new graph with nodes and edges returned by fNode respectively fEdge.

Creates a new graph with nodes and edges returned by fNode respectively fEdge.

You can call this flavor only if this graph's edge type is generic. Otherwise see flatMapHyperBound.

See overload except the parameter

Value parameters

fHyperEdge

has a simplified signature in this overload leaving out the inner edge. This comes in handy whenever you don't need to inspect inner edges.

Attributes

Inherited from:
GraphOps
def flatMapHyper[NN, EC <: (Edge)](fNode: NodeT => Seq[NN], fHyperEdge: (EdgeT, Seq[NN]) => Seq[EC[NN]], fDiHyperEdge: Option[(EdgeT, Seq[NN], Seq[NN]) => Seq[EC[NN]]], fEdge: Option[(EdgeT, Seq[NN], Seq[NN]) => Seq[EC[NN]]])(implicit w: E <:< AnyHyperEdge[N]): CC[NN, EC[NN]]

Creates a new graph with nodes and edges returned by fNode respectively fEdge.

Creates a new graph with nodes and edges returned by fNode respectively fEdge.

You can call this flavor only if this graph's edge type is generic. Otherwise see flatMapHyperBound.

Type parameters

EC

The higher kind of the generic edge type parameter of this graph.

NN

The node type of the resulting graph which may be unchanged or different from this graph's node type.

Value parameters

fDiHyperEdge

To apply to any directed hyperedge in this possibly mixed graph. If not present directed hyperedges will be mapped by the mandatory fDiHyperEdge. You are recommended supplying Some unless you know that the graph does not contain any directed hyperedge.

fEdge

To apply to any directed or undirected edge in this possibly mixed graph. If not present simple edges will be mapped by the mandatory edge mapper you supply. You are recommended supplying Some unless you know that the graph does not contain any simple edge.

fHyperEdge

To apply to all hyperedges in this graph. This function is passed the current inner hyperedge and its ends after being mapped by fNode. Since the inner hyperedge is passed you can also examine its context. Call outer to get the outer hyperedge of type E.

fNode

To apply to all nodes of this graph. Since the inner node is passed you can also examine the node context. Call outer to get the value of type N of the node.

Attributes

Returns

A new graph of possibly changed node and edge types and of any new structure depending on your edge mapper(s).

Inherited from:
GraphOps
final def flatMapHyperBound[NN, EC <: Edge[NN]](fNode: NodeT => Seq[NN], fHyperEdge: Seq[NN] => Seq[EC], fDiHyperEdge: Option[(Seq[NN], Seq[NN]) => Seq[EC]], fEdge: Option[(Seq[NN], Seq[NN]) => Seq[EC]])(implicit w: E <:< AnyHyperEdge[N]): CC[NN, EC]

Creates a new graph with nodes and edges returned by fNode respectively fEdge.

Creates a new graph with nodes and edges returned by fNode respectively fEdge.

You can call this flavor only if this graph's edge type is typed. Otherwise see flatMapHyper.

See overload except the parameter

Value parameters

fHyperEdge

has a simplified signature in this overload leaving out the inner edge. This comes in handy whenever you don't need to inspect inner edges.

Attributes

Inherited from:
GraphOps
def flatMapHyperBound[NN, EC <: Edge[NN]](fNode: NodeT => Seq[NN], fHyperEdge: (EdgeT, Seq[NN]) => Seq[EC], fDiHyperEdge: Option[(EdgeT, Seq[NN], Seq[NN]) => Seq[EC]], fEdge: Option[(EdgeT, Seq[NN], Seq[NN]) => Seq[EC]])(implicit w: E <:< AnyHyperEdge[N]): CC[NN, EC]

Creates a new graph with nodes and edges returned by fNode respectively fEdge.

Creates a new graph with nodes and edges returned by fNode respectively fEdge.

You can call this flavor only if this graph's edge type is typed. Otherwise see flatMapHyper.

Type parameters

EC

The edge type parameter of this graph.

NN

The node type of the resulting graph which may be unchanged or different from this graph's node type.

Value parameters

fDiHyperEdge

To apply to any directed hyperedge in this possibly mixed graph. If not present directed hyperedges will be mapped by the mandatory fDiHyperEdge. You are recommended supplying Some unless you know that the graph does not contain any directed hyperedge.

fEdge

To apply to any directed or undirected edge in this possibly mixed graph. If not present simple edges will be mapped by the mandatory edge mapper you supply. You are recommended supplying Some unless you know that the graph does not contain any simple edge.

fHyperEdge

To apply to all hyperedges in this graph. This function is passed the current inner hyperedge and its ends after being mapped by fNode. Since the inner hyperedge is passed you can also examine its context. Call outer to get the outer hyperedge of type E.

fNode

To apply to all nodes of this graph. Since the inner node is passed you can also examine the node context. Call outer to get the value of type N of the node.

Attributes

Returns

A new graph of possibly changed node and edge types and of any new structure depending on your edge mapper(s).

Inherited from:
GraphOps
def foldLeft[B](z: B)(opNode: (B, NodeT) => B, opEdge: (B, EdgeT) => B): B

Applies a node-specific and an edge-specific binary operator to a cumulated value. First opNode is called for all nodes than opEdge for all edges.

Applies a node-specific and an edge-specific binary operator to a cumulated value. First opNode is called for all nodes than opEdge for all edges.

Type parameters

B

the result type of the binary operator.

Value parameters

opEdge

the binary operator that is passed the cumulated value and an inner edge.

opNode

the binary operator that is passed the cumulated value and an inner node.

z

the start value that is passed to opNode the first time.

Attributes

Returns

the cumulated value.

Inherited from:
GraphOps
final def foldLeftOuter[B](z: B)(opNode: (B, N) => B, opEdge: (B, E) => B): B

Same as foldLeft except the second parameter of the binary operators.

Same as foldLeft except the second parameter of the binary operators.

Value parameters

opEdge

the binary operator that is passed the cumulated value and an outer edge.

opNode

the binary operator that is passed the cumulated value and an outer node.

Attributes

Inherited from:
GraphOps
def get(edge: E): EdgeT

Short for find(edge).get.

Short for find(edge).get.

Attributes

Throws
NoSuchElementException

if the edge is not found.

Inherited from:
GraphOps
def get(node: N): NodeT

Short for find(node).get.

Short for find(node).get.

Attributes

Throws
NoSuchElementException

if the node is not found.

Inherited from:
GraphOps
final def intersect(that: AnyGraph[N, E]): CC[N, E]

Computes the intersection between this graph and that graph.

Computes the intersection between this graph and that graph.

Attributes

Inherited from:
GraphOps
final def isCustomEdgeFilter(f: EdgePredicate): Boolean

true if f is not equivalent to anyEdge.

true if f is not equivalent to anyEdge.

Attributes

Inherited from:
GraphBase
final def isCustomNodeFilter(f: NodePredicate): Boolean

true if f is not equivalent to anyNode.

true if f is not equivalent to anyNode.

Attributes

Inherited from:
GraphBase
def isDirected: Boolean

Whether all edges of this graph are directed.

Whether all edges of this graph are directed.

Attributes

Inherited from:
GraphOps
final def isEmpty: Boolean

Whether this graph contains any node or any edge.

Whether this graph contains any node or any edge.

Attributes

Inherited from:
GraphOps
def isHyper: Boolean

Whether this graph contains at least one hyperedge.

Whether this graph contains at least one hyperedge.

Attributes

Inherited from:
GraphOps
def isMixed: Boolean

Whether this graph contains at least one directed and one undirected edge.

Whether this graph contains at least one directed and one undirected edge.

Attributes

Inherited from:
GraphOps
def isMulti: Boolean

Whether this graph contains at least one multi-edge. We defnie multi-edges by a. two or more directed edges having the same source and target a. two or more undirected edges connecting the same nodes a. two or more (directed) hyperedges that, after being decomposed into (directed) edges, yield any multy-edge as stipulated above.

Whether this graph contains at least one multi-edge. We defnie multi-edges by a. two or more directed edges having the same source and target a. two or more undirected edges connecting the same nodes a. two or more (directed) hyperedges that, after being decomposed into (directed) edges, yield any multy-edge as stipulated above.

Attributes

Inherited from:
GraphOps
final def isTrivial: Boolean

true if this graph has at most 1 node.

true if this graph has at most 1 node.

Attributes

Inherited from:
GraphOps
def iterator: Iterator[InnerElem]

Iterator over all inner nodes and edges.

Iterator over all inner nodes and edges.

Attributes

Inherited from:
GraphOps
final def map[NN, EC <: (Edge)](fNode: NodeT => NN, fEdge: (NN, NN) => EC[NN])(implicit w: E <:< AnyEdge[N]): CC[NN, EC[NN]]

Creates a new graph with nodes and edges that are computed by the supplied mapping functions.

Creates a new graph with nodes and edges that are computed by the supplied mapping functions.

See overload except the parameter

Value parameters

fEdge

has a simplified signature in this overload leaving out the inner edge. This comes in handy whenever you don't need to inspect inner edges.

Attributes

Inherited from:
GraphOps
def map[NN, EC <: (Edge)](fNode: NodeT => NN, fEdge: (EdgeT, NN, NN) => EC[NN])(implicit w: E <:< AnyEdge[N]): CC[NN, EC[NN]]

Creates a new graph with nodes and edges that are computed by the supplied mapping functions.

Creates a new graph with nodes and edges that are computed by the supplied mapping functions.

You can call this flavor only if this graph's edge type is generic. Otherwise see mapBound.

Type parameters

EC

The higher kind of the generic edge type parameter of this graph.

NN

The node type of the resulting graph which may be unchanged or different from this graph's node type.

Value parameters

fEdge

To apply to all edges of this graph. This function is passed the current inner edge and its ends after being mapped by fNode. Since the inner edge is passed you can also examine its context. Call outer to get the outer edge of type E.

fNode

To apply to all nodes of this graph. Since the inner node is passed you can also examine the node context. Call outer to get the value of type N of the node.

Attributes

Returns

The mapped graph with possibly changed node and edge type parameters.

Inherited from:
GraphOps
def map[NN, EC <: (Edge)](fNode: NodeT => NN)(implicit w1: E <:< GenericMapper, w2: EC[N] =:= E, t: ClassTag[EC[NN]]): CC[NN, EC[NN]]

Creates a new graph with nodes mapped by fNode and with an untouched edge structure otherwise.

Creates a new graph with nodes mapped by fNode and with an untouched edge structure otherwise.

You can call this flavor only if this graph's edge type is generic. Otherwise see mapBound.

If this graph also contains typed edges, the typed edge's partial map function will be called to replace the ends. If the partial function is not defined, there will be an attempt to fall back to a generic edge. If that attempt also fails the edge will be dropped. So, if you have a mixed graph with generic and typed edges, prefer mapping edges directly to avoid leaving edges out.

Type parameters

EC

The higher kind of the generic edge type parameter of this graph.

NN

The node type of the resulting graph which may be unchanged or different from this graph's node type.

Value parameters

fNode

To apply to all nodes of this graph. Since the inner node is passed you can also examine the node context. Call outer to get the value of type N of the node.

Attributes

Returns

The mapped graph with possibly changed node and edge type parameters.

Inherited from:
GraphOps
final def mapBound[NN, EC <: Edge[NN]](fNode: NodeT => NN, fEdge: (NN, NN) => EC)(implicit w: E <:< AnyEdge[N]): CC[NN, EC]

Creates a new graph with nodes and edges that are computed by the supplied mapping functions.

Creates a new graph with nodes and edges that are computed by the supplied mapping functions.

See overload except the parameter

Value parameters

fEdge

has a simplified signature in this overload leaving out the inner edge. This comes in handy whenever you don't need to inspect inner edges.

Attributes

Inherited from:
GraphOps
def mapBound[NN, EC <: Edge[NN]](fNode: NodeT => NN, fEdge: (EdgeT, NN, NN) => EC)(implicit w: E <:< AnyEdge[N]): CC[NN, EC]

Creates a new graph with nodes and edges that are computed by the supplied mapping functions.

Creates a new graph with nodes and edges that are computed by the supplied mapping functions.

You can call this flavor only if this graph's edge type is typed. Otherwise see map.

Type parameters

EC

The edge type parameter of this graph.

NN

The node type of the resulting graph which may be unchanged or different from this graph's node type.

Value parameters

fEdge

To apply to all edges of this graph. This function is passed the current inner edge and its ends after being mapped by fNode. Since the inner edge is passed you can also examine its context. Call outer to get the outer edge of type E.

fNode

To apply to all nodes of this graph. Since the inner node is passed you can also examine the node context. Call outer to get the value of type N of the node.

Attributes

Returns

The mapped graph with possibly changed node and edge type parameters.

Inherited from:
GraphOps
def mapBound(fNode: NodeT => N)(implicit w1: E <:< PartialMapper): CC[N, E]

Creates a new graph with nodes mapped by fNode and with an untouched edge structure otherwise.

Creates a new graph with nodes mapped by fNode and with an untouched edge structure otherwise.

You can call this flavor only if this graph's edge type is typed. Otherwise see map.

Value parameters

fNode

To apply to all nodes of this graph. Since the inner node is passed you can also examine the node context. Call outer to get the value of type N of the node.

Attributes

Returns

The mapped graph with possibly changed node and edge type parameters.

Inherited from:
GraphOps
final def mapDiHyper[NN, EC <: (Edge)](fNode: NodeT => NN, fDiHyperEdge: (OneOrMore[NN], OneOrMore[NN]) => EC[NN], fEdge: Option[(NN, NN) => EC[NN]])(implicit w: E <:< AnyDiHyperEdge[N]): CC[NN, EC[NN]]

Creates a new graph with nodes and edges that are computed by the supplied mapping functions.

Creates a new graph with nodes and edges that are computed by the supplied mapping functions.

You can call this flavor only if this graph's edge type is generic. Otherwise see mapDiHyperBound.

See overload except the parameter

Value parameters

fDiHyperEdge

has a simplified signature in this overload leaving out the inner edge. This comes in handy whenever you don't need to inspect inner edges.

Attributes

Inherited from:
GraphOps
def mapDiHyper[NN, EC <: (Edge)](fNode: NodeT => NN, fDiHyperEdge: (EdgeT, OneOrMore[NN], OneOrMore[NN]) => EC[NN], fEdge: Option[(EdgeT, NN, NN) => EC[NN]])(implicit w: E <:< AnyDiHyperEdge[N]): CC[NN, EC[NN]]

Creates a new graph with nodes and edges that are computed by the supplied mapping functions.

Creates a new graph with nodes and edges that are computed by the supplied mapping functions.

You can call this flavor only if this graph's edge type is generic. Otherwise see mapDiHyperBound.

Type parameters

EC

The higher kind of the generic edge type parameter of this graph.

NN

The node type of the resulting graph which may be unchanged or different from this graph's node type.

Value parameters

fDiHyperEdge

To apply to all directed hyperedges in this graph. This function is passed the existing inner directed hyperedge and its sources and targets after being mapped by fNode. Since the inner directed hyperedge is passed you can also examine the edge context. Call outer to get the outer directed hyperedge of type E.

fEdge

To apply to any directed or undirected edge in this possibly mixed graph. If not present simple edges will be mapped by the mandatory edge mapper you supply. You are recommended supplying Some unless you know that the graph does not contain any simple edge.

fNode

To apply to all nodes of this graph. Since the inner node is passed you can also examine the node context. Call outer to get the value of type N of the node.

Attributes

Returns

The mapped graph with possibly changed node and edge type parameters.

Inherited from:
GraphOps
final def mapDiHyperBound[NN, EC <: Edge[NN]](fNode: NodeT => NN, fDiHyperEdge: (OneOrMore[NN], OneOrMore[NN]) => EC, fEdge: Option[(NN, NN) => EC])(implicit w: E <:< AnyDiHyperEdge[N]): CC[NN, EC]

Creates a new graph with nodes and edges that are computed by the supplied mapping functions.

Creates a new graph with nodes and edges that are computed by the supplied mapping functions.

You can call this flavor only if this graph's edge type is typed. Otherwise see mapDiHyper.

See overload except the parameter

Value parameters

fDiHyperEdge

has a simplified signature in this overload leaving out the inner edge. This comes in handy whenever you don't need to inspect inner edges.

Attributes

Inherited from:
GraphOps
def mapDiHyperBound[NN, EC <: Edge[NN]](fNode: NodeT => NN, fDiHyperEdge: (EdgeT, OneOrMore[NN], OneOrMore[NN]) => EC, fEdge: Option[(EdgeT, NN, NN) => EC])(implicit w: E <:< AnyDiHyperEdge[N]): CC[NN, EC]

Creates a new graph with nodes and edges that are computed by the supplied mapping functions.

Creates a new graph with nodes and edges that are computed by the supplied mapping functions.

You can call this flavor only if this graph's edge type is typed. Otherwise see mapDiHyper.

Type parameters

EC

The edge type parameter of this graph.

NN

The node type of the resulting graph which may be unchanged or different from this graph's node type.

Value parameters

fDiHyperEdge

To apply to all directed hyperedges in this graph. This function is passed the existing inner directed hyperedge and its sources and targets after being mapped by fNode. Since the inner directed hyperedge is passed you can also examine the edge context. Call outer to get the outer directed hyperedge of type E.

fEdge

To apply to any directed or undirected edge in this possibly mixed graph. If not present simple edges will be mapped by the mandatory edge mapper you supply. You are recommended supplying Some unless you know that the graph does not contain any simple edge.

fNode

To apply to all nodes of this graph. Since the inner node is passed you can also examine the node context. Call outer to get the value of type N of the node.

Attributes

Returns

The mapped graph with possibly changed node and edge type parameters.

Inherited from:
GraphOps
final def mapHyper[NN, EC <: (Edge)](fNode: NodeT => NN, fHyperEdge: Several[NN] => EC[NN], fDiHyperEdge: Option[(OneOrMore[NN], OneOrMore[NN]) => EC[NN]], fEdge: Option[(NN, NN) => EC[NN]])(implicit w: E <:< AnyHyperEdge[N]): CC[NN, EC[NN]]

Creates a new graph with nodes and edges that are computed by the supplied mapping functions.

Creates a new graph with nodes and edges that are computed by the supplied mapping functions.

You can call this flavor only if this graph's edge type is generic. Otherwise see mapHyperBound.

See overload except the parameter

Value parameters

fHyperEdge

has a simplified signature in this overload leaving out the inner edge. This comes in handy whenever you don't need to inspect inner edges.

Attributes

Inherited from:
GraphOps
def mapHyper[NN, EC <: (Edge)](fNode: NodeT => NN, fHyperEdge: (EdgeT, Several[NN]) => EC[NN], fDiHyperEdge: Option[(EdgeT, OneOrMore[NN], OneOrMore[NN]) => EC[NN]], fEdge: Option[(EdgeT, NN, NN) => EC[NN]])(implicit w: E <:< AnyHyperEdge[N]): CC[NN, EC[NN]]

Creates a new graph with nodes and edges that are computed by the supplied mapping functions.

Creates a new graph with nodes and edges that are computed by the supplied mapping functions.

You can call this flavor only if this graph's edge type is generic. Otherwise see mapHyperBound.

Type parameters

EC

The higher kind of the generic edge type parameter of this graph.

NN

The node type of the resulting graph which may be unchanged or different from this graph's node type.

Value parameters

fDiHyperEdge

To apply to any directed hyperedge in this possibly mixed graph. If not present directed hyperedges will be mapped by the mandatory fDiHyperEdge. You are recommended supplying Some unless you know that the graph does not contain any directed hyperedge.

fEdge

To apply to any directed or undirected edge in this possibly mixed graph. If not present simple edges will be mapped by the mandatory edge mapper you supply. You are recommended supplying Some unless you know that the graph does not contain any simple edge.

fHyperEdge

To apply to all hyperedges in this graph. This function is passed the current inner hyperedge and its ends after being mapped by fNode. Since the inner hyperedge is passed you can also examine its context. Call outer to get the outer hyperedge of type E.

fNode

To apply to all nodes of this graph. Since the inner node is passed you can also examine the node context. Call outer to get the value of type N of the node.

Attributes

Returns

The mapped graph with possibly changed node and edge type parameters.

Inherited from:
GraphOps
final def mapHyperBound[NN, EC <: Edge[NN]](fNode: NodeT => NN, fHyperEdge: Several[NN] => EC, fDiHyperEdge: Option[(OneOrMore[NN], OneOrMore[NN]) => EC], fEdge: Option[(NN, NN) => EC])(implicit w: E <:< AnyHyperEdge[N]): CC[NN, EC]

Creates a new graph with nodes and edges that are computed by the supplied mapping functions.

Creates a new graph with nodes and edges that are computed by the supplied mapping functions.

You can call this flavor only if this graph's edge type is typed. Otherwise see mapHyper.

See overload except the parameter

Value parameters

fHyperEdge

has a simplified signature in this overload leaving out the inner edge. This comes in handy whenever you don't need to inspect inner edges.

Attributes

Inherited from:
GraphOps
def mapHyperBound[NN, EC <: Edge[NN]](fNode: NodeT => NN, fHyperEdge: (EdgeT, Several[NN]) => EC, fDiHyperEdge: Option[(EdgeT, OneOrMore[NN], OneOrMore[NN]) => EC], fEdge: Option[(EdgeT, NN, NN) => EC])(implicit w: E <:< AnyHyperEdge[N]): CC[NN, EC]

Creates a new graph with nodes and edges that are computed by the supplied mapping functions.

Creates a new graph with nodes and edges that are computed by the supplied mapping functions.

You can call this flavor only if this graph's edge type is typed. Otherwise see mapHyper.

Type parameters

EC

The edge type parameter of this graph.

NN

The node type of the resulting graph which may be unchanged or different from this graph's node type.

Value parameters

fDiHyperEdge

To apply to any directed hyperedge in this possibly mixed graph. If not present directed hyperedges will be mapped by the mandatory fDiHyperEdge. You are recommended supplying Some unless you know that the graph does not contain any directed hyperedge.

fEdge

To apply to any directed or undirected edge in this possibly mixed graph. If not present simple edges will be mapped by the mandatory edge mapper you supply. You are recommended supplying Some unless you know that the graph does not contain any simple edge.

fHyperEdge

To apply to all hyperedges in this graph. This function is passed the current inner hyperedge and its ends after being mapped by fNode. Since the inner hyperedge is passed you can also examine its context. Call outer to get the outer hyperedge of type E.

fNode

To apply to all nodes of this graph. Since the inner node is passed you can also examine the node context. Call outer to get the value of type N of the node.

Attributes

Returns

The mapped graph with possibly changed node and edge type parameters.

Inherited from:
GraphOps
def nodes: NodeSetT

The node (vertex) set of this Graph commonly referred to as V(G).

The node (vertex) set of this Graph commonly referred to as V(G).

Attributes

Returns

Set of all contained nodes.

Inherited from:
GraphBase
final def nonTrivial: Boolean

true if this graph has at least 2 nodes.

true if this graph has at least 2 nodes.

Attributes

Inherited from:
GraphOps
final def order: Int

The order - commonly referred to as |G| - of this graph equaling to the number of nodes.

The order - commonly referred to as |G| - of this graph equaling to the number of nodes.

Attributes

Inherited from:
GraphBase
def outerIterator: Iterator[OuterElem]

Iterator over all inner nodes and edges.

Iterator over all inner nodes and edges.

Attributes

Inherited from:
GraphOps
protected def removedAll(isolatedNodes: IterableOnce[N], edges: IterableOnce[E]): CC[N, E]

Attributes

Inherited from:
GraphOps
final def size: Int

The size - commonly referred to as |E| - of this graph equaling to the number of edges.

The size - commonly referred to as |E| - of this graph equaling to the number of edges.

Attributes

Inherited from:
GraphBase
def toIterable: Iterable[InnerElem]

Iterable over all nodes and edges.

Iterable over all nodes and edges.

Attributes

Inherited from:
GraphOps
def toOuterIterable: Iterable[OuterElem]

Iterable over all nodes and edges.

Iterable over all nodes and edges.

Attributes

Inherited from:
GraphOps
def totalWeight: Double

The Sum of the weight of all edges.

The Sum of the weight of all edges.

Attributes

Inherited from:
GraphBase
final def union[N2 >: N, E2 >: E <: Edge[N2]](that: AnyGraph[N2, E2]): CC[N2, E2]

Computes the union between this graph and that graph.

Computes the union between this graph and that graph.

Attributes

Inherited from:
GraphOps
final def |(that: AnyGraph[N, E]): CC[N, E]

Alias for union.

Alias for union.

Attributes

Inherited from:
GraphOps

Inherited fields

final val anyEdge: EdgePredicate

Default edge filter letting path all edges (non-filter).

Default edge filter letting path all edges (non-filter).

Attributes

Inherited from:
GraphBase
final val anyNode: NodePredicate

Default node filter letting traverse all nodes (non-filter).

Default node filter letting traverse all nodes (non-filter).

Attributes

Inherited from:
GraphBase
final lazy val defaultEdgeOrdering: EdgeOrdering

Attributes

Inherited from:
GraphBase
final lazy val defaultNodeOrdering: NodeOrdering

Attributes

Inherited from:
GraphBase
final val noEdge: EdgePredicate

Edge predicate always returning false.

Edge predicate always returning false.

Attributes

Inherited from:
GraphBase
final val noNode: NodePredicate

Node predicate always returning false.

Node predicate always returning false.

Attributes

Inherited from:
GraphBase
Generated with