Graph Core
2.0.2
API
Generated with
Graph Core/scalax.collection/GraphLike/NodeBase

NodeBase

scalax.collection.GraphLike.NodeBase
protected trait NodeBase extends GraphInnerNode

Attributes

Graph
Supertypes
trait InnerNode
trait InnerElem
trait Node
trait Serializable
class Object
trait Matchable
class Any
Show all
Known subtypes
Self type

Members list

Value members

Concrete methods

final def isContaining[N, E <: Edge[N]](g: GraphBase[N, E, CC]): Boolean

Inherited methods

def canEqual(that: Any): Boolean

Attributes

Inherited from:
BaseInnerNode
def connectionsWith(other: NodeT): Set[EdgeT] & FilterableSet[EdgeT]

All edges connecting this node with other including outgoing and incoming edges. This method is useful in case of multigraphs.

All edges connecting this node with other including outgoing and incoming edges. This method is useful in case of multigraphs.

Value parameters

other

A node which is possibly connected with this node.

Attributes

Returns

All edges connecting this node with other. If other equals this node all hooks are returned. If other is not connected with this node an empty set is returned.

Inherited from:
BaseInnerNode
final def containingGraph: ThisGraph

The Graph instance that contains this inner edge.

The Graph instance that contains this inner edge.

Attributes

Inherited from:
GraphInnerNode
def degree: Int

The degree of this node.

The degree of this node.

Attributes

Returns

the number of edges that connect to this node. An edge that connects to this node at more than one ends (loop) is counted as much times as it is connected to this node.

Inherited from:
BaseInnerNode
def diPredecessors: Set[NodeT]

All direct predecessors of this node, also called ''predecessor set'' or ''open in-neighborhood'': source nodes of directed incident edges and / or adjacent nodes of undirected incident edges excluding this node.

All direct predecessors of this node, also called ''predecessor set'' or ''open in-neighborhood'': source nodes of directed incident edges and / or adjacent nodes of undirected incident edges excluding this node.

Attributes

Returns

set of all direct predecessors of this node.

Inherited from:
BaseInnerNode
def diSuccessors: Set[NodeT]

All direct successors of this node, also called ''successor set'' or ''open out-neighborhood'': target nodes of directed incident edges and / or adjacent nodes of undirected incident edges excluding this node.

All direct successors of this node, also called ''successor set'' or ''open out-neighborhood'': target nodes of directed incident edges and / or adjacent nodes of undirected incident edges excluding this node.

Attributes

Returns

set of all direct successors of this node.

Inherited from:
BaseInnerNode
def edges: ExtSet[EdgeT]

All edges at this node - commonly denoted as E(v).

All edges at this node - commonly denoted as E(v).

Attributes

Returns

all edges connecting to this node.

