Packages

  • package root

    Welcome to the Graph for Scala API reference.

    Welcome to the Graph for Scala API reference. Some suggested navigation entry points:

    Definition Classes
    root
  • package scalax
    Definition Classes
    root
  • package collection

    Contains the base traits and objects needed to use Graph for Scala.

    Contains the base traits and objects needed to use Graph for Scala.

    See also the Graph for Scala Core User Guide.

    Definition Classes
    scalax
  • package config
    Definition Classes
    collection
  • package edge

    Predefined edges.

    Predefined edges.

    While basic edge types are defined in the object GraphEdge, the predefined edges in this package cover the following categories (prefixes, shortcuts):

    weighted (W, %), key-weighted (Wk, %#), labeled (L, +), key-labeled (Lk, +#), weighted and labeled (WL, %+), key-weighted and labeled (WkL, %#+), weighted and key-labeled (WLk, %+#) and key-weighted and key-labeled (WkLk, %#+#).

    These predefined edges provide alternatives for any edge extension taking the burden from the user to implement his/her custom edge class - but baring the disadvantage that user edge attributes must be part of a label class as opposed to being part of the edge class directly. It may also serve as a source for looking up how to implement custom edge classes.

    Definition Classes
    collection
  • package generator

    This package helps you to create random graphs with predefined metrics.

    This package helps you to create random graphs with predefined metrics. It is not only possible to create random graph instances but also Scalacheck generators.

    Definition Classes
    collection
  • package generic
    Definition Classes
    collection
  • package immutable
    Definition Classes
    collection
  • package interfaces
    Definition Classes
    collection
  • package mutable
    Definition Classes
    collection
  • Graph
  • GraphBase
  • GraphDegree
  • GraphEdge
  • GraphLike
  • GraphPredef
  • GraphTraversal
  • GraphTraversalImpl
  • State
  • TraverserImpl

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]
Linear Supertypes
AnyRef, Any
Known Subclasses
GraphTraversalImpl, DefaultGraphImpl, DefaultGraphImpl
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. State
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. trait InnerNodeState extends AnyRef

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from State[N, E] to any2stringadd[State[N, E]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (State[N, E], B)
    Implicit
    This member is added by an implicit conversion from State[N, E] to ArrowAssoc[State[N, E]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clearNodeStates(flags: FlagWord, flagsExt: ExtBitSet): Unit
    Attributes
    protected
  8. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  9. def dump(store: FlagStore): ExtBitSet
    Attributes
    protected
  10. def dumpDirty: ExtBitSet

    Returns a copy of the current dirty-flags for dump purposes.

  11. def dumpInUse: ExtBitSet

    Returns a copy of the current inUse-flags for dump purposes.

  12. def ensuring(cond: (State[N, E]) ⇒ Boolean, msg: ⇒ Any): State[N, E]
    Implicit
    This member is added by an implicit conversion from State[N, E] to Ensuring[State[N, E]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (State[N, E]) ⇒ Boolean): State[N, E]
    Implicit
    This member is added by an implicit conversion from State[N, E] to Ensuring[State[N, E]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: ⇒ Any): State[N, E]
    Implicit
    This member is added by an implicit conversion from State[N, E] to Ensuring[State[N, E]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): State[N, E]
    Implicit
    This member is added by an implicit conversion from State[N, E] to Ensuring[State[N, E]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  18. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from State[N, E] to StringFormat[State[N, E]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  20. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. def nextHandle: Handle

    Avoid calling this directly, prefer withHandle instead.

    Avoid calling this directly, prefer withHandle instead.

    Attributes
    protected
  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. def releaseHandle(handle: Handle): Unit

    Avoid calling this directly, prefer withHandle instead.

    Avoid calling this directly, prefer withHandle instead.

    Attributes
    protected
  28. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  29. def toString(): String
    Definition Classes
    AnyRef → Any
  30. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  33. 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
  34. 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 handlers reuse.

    Executes a code block in the context nr new state handlers or alternatively in the context of the state handlers reuse.

    returns

    The result of the code block executed.

    Attributes
    protected
  35. def →[B](y: B): (State[N, E], B)
    Implicit
    This member is added by an implicit conversion from State[N, E] to ArrowAssoc[State[N, E]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from State[N, E] to any2stringadd[State[N, E]]

Inherited by implicit conversion StringFormat from State[N, E] to StringFormat[State[N, E]]

Inherited by implicit conversion Ensuring from State[N, E] to Ensuring[State[N, E]]

Inherited by implicit conversion ArrowAssoc from State[N, E] to ArrowAssoc[State[N, E]]

Ungrouped