abstract class NodeBase extends InnerNode
- Attributes
- protected
- Alphabetic
- By Inheritance
- NodeBase
- InnerNode
- InnerElem
- Node
- Serializable
- Serializable
- InnerNodeParam
- NodeParam
- OutParam
- Param
- AnyRef
- Any
- by anyToNode
- by EdgeAssoc
- by CollectionsHaveToParArray
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
- new NodeBase()
Abstract Value Members
-
abstract
def
addDiPredecessors(edge: EdgeT, add: (NodeT) ⇒ Unit): Unit
- Attributes
- protected[scalax.collection]
- Definition Classes
- InnerNode
-
abstract
def
addDiSuccessors(edge: EdgeT, add: (NodeT) ⇒ Unit): Unit
- Attributes
- protected[scalax.collection]
- Definition Classes
- InnerNode
-
abstract
def
addNeighbors(edge: EdgeT, add: (NodeT) ⇒ Unit): Unit
- Attributes
- protected[scalax.collection]
- Definition Classes
- InnerNode
-
abstract
def
connectionsWith(other: NodeT): Set[EdgeT] with FilterableSet[EdgeT]
All edges connecting this node with
otherincluding outgoing and incoming edges.All edges connecting this node with
otherincluding outgoing and incoming edges. This method is useful in case of multigraphs.- other
A node which is possibly connected with this node.
- returns
All edges connecting this node with
other. Ifotherequals this node all hooks are returned. Ifotheris not connected with this node an empty set is returned.
- Definition Classes
- InnerNode
-
abstract
def
degree: Int
The degree of this node.
The degree of this node.
- returns
the number of edges that connect to this node. An edge that connects to this node at more than one ends (loop) is counted as much times as it is connected to this node.
- Definition Classes
- InnerNode
-
abstract
def
diPredecessors: Set[NodeT]
All direct predecessors of this node, also called predecessor set or open in-neighborhood: source nodes of directed incident edges and / or adjacent nodes of undirected incident edges excluding this node.
All direct predecessors of this node, also called predecessor set or open in-neighborhood: source nodes of directed incident edges and / or adjacent nodes of undirected incident edges excluding this node.
- returns
set of all direct predecessors of this node.
- Definition Classes
- InnerNode
-
abstract
def
diSuccessors: Set[NodeT]
All direct successors of this node, also called successor set or open out-neighborhood: target nodes of directed incident edges and / or adjacent nodes of undirected incident edges excluding this node.
All direct successors of this node, also called successor set or open out-neighborhood: target nodes of directed incident edges and / or adjacent nodes of undirected incident edges excluding this node.
- returns
set of all direct successors of this node.
- Definition Classes
- InnerNode
-
abstract
def
edges: ExtSet[EdgeT]
All edges at this node - commonly denoted as E(v).
All edges at this node - commonly denoted as E(v).
- returns
all edges connecting to this node.
- Definition Classes
- InnerNode
-
abstract
def
findIncomingFrom(from: NodeT): Option[EdgeT]
An edge at
fromhaving this node as a successor.An edge at
fromhaving this node as a successor.- from
The node being at an edge which has this node as a successor.
- returns
An edges at
fromhaving this node as a successor. Iffromequals this node a hook may be returned. Iffromis not an adjacent nodeNoneis returned.
- Definition Classes
- InnerNode
-
abstract
def
findOutgoingTo(to: NodeT): Option[EdgeT]
An outgoing edge connecting this node with
to.An outgoing edge connecting this node with
to.- to
The node which is the end point of an edge starting at this node.
- returns
One of possibly several edges connecting this node with
to. Iftoequals this node a hook may be returned. Iftois not an adjacent nodeNoneis returned.
- Definition Classes
- InnerNode
-
abstract
def
hasOnlyHooks: Boolean
Checks whether this node has only hooks or no edges at all.
Checks whether this node has only hooks or no edges at all.
- returns
trueif this node has only hooks or it isolated.
- Definition Classes
- InnerNode
-
abstract
def
hasPredecessors: Boolean
Whether this node has any predecessors.
Whether this node has any predecessors.
- Definition Classes
- InnerNode
-
abstract
def
hasSuccessors: Boolean
Whether this node has any successors.
Whether this node has any successors.
- Definition Classes
- InnerNode
-
abstract
def
hook: Option[EdgeT]
- returns
A looping edge out of one or more at this node or
Noneif this node has no looping edge.
- Definition Classes
- InnerNode
-
abstract
def
inDegree(nodeFilter: NodeFilter, edgeFilter: EdgeFilter = anyEdge, includeHooks: Boolean = false, ignoreMultiEdges: Boolean = true): Int
The incoming degree of this node after applying some filters to the incoming edges and predecessors.
The incoming degree of this node after applying some filters to the incoming edges and predecessors.
- Definition Classes
- InnerNode
-
abstract
def
inDegree: Int
The incoming degree of this node.
The incoming degree of this node.
- returns
the number of edges that come in to this node including undirected edges. Loops count once each.
- Definition Classes
- InnerNode
-
abstract
def
incoming: Set[EdgeT] with FilterableSet[EdgeT]
Incoming edges of this node.
Incoming edges of this node.
- returns
set of all edges incoming to of this including undirected edges.
- Definition Classes
- InnerNode
-
abstract
def
incomingFrom(from: NodeT): Set[EdgeT] with FilterableSet[EdgeT]
All incoming edges connecting
fromwith this node.All incoming edges connecting
fromwith this node.- from
The node with zero, one or more edges having this node as a direct successor.
- returns
All edges at
fromhaving this node as a direct successor. Iffromequals this node all hooks are returned. Iffromis not an adjacent node an empty set is returned.
- Definition Classes
- InnerNode
-
abstract
def
isContaining[N, E[X] <: EdgeLikeIn[X]](g: GraphBase[N, E]): Boolean
- Definition Classes
- InnerNodeParam
-
abstract
def
isDirectPredecessorOf(that: NodeT): Boolean
Whether
thatis an adjacent (direct successor) to this node.Whether
thatis an adjacent (direct successor) to this node.- that
The node to check for adjacency.
- returns
trueifthatis adjacent to this node.
- Definition Classes
- InnerNode
-
abstract
def
isIndependentOf(that: NodeT): Boolean
Whether
thatis independent of this node meaning that there exists no edge connecting this node withthat.Whether
thatis independent of this node meaning that there exists no edge connecting this node withthat.- that
The node to check for independency.
- returns
trueifthatnode is independent of this node.
- Definition Classes
- InnerNode
-
abstract
def
neighbors: Set[NodeT]
All adjacent nodes (direct successors and predecessors) of this node, also called open neighborhood excluding this node.
All adjacent nodes (direct successors and predecessors) of this node, also called open neighborhood excluding this node.
- returns
set of all neighbors.
- Definition Classes
- InnerNode
-
abstract
def
outDegree(nodeFilter: NodeFilter, edgeFilter: EdgeFilter = anyEdge, includeHooks: Boolean = false, ignoreMultiEdges: Boolean = true): Int
The outgoing degree of this node after applying some filters to the outgoing edges and successors.
The outgoing degree of this node after applying some filters to the outgoing edges and successors.
- Definition Classes
- InnerNode
-
abstract
def
outDegree: Int
The outgoing degree of this node.
The outgoing degree of this node.
- returns
the number of edges that go out from this node including undirected edges. Loops count once each.
- Definition Classes
- InnerNode
-
abstract
def
outgoing: Set[EdgeT] with FilterableSet[EdgeT]
All edges outgoing from this node.
All edges outgoing from this node.
- returns
set of all edges outgoing from this node including undirected edges and hooks.
- Definition Classes
- InnerNode
-
abstract
def
outgoingTo(to: NodeT): Set[EdgeT] with FilterableSet[EdgeT]
All outgoing edges connecting this node with
to.All outgoing edges connecting this node with
to.- to
The node which is the end point of zero, one or more edges starting at this node.
- returns
All edges connecting this node with
to. Iftoequals this node all hooks are returned. Iftois not an adjacent an empty set is returned.
- Definition Classes
- InnerNode
-
abstract
def
value: N
The outer node as supplied at instantiation time or while adding nodes this graph.
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (NodeBase, B)
-
final
def
<~(from: NodeT): Set[EdgeT] with FilterableSet[EdgeT]
Synonym for
incomingFrom.Synonym for
incomingFrom.- Definition Classes
- InnerNode
- Annotations
- @inline()
-
final
def
<~: Set[EdgeT] with FilterableSet[EdgeT]
Synonym for
incoming.Synonym for
incoming.- Definition Classes
- InnerNode
- Annotations
- @inline()
-
final
def
<~?(from: NodeT): Option[EdgeT]
Synonym for
findIncomingFrom.Synonym for
findIncomingFrom.- Definition Classes
- InnerNode
- Annotations
- @inline()
-
final
def
<~|: Set[NodeT]
Synonym for
diPredecessors.Synonym for
diPredecessors.- Definition Classes
- InnerNode
- Annotations
- @inline()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
final
def
asNodeT[N <: N, E[X] <: EdgeLikeIn[X], G <: GraphBase[N, E] with Singleton](g: G): GraphPredef.InnerNodeParam.asNodeT.G.NodeT
- Attributes
- protected[scalax.collection]
- Definition Classes
- InnerNodeParam
-
final
def
asNodeTProjection[N <: N, E[X] <: EdgeLikeIn[X]]: NodeT
- Attributes
- protected[scalax.collection]
- Definition Classes
- InnerNodeParam
-
def
canEqual(that: Any): Boolean
- Definition Classes
- InnerNode
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
- def ensuring(cond: (NodeBase) ⇒ Boolean, msg: ⇒ Any): NodeBase
- def ensuring(cond: (NodeBase) ⇒ Boolean): NodeBase
- def ensuring(cond: Boolean, msg: ⇒ Any): NodeBase
- def ensuring(cond: Boolean): NodeBase
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(other: Any): Boolean
- Definition Classes
- InnerNode → AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
fold[N <: N, E[X] <: EdgeLikeIn[X], G <: GraphBase[N, E] with Singleton, T](g: G)(fa: (GraphPredef.InnerNodeParam.fold.G.NodeT) ⇒ T, fb: (NodeT) ⇒ T): T
- Definition Classes
- InnerNodeParam
- def formatted(fmtstr: String): String
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- InnerNode → AnyRef → Any
-
final
def
inNeighbors: Set[NodeT]
Synonym for
diPredecessors.Synonym for
diPredecessors.- Definition Classes
- InnerNode
- Annotations
- @inline()
-
def
isDefined: Boolean
- Definition Classes
- Param
-
def
isEdge: Boolean
- Definition Classes
- NodeParam
- def isIn: Boolean
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
isIsolated: Boolean
trueif this node's degree equals to 0.trueif this node's degree equals to 0.- Definition Classes
- InnerNode
- Annotations
- @inline()
-
final
def
isLeaf: Boolean
trueif this node's degree equals to 1.trueif this node's degree equals to 1.- Definition Classes
- InnerNode
- Annotations
- @inline()
-
def
isNode: Boolean
- Definition Classes
- NodeParam
- def isOut: Boolean
-
val
n1: NodeBase
- Implicit
- This member is added by an implicit conversion from NodeBase to EdgeAssoc[NodeBase] performed by method EdgeAssoc in scalax.collection.GraphPredef.
- Definition Classes
- EdgeAssoc
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
outNeighbors: Set[NodeT]
Synonym for
diSuccessors.Synonym for
diSuccessors.- Definition Classes
- InnerNode
- Annotations
- @inline()
-
def
stringPrefix: String
- Definition Classes
- NodeParam
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
final
def
toNodeT[N <: N, E[X] <: EdgeLikeIn[X], G <: GraphBase[N, E] with Singleton](g: G)(f: (NodeT) ⇒ GraphPredef.InnerNodeParam.toNodeT.G.NodeT): GraphPredef.InnerNodeParam.toNodeT.G.NodeT
- Definition Classes
- InnerNodeParam
-
final
def
toOuter: N
Synonym for
value.Synonym for
value.- Definition Classes
- InnerNode
- Annotations
- @inline()
-
def
toParArray: ParArray[T]
- Implicit
- This member is added by an implicit conversion from NodeBase to CollectionsHaveToParArray[NodeBase, T] performed by method CollectionsHaveToParArray in scala.collection.parallel. This conversion will take place only if an implicit value of type (NodeBase) ⇒ GenTraversableOnce[T] is in scope.
- Definition Classes
- CollectionsHaveToParArray
-
def
toString(): String
- Definition Classes
- NodeParam → AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
~: ExtSet[EdgeT]
Synonym for
edges.Synonym for
edges.- Definition Classes
- InnerNode
- Annotations
- @inline()
-
final
def
~>(to: NodeT): Set[EdgeT] with FilterableSet[EdgeT]
Synonym for
outgoingTo.Synonym for
outgoingTo.- Definition Classes
- InnerNode
- Annotations
- @inline()
-
final
def
~>: Set[EdgeT] with FilterableSet[EdgeT]
Synonym for
outgoing.Synonym for
outgoing.- Definition Classes
- InnerNode
- Annotations
- @inline()
-
final
def
~>?(to: NodeT): Option[EdgeT]
Synonym for
findOutgoingTo.Synonym for
findOutgoingTo.- Definition Classes
- InnerNode
- Annotations
- @inline()
-
final
def
~>|: Set[NodeT]
Synonym for
diSuccessors.Synonym for
diSuccessors.- Definition Classes
- InnerNode
- Annotations
- @inline()
-
final
def
~|: Set[NodeT]
Synonym for
neighbors.Synonym for
neighbors.- Definition Classes
- InnerNode
- Annotations
- @inline()
- def →[B](y: B): (NodeBase, B)
Shadowed Implicit Value Members
-
def
isDefined: Boolean
- Implicit
- This member is added by an implicit conversion from NodeBase to OuterNode[NodeBase] performed by method anyToNode in scalax.collection.GraphPredef.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(nodeBase: OuterNode[NodeBase]).isDefined
- Definition Classes
- Param
-
def
isEdge: Boolean
- Implicit
- This member is added by an implicit conversion from NodeBase to OuterNode[NodeBase] performed by method anyToNode in scalax.collection.GraphPredef.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(nodeBase: OuterNode[NodeBase]).isEdge
- Definition Classes
- NodeParam
-
def
isIn: Boolean
- Implicit
- This member is added by an implicit conversion from NodeBase to OuterNode[NodeBase] performed by method anyToNode in scalax.collection.GraphPredef.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(nodeBase: OuterNode[NodeBase]).isIn
- Definition Classes
- InParam → Param
-
def
isNode: Boolean
- Implicit
- This member is added by an implicit conversion from NodeBase to OuterNode[NodeBase] performed by method anyToNode in scalax.collection.GraphPredef.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(nodeBase: OuterNode[NodeBase]).isNode
- Definition Classes
- NodeParam
-
def
isOut: Boolean
- Implicit
- This member is added by an implicit conversion from NodeBase to OuterNode[NodeBase] performed by method anyToNode in scalax.collection.GraphPredef.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(nodeBase: OuterNode[NodeBase]).isOut
- Definition Classes
- InParam → Param
-
def
stringPrefix: String
- Implicit
- This member is added by an implicit conversion from NodeBase to OuterNode[NodeBase] performed by method anyToNode in scalax.collection.GraphPredef.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(nodeBase: OuterNode[NodeBase]).stringPrefix
- Definition Classes
- NodeParam
-
def
toString(): String
- Implicit
- This member is added by an implicit conversion from NodeBase to OuterNode[NodeBase] performed by method anyToNode in scalax.collection.GraphPredef.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(nodeBase: OuterNode[NodeBase]).toString()
- Definition Classes
- NodeParam → AnyRef → Any
-
val
value: NodeBase
- Implicit
- This member is added by an implicit conversion from NodeBase to OuterNode[NodeBase] performed by method anyToNode in scalax.collection.GraphPredef.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(nodeBase: OuterNode[NodeBase]).value
- Definition Classes
- OuterNode → NodeParam
-
def
~[N >: N1](n2: N): UnDiEdge[N]
- Implicit
- This member is added by an implicit conversion from NodeBase to EdgeAssoc[NodeBase] performed by method EdgeAssoc in scalax.collection.GraphPredef.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(nodeBase: EdgeAssoc[NodeBase]).~(n2)
- Definition Classes
- EdgeAssoc
- Annotations
- @inline()
-
def
~>[N >: N1](n2: N): DiEdge[N]
- Implicit
- This member is added by an implicit conversion from NodeBase to EdgeAssoc[NodeBase] performed by method EdgeAssoc in scalax.collection.GraphPredef.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(nodeBase: EdgeAssoc[NodeBase]).~>(n2)
- Definition Classes
- EdgeAssoc
- Annotations
- @inline()
Welcome to the Graph for Scala API reference. Some suggested navigation entry points:
Graphmutable.Graphand its inner nodes.GraphEdgeobjectedgepackageGraphPredefobject andImplicitsobject.GraphTraversalandTraverserInnerNode.RandomGraph.GraphGen.