Inherited from:
BaseInnerNode
override def equals(other: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

  • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
  • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Value parameters

that

the object to compare against this object for equality.

Attributes

Returns

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
BaseInnerNode -> Any
Inherited from:
BaseInnerNode
def findIncomingFrom(from: NodeT): Option[EdgeT]

An edge at from having this node as a successor.

An edge at from having this node as a successor.

Value parameters

from

The node being at an edge which has this node as a successor.

Attributes

Returns

An edges at from having this node as a successor. If from equals this node a hook may be returned. If from is not an adjacent node None is returned.

Inherited from:
BaseInnerNode
def findOutgoingTo(to: NodeT): Option[EdgeT]

An outgoing edge connecting this node with to.

An outgoing edge connecting this node with to.

Value parameters

to

The node which is the end point of an edge starting at this node.

Attributes

Returns

One of possibly several edges connecting this node with to. If to equals this node a hook may be returned. If to is not an adjacent node None is returned.

Inherited from:
BaseInnerNode
def hasOnlyHooks: Boolean

Checks whether this node has only hooks or no edges at all.

Checks whether this node has only hooks or no edges at all.

Attributes

Returns

true if this node has only hooks or it isolated.

Inherited from:
BaseInnerNode
def hasPredecessors: Boolean

Whether this node has any predecessors.

Whether this node has any predecessors.

Attributes

Inherited from:
BaseInnerNode
def hasSuccessors: Boolean

Whether this node has any successors.

Whether this node has any successors.

Attributes

Inherited from:
BaseInnerNode
override def hashCode: Int

Calculate a hash code value for the object.

Calculate a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

Attributes

Returns

the hash code value for this object.

Definition Classes
BaseInnerNode -> Any
Inherited from:
BaseInnerNode
def hook: Option[EdgeT]

Attributes

Returns

A looping edge out of one or more at this node or None if this node has no looping edge.

Inherited from:
BaseInnerNode
def inDegree(nodeFilter: NodePredicate, edgeFilter: EdgePredicate, includeHooks: Boolean, ignoreMultiEdges: Boolean): Int

The incoming degree of this node after applying some filters to the incoming edges and predecessors.

The incoming degree of this node after applying some filters to the incoming edges and predecessors.

Attributes

Inherited from:
BaseInnerNode
def inDegree: Int

The incoming degree of this node.

The incoming degree of this node.

Attributes

Returns

the number of edges that come in to this node including undirected edges. Loops count once each.

Inherited from:
BaseInnerNode
final def inNeighbors: Set[NodeT]

Synonym for diPredecessors.

Synonym for diPredecessors.

Attributes

Inherited from:
BaseInnerNode
def incoming: Set[EdgeT] & FilterableSet[EdgeT]

Incoming edges of this node.

Incoming edges of this node.

Attributes

Returns

set of all edges incoming to of this including undirected edges.

Inherited from:
BaseInnerNode
def incomingFrom(from: NodeT): Set[EdgeT] & FilterableSet[EdgeT]

All incoming edges connecting from with this node.

All incoming edges connecting from with this node.

Value parameters

from

The node with zero, one or more edges having this node as a direct successor.

Attributes

Returns

All edges at from having this node as a direct successor. If from equals this node all hooks are returned. If from is not an adjacent node an empty set is returned.

Inherited from:
BaseInnerNode
final def innerEdgeTraverser(implicit parameters: Parameters): InnerEdgeTraverser

Instantiates an InnerEdgeTraverser which extends scala.collection.Iterable with elements of type EdgeT and sets its root to this node. To start a traversal call one of the graph traversal methods or any appropriate method inherited from scala.collection.Iterable on this instance.

Instantiates an InnerEdgeTraverser which extends scala.collection.Iterable with elements of type EdgeT and sets its root to this node. To start a traversal call one of the graph traversal methods or any appropriate method inherited from scala.collection.Iterable on this instance.

Value parameters

parameters

The properties controlling subsequent traversals.

Attributes

Inherited from:
TraverserInnerNode
final def innerElemTraverser(implicit parameters: Parameters): InnerElemTraverser

Instantiates an InnerElemTraverser which extends scala.collection.Iterable with elements of type InnerElem and sets its root to this node. To start a traversal call one of the graph traversal methods or any appropriate method inherited from scala.collection.Iterable on this instance.

Instantiates an InnerElemTraverser which extends scala.collection.Iterable with elements of type InnerElem and sets its root to this node. To start a traversal call one of the graph traversal methods or any appropriate method inherited from scala.collection.Iterable on this instance.

Value parameters

parameters

The properties controlling subsequent traversals.

Attributes

Inherited from:
TraverserInnerNode
final def innerNodeDownUpTraverser(implicit parameters: Parameters): InnerNodeDownUpTraverser

Instantiates an InnerNodeDownUpTraverser which extends scala.collection.Iterable with elements of type (Boolean, NodeT) and sets its root to this node. To start a traversal call one of the graph traversal methods or any appropriate method inherited from scala.collection.Iterable on this instance.

Instantiates an InnerNodeDownUpTraverser which extends scala.collection.Iterable with elements of type (Boolean, NodeT) and sets its root to this node. To start a traversal call one of the graph traversal methods or any appropriate method inherited from scala.collection.Iterable on this instance.

Value parameters

parameters

The properties controlling subsequent traversals.

Attributes

Inherited from:
TraverserInnerNode
final def innerNodeTraverser(implicit parameters: Parameters): InnerNodeTraverser

Instantiates an InnerNodeTraverser which extends scala.collection.Iterable with elements of type NodeT and sets its root to this node. To start a traversal call one of the graph traversal methods or any appropriate method inherited from scala.collection.Iterable on this instance.

Instantiates an InnerNodeTraverser which extends scala.collection.Iterable with elements of type NodeT and sets its root to this node. To start a traversal call one of the graph traversal methods or any appropriate method inherited from scala.collection.Iterable on this instance.

Value parameters

parameters

The properties controlling subsequent traversals.

Attributes

Inherited from:
TraverserInnerNode
def isDirectPredecessorOf(that: NodeT): Boolean

Whether that is an adjacent (direct successor) to this node.

Whether that is an adjacent (direct successor) to this node.

Value parameters

that

The node to check for adjacency.

Attributes

Returns

true if that is adjacent to this node.

Inherited from:
BaseInnerNode
def isIndependentOf(that: NodeT): Boolean

Whether that is independent of this node meaning that there exists no edge connecting this node with that.

Whether that is independent of this node meaning that there exists no edge connecting this node with that.

Value parameters

that

The node to check for independency.

Attributes

Returns

true if that node is independent of this node.

Inherited from:
BaseInnerNode
final def isIsolated: Boolean

true if this node's degree equals to 0.

true if this node's degree equals to 0.

Attributes

Inherited from:
BaseInnerNode
final def isLeaf: Boolean

true if this node's degree equals to 1.

true if this node's degree equals to 1.

Attributes

Inherited from:
BaseInnerNode
def neighbors: Set[NodeT]

All adjacent nodes (direct successors and predecessors) of this node, also called ''open neighborhood'' excluding this node.

All adjacent nodes (direct successors and predecessors) of this node, also called ''open neighborhood'' excluding this node.

Attributes

Returns

set of all neighbors.

Inherited from:
BaseInnerNode
def outDegree(nodeFilter: NodePredicate, edgeFilter: EdgePredicate, includeHooks: Boolean, ignoreMultiEdges: Boolean): Int

The outgoing degree of this node after applying some filters to the outgoing edges and successors.

The outgoing degree of this node after applying some filters to the outgoing edges and successors.

Attributes

Inherited from:
BaseInnerNode
def outDegree: Int

The outgoing degree of this node.

The outgoing degree of this node.

Attributes

Returns

the number of edges that go out from this node including undirected edges. Loops count once each.

Inherited from:
BaseInnerNode
final def outNeighbors: Set[NodeT]

Synonym for diSuccessors.

Synonym for diSuccessors.

Attributes

Inherited from:
BaseInnerNode
def outer: N

The outer node as supplied by instantiation or addition.

The outer node as supplied by instantiation or addition.

Attributes

Inherited from:
InnerNode
final def outerEdgeTraverser(implicit parameters: Parameters): OuterEdgeTraverser

Instantiates an OuterEdgeTraverser which extends scala.collection.Iterable with elements of type E[N] and sets its root to this node. To start a traversal call one of the graph traversal methods or any appropriate method inherited from scala.collection.Iterable on this instance.

Instantiates an OuterEdgeTraverser which extends scala.collection.Iterable with elements of type E[N] and sets its root to this node. To start a traversal call one of the graph traversal methods or any appropriate method inherited from scala.collection.Iterable on this instance.

Value parameters

parameters

The properties controlling subsequent traversals.

Attributes

Inherited from:
TraverserInnerNode
final def outerElemTraverser(implicit parameters: Parameters): OuterElemTraverser

Instantiates an OuterElemTraverser which extends scala.collection.Iterable with elements of type OuterElem and sets its root to this node. To start a traversal call one of the graph traversal methods or any appropriate method inherited from scala.collection.Iterable on this instance.

Instantiates an OuterElemTraverser which extends scala.collection.Iterable with elements of type OuterElem and sets its root to this node. To start a traversal call one of the graph traversal methods or any appropriate method inherited from scala.collection.Iterable on this instance.

Value parameters

parameters

The properties controlling subsequent traversals.

Attributes

Inherited from:
TraverserInnerNode
final def outerNodeDownUpTraverser(implicit parameters: Parameters): OuterNodeDownUpTraverser

Instantiates an OuterNodeDownUpTraverser which extends scala.collection.Iterable with elements of type (Boolean, N) and sets its root to this node. To start a traversal call one of the graph traversal methods or any appropriate method inherited from scala.collection.Iterable on this instance.

Instantiates an OuterNodeDownUpTraverser which extends scala.collection.Iterable with elements of type (Boolean, N) and sets its root to this node. To start a traversal call one of the graph traversal methods or any appropriate method inherited from scala.collection.Iterable on this instance.

Value parameters

parameters

The properties controlling subsequent traversals.

Attributes

Inherited from:
TraverserInnerNode
final def outerNodeTraverser(implicit parameters: Parameters): OuterNodeTraverser

Instantiates an OuterNodeTraverser which extends scala.collection.Iterable with elements of type N and sets its root to this node. To start a traversal call one of the graph traversal methods or any appropriate method inherited from scala.collection.Iterable on this instance.

Instantiates an OuterNodeTraverser which extends scala.collection.Iterable with elements of type N and sets its root to this node. To start a traversal call one of the graph traversal methods or any appropriate method inherited from scala.collection.Iterable on this instance.

Value parameters

parameters

The properties controlling subsequent traversals.

Attributes

Inherited from:
TraverserInnerNode
def outgoing: Set[EdgeT] & FilterableSet[EdgeT]

All edges outgoing from this node.

All edges outgoing from this node.

Attributes

Returns

set of all edges outgoing from this node including undirected edges and hooks.

Inherited from:
BaseInnerNode
def outgoingTo(to: NodeT): Set[EdgeT] & FilterableSet[EdgeT]

All outgoing edges connecting this node with to.

All outgoing edges connecting this node with to.

Value parameters

to

The node which is the end point of zero, one or more edges starting at this node.

Attributes

Returns

All edges connecting this node with to. If to equals this node all hooks are returned. If to is not an adjacent an empty set is returned.

Inherited from:
BaseInnerNode
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
BaseInnerNode -> Any
Inherited from:
BaseInnerNode
Generated with