trait PathBuilder extends WalkBuilder with Builder[InnerElem, Path]
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.
- Alphabetic
- By Inheritance
- PathBuilder
- WalkBuilder
- Builder
- Growable
- Clearable
- AnyRef
- Any
- by anyToNode
- by CollectionsHaveToParArray
- by EdgeAssoc
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
add(edge: GraphTraversal.EdgeT): Boolean
Tries to add
edge
to the tail of the path/walk.Tries to add
edge
to the tail of the path/walk.- returns
Whether the addition was successful.
- Definition Classes
- WalkBuilder
-
abstract
def
add(node: NodeT): Boolean
Tries to add
node
to the tail of the path/walk.Tries to add
node
to the tail of the path/walk.- returns
Whether the addition was successful.
- Definition Classes
- WalkBuilder
-
abstract
def
clear(): Unit
- Definition Classes
- Builder → Growable → Clearable
-
abstract
def
result(): Path
- Definition Classes
- Builder
-
abstract
def
start: NodeT
The node this walk starts at.
The node this walk starts at.
- Definition Classes
- WalkBuilder
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
def
+(other: String): String
- Implicit
- This member is added by an implicit conversion from PathBuilder to any2stringadd[PathBuilder] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
++=(xs: TraversableOnce[GraphTraversal.InnerElem]): PathBuilder.this.type
- Definition Classes
- Growable
-
final
def
+=(edge: GraphTraversal.EdgeT): PathBuilder.this.type
Tries to add
edge
to the tail of the path/walk.Tries to add
edge
to the tail of the path/walk.- Definition Classes
- WalkBuilder
- Annotations
- @inline()
-
final
def
+=(node: NodeT): PathBuilder.this.type
Tries to add
node
to the tail of the path/walk.Tries to add
node
to the tail of the path/walk.- Definition Classes
- WalkBuilder
- Annotations
- @inline()
-
def
+=(elem: GraphTraversal.InnerElem): PathBuilder.this.type
Tries to add
elem
to the tail of the path/walk.Tries to add
elem
to the tail of the path/walk.- Definition Classes
- WalkBuilder → Builder → Growable
-
def
+=(elem1: GraphTraversal.InnerElem, elem2: GraphTraversal.InnerElem, elems: GraphTraversal.InnerElem*): PathBuilder.this.type
- Definition Classes
- Growable
-
def
->[B](y: B): (PathBuilder, B)
- Implicit
- This member is added by an implicit conversion from PathBuilder to ArrowAssoc[PathBuilder] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
add(elem: GraphTraversal.InnerElem): Boolean
Tries to add
elem
to the tail of the path/walk.Tries to add
elem
to the tail of the path/walk.- returns
Whether the addition was successful.
- Definition Classes
- WalkBuilder
- Annotations
- @inline()
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
def
ensuring(cond: (PathBuilder) ⇒ Boolean, msg: ⇒ Any): PathBuilder
- Implicit
- This member is added by an implicit conversion from PathBuilder to Ensuring[PathBuilder] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (PathBuilder) ⇒ Boolean): PathBuilder
- Implicit
- This member is added by an implicit conversion from PathBuilder to Ensuring[PathBuilder] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): PathBuilder
- Implicit
- This member is added by an implicit conversion from PathBuilder to Ensuring[PathBuilder] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): PathBuilder
- Implicit
- This member is added by an implicit conversion from PathBuilder to Ensuring[PathBuilder] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from PathBuilder to StringFormat[PathBuilder] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
isDefined: Boolean
- Implicit
- This member is added by an implicit conversion from PathBuilder to OuterNode[PathBuilder] performed by method anyToNode in scalax.collection.GraphPredef.
- Definition Classes
- Param
-
def
isEdge: Boolean
- Implicit
- This member is added by an implicit conversion from PathBuilder to OuterNode[PathBuilder] performed by method anyToNode in scalax.collection.GraphPredef.
- Definition Classes
- NodeParam
-
def
isIn: Boolean
- Implicit
- This member is added by an implicit conversion from PathBuilder to OuterNode[PathBuilder] performed by method anyToNode in scalax.collection.GraphPredef.
- Definition Classes
- InParam → Param
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
isNode: Boolean
- Implicit
- This member is added by an implicit conversion from PathBuilder to OuterNode[PathBuilder] performed by method anyToNode in scalax.collection.GraphPredef.
- Definition Classes
- NodeParam
-
def
isOut: Boolean
- Implicit
- This member is added by an implicit conversion from PathBuilder to OuterNode[PathBuilder] performed by method anyToNode in scalax.collection.GraphPredef.
- Definition Classes
- InParam → Param
-
def
mapResult[NewTo](f: (Path) ⇒ NewTo): Builder[GraphTraversal.InnerElem, NewTo]
- Definition Classes
- Builder
-
val
n1: PathBuilder
- Implicit
- This member is added by an implicit conversion from PathBuilder to EdgeAssoc[PathBuilder] 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()
-
def
sizeHint(coll: TraversableLike[_, _], delta: Int): Unit
- Definition Classes
- Builder
-
def
sizeHint(coll: TraversableLike[_, _]): Unit
- Definition Classes
- Builder
-
def
sizeHint(size: Int): Unit
- Definition Classes
- Builder
-
def
sizeHintBounded(size: Int, boundingColl: TraversableLike[_, _]): Unit
- Definition Classes
- Builder
-
def
stringPrefix: String
- Implicit
- This member is added by an implicit conversion from PathBuilder to OuterNode[PathBuilder] performed by method anyToNode in scalax.collection.GraphPredef.
- Definition Classes
- NodeParam
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toParArray: ParArray[T]
- Implicit
- This member is added by an implicit conversion from PathBuilder to CollectionsHaveToParArray[PathBuilder, T] performed by method CollectionsHaveToParArray in scala.collection.parallel. This conversion will take place only if an implicit value of type (PathBuilder) ⇒ GenTraversableOnce[T] is in scope.
- Definition Classes
- CollectionsHaveToParArray
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
val
value: PathBuilder
- Implicit
- This member is added by an implicit conversion from PathBuilder to OuterNode[PathBuilder] performed by method anyToNode in scalax.collection.GraphPredef.
- Definition Classes
- OuterNode → NodeParam
-
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( ... )
-
def
~[N >: N1](n2: N): UnDiEdge[N]
- Implicit
- This member is added by an implicit conversion from PathBuilder to EdgeAssoc[PathBuilder] performed by method EdgeAssoc in scalax.collection.GraphPredef.
- Definition Classes
- EdgeAssoc
- Annotations
- @inline()
-
def
~>[N >: N1](n2: N): DiEdge[N]
- Implicit
- This member is added by an implicit conversion from PathBuilder to EdgeAssoc[PathBuilder] performed by method EdgeAssoc in scalax.collection.GraphPredef.
- Definition Classes
- EdgeAssoc
- Annotations
- @inline()
-
def
→[B](y: B): (PathBuilder, B)
- Implicit
- This member is added by an implicit conversion from PathBuilder to ArrowAssoc[PathBuilder] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
Shadowed Implicit Value Members
-
def
toString(): String
- Implicit
- This member is added by an implicit conversion from PathBuilder to OuterNode[PathBuilder] 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:(pathBuilder: OuterNode[PathBuilder]).toString()
- Definition Classes
- NodeParam → AnyRef → Any
Welcome to the Graph for Scala API reference. Some suggested navigation entry points:
Graph
mutable.Graph
and its inner nodes.GraphEdge
objectedge
packageGraphPredef
object andImplicits
object.GraphTraversal
andTraverserInnerNode
.RandomGraph
.GraphGen
.