trait State[N, E[+X] <: EdgeLikeIn[X]] extends AnyRef
Adds bit fields to the graph and its nodes facilitating fast storage and retrieval of
traversal-specific flags as a decoupled implementation trait. These flags are often used
to keep track of visited nodes.
Traversals (algorithms) acquire handles by calling withHandle
. Then,
in withHandle
's code block, node.visited
or node.bit
is called with the supplied
handle as an implicit parameter to set or get a node's flag.
- Attributes
- protected
- Self Type
- GraphTraversalImpl[N, E]
- Alphabetic
- By Inheritance
- State
- AnyRef
- Any
- by ChainingOps
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Type Members
- trait InnerNodeState extends AnyRef
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): (State[N, E], B)
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clearNodeStates(flags: FlagWord, flagsExt: ExtBitSet): Unit
- Attributes
- protected
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def dump(store: FlagStore): ExtBitSet
- Attributes
- protected
- def dumpDirty: ExtBitSet
Returns a copy of the current
dirty
-flags for dump purposes. - def dumpInUse: ExtBitSet
Returns a copy of the current
inUse
-flags for dump purposes. - def ensuring(cond: (State[N, E]) => Boolean, msg: => Any): State[N, E]
- def ensuring(cond: (State[N, E]) => Boolean): State[N, E]
- def ensuring(cond: Boolean, msg: => Any): State[N, E]
- def ensuring(cond: Boolean): State[N, E]
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def nextHandle: Handle
Avoid calling this directly, prefer
withHandle
instead.Avoid calling this directly, prefer
withHandle
instead.- Attributes
- protected
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def pipe[B](f: (State[N, E]) => B): B
- Implicit
- This member is added by an implicit conversion from State[N, E] toChainingOps[State[N, E]] performed by method ChainingOps in scalax.collection.
- Definition Classes
- ChainingOps
- def releaseHandle(handle: Handle): Unit
Avoid calling this directly, prefer
withHandle
instead.Avoid calling this directly, prefer
withHandle
instead.- Attributes
- protected
- val self: State[N, E]
- Implicit
- This member is added by an implicit conversion from State[N, E] toChainingOps[State[N, E]] performed by method ChainingOps in scalax.collection.
- Definition Classes
- ChainingOps
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def tap[U](f: (State[N, E]) => U): State[N, E]
- Implicit
- This member is added by an implicit conversion from State[N, E] toChainingOps[State[N, E]] performed by method ChainingOps in scalax.collection.
- Definition Classes
- ChainingOps
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def withHandle[T](reuse: Option[Handle] = None)(block: (Handle) => T): T
Executes a code block in the context of a new or reused state handler.
Executes a code block in the context of a new or reused state handler.
- returns
The result of the code block executed.
- Attributes
- protected
- def withHandles[T](nr: Int, reuse: Array[Handle] = Array.empty[Handle])(block: (Array[Handle]) => T): T
Executes a code block in the context
nr
new state handlers or alternatively in the context of the state handlersreuse
.Executes a code block in the context
nr
new state handlers or alternatively in the context of the state handlersreuse
.- returns
The result of the code block executed.
- Attributes
- protected
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from State[N, E] toStringFormat[State[N, E]] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)
instead ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- def →[B](y: B): (State[N, E], B)
- Implicit
- This member is added by an implicit conversion from State[N, E] toArrowAssoc[State[N, E]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->
instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
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
.