Trait

com.twitter.cassovary.graph

QueueBasedTraverser

Related Doc: package graph

Permalink

trait QueueBasedTraverser[+V <: Node] extends Traverser[V]

General schema for some Traversers (like BFS, DFS). QueueBasedTraverser keeps nodes to visit next in a queue. It iteratively visits nodes from the front of the queue in order based on the type of traversal and optionally adds new nodes to the queue.

Linear Supertypes
Traverser[V], Iterator[V], TraversableOnce[V], GenTraversableOnce[V], AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. QueueBasedTraverser
  2. Traverser
  3. Iterator
  4. TraversableOnce
  5. GenTraversableOnce
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. class GroupedIterator[B >: A] extends AbstractIterator[Seq[B]] with Iterator[Seq[B]]

    Permalink
    Definition Classes
    Iterator

Abstract Value Members

  1. abstract def depth(node: Int): Option[Int]

    Permalink

    Depth of visit of a given node.

  2. abstract def dir: GraphDir

    Permalink

    Direction of the walk.

  3. abstract def graph: Graph[V]

    Permalink

    Graph to be traversed.

  4. abstract def homeNodeIds: Seq[Int]

    Permalink

    Nodes to start the traversal from.

  5. abstract def nodePriority: GraphTraverserNodePriority

    Permalink

    The priority of nodes adding to the queue.

  6. abstract def shouldBeEnqueued(color: Color): Boolean

    Permalink

    Checks if the node of a given color should be enqueued.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def ++[B >: V](that: ⇒ GenTraversableOnce[B]): Iterator[B]

    Permalink
    Definition Classes
    Iterator
  4. def /:[B](z: B)(op: (B, V) ⇒ B): B

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce
  5. def :\[B](z: B)(op: (V, B) ⇒ B): B

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce
  6. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  7. object GraphTraverserNodePriority extends Enumeration

    Permalink

    The priority of nodes adding to the queue.

    The priority of nodes adding to the queue. BFS adds nodes at the end and DFS adds nodes at the beginning.

  8. def addString(b: StringBuilder): StringBuilder

    Permalink
    Definition Classes
    TraversableOnce
  9. def addString(b: StringBuilder, sep: String): StringBuilder

    Permalink
    Definition Classes
    TraversableOnce
  10. def addString(b: StringBuilder, start: String, sep: String, end: String): StringBuilder

    Permalink
    Definition Classes
    TraversableOnce
  11. def aggregate[B](z: ⇒ B)(seqop: (B, V) ⇒ B, combop: (B, B) ⇒ B): B

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce
  12. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  13. def buffered: BufferedIterator[V]

    Permalink
    Definition Classes
    Iterator
  14. def chooseNodesToEnqueue(node: Node): Seq[Int]

    Permalink

    Returns nodes ids that should be added to the queue after visiting node.

  15. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  16. def collect[B](pf: PartialFunction[V, B]): Iterator[B]

    Permalink
    Definition Classes
    Iterator
    Annotations
    @migration
    Migration

    (Changed in version 2.8.0) collect has changed. The previous behavior can be reproduced with toSeq.

  17. def collectFirst[B](pf: PartialFunction[V, B]): Option[B]

    Permalink
    Definition Classes
    TraversableOnce
  18. lazy val coloring: NodeColoring

    Permalink

    We mark nodes using 3 'colors': Unenqueued, Enqueued, Visited.

    We mark nodes using 3 'colors': Unenqueued, Enqueued, Visited. Initially every node is implicitly marked with Unenqueued.

    Node is marked Enqueued, when we add it to the queue. We mark it Visited just before returning with iterator's next function.

  19. def contains(elem: Any): Boolean

    Permalink
    Definition Classes
    Iterator
  20. def copyToArray[B >: V](xs: Array[B], start: Int, len: Int): Unit

    Permalink
    Definition Classes
    Iterator → TraversableOnce → GenTraversableOnce
  21. def copyToArray[B >: V](xs: Array[B]): Unit

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce
  22. def copyToArray[B >: V](xs: Array[B], start: Int): Unit

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce
  23. def copyToBuffer[B >: V](dest: Buffer[B]): Unit

    Permalink
    Definition Classes
    TraversableOnce
  24. def corresponds[B](that: GenTraversableOnce[B])(p: (V, B) ⇒ Boolean): Boolean

    Permalink
    Definition Classes
    Iterator
  25. def count(p: (V) ⇒ Boolean): Int

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce
  26. lazy val degreeLimit: Limit

    Permalink
  27. lazy val depthLimit: Limit

    Permalink
  28. def drop(n: Int): Iterator[V]

    Permalink
    Definition Classes
    Iterator
  29. def dropWhile(p: (V) ⇒ Boolean): Iterator[V]

    Permalink
    Definition Classes
    Iterator
  30. def duplicate: (Iterator[V], Iterator[V])

    Permalink
    Definition Classes
    Iterator
  31. def enqueue(nodes: Seq[Int], from: Option[Int]): Unit

    Permalink

    Enqueues nodes added after from node is visited (or None when equeueing initial nodes).

    Enqueues nodes added after from node is visited (or None when equeueing initial nodes).

    Attributes
    protected
  32. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  33. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  34. def exists(p: (V) ⇒ Boolean): Boolean

    Permalink
    Definition Classes
    Iterator → TraversableOnce → GenTraversableOnce
  35. def filter(p: (V) ⇒ Boolean): Iterator[V]

    Permalink
    Definition Classes
    Iterator
  36. def filterNot(p: (V) ⇒ Boolean): Iterator[V]

    Permalink
    Definition Classes
    Iterator
  37. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  38. def find(p: (V) ⇒ Boolean): Option[V]

    Permalink
    Definition Classes
    Iterator → TraversableOnce → GenTraversableOnce
  39. def findNextNodeToVisit(): Option[Int]

    Permalink

    Finds in the queue the node that will be visited next.

    Finds in the queue the node that will be visited next.

    Attributes
    protected
  40. def flatMap[B](f: (V) ⇒ GenTraversableOnce[B]): Iterator[B]

    Permalink
    Definition Classes
    Iterator
  41. def fold[A1 >: V](z: A1)(op: (A1, A1) ⇒ A1): A1

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce
  42. def foldLeft[B](z: B)(op: (B, V) ⇒ B): B

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce
  43. def foldRight[B](z: B)(op: (V, B) ⇒ B): B

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce
  44. def forall(p: (V) ⇒ Boolean): Boolean

    Permalink
    Definition Classes
    Iterator → TraversableOnce → GenTraversableOnce
  45. def foreach[U](f: (V) ⇒ U): Unit

    Permalink
    Definition Classes
    Iterator → TraversableOnce → GenTraversableOnce
  46. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  47. def getExistingNodeById[W >: V <: Node](graph: Graph[W], id: Int): W

    Permalink

    Traverser only visits node Ids listed in some node's edges, and thus we know that node must exist, safe to assume graph.getNodeById return non-None value

    Traverser only visits node Ids listed in some node's edges, and thus we know that node must exist, safe to assume graph.getNodeById return non-None value

    Attributes
    protected
    Definition Classes
    Traverser
  48. def grouped[B >: V](size: Int): GroupedIterator[B]

    Permalink
    Definition Classes
    Iterator
  49. def hasDefiniteSize: Boolean

    Permalink
    Definition Classes
    Iterator → TraversableOnce → GenTraversableOnce
  50. def hasNext: Boolean

    Permalink
    Definition Classes
    QueueBasedTraverser → Iterator
  51. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  52. def indexOf[B >: V](elem: B): Int

    Permalink
    Definition Classes
    Iterator
  53. def indexWhere(p: (V) ⇒ Boolean): Int

    Permalink
    Definition Classes
    Iterator
  54. def isEmpty: Boolean

    Permalink
    Definition Classes
    Iterator → TraversableOnce → GenTraversableOnce
  55. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  56. def isTraversableAgain: Boolean

    Permalink
    Definition Classes
    Iterator → GenTraversableOnce
  57. def length: Int

    Permalink
    Definition Classes
    Iterator
  58. def limitAddedToQueue(nodes: Seq[Int]): Seq[Int]

    Permalink

    If the queue is longer than the number of nodes that can be visited due to maxSteps bound, cuts the list of nodes that are to be added to the queue in order not to add too many of them.

    If the queue is longer than the number of nodes that can be visited due to maxSteps bound, cuts the list of nodes that are to be added to the queue in order not to add too many of them.

    Assumes that all nodes in the queue are being visited.

  59. lazy val limits: Limits

    Permalink

    Options to limit traverser walk.

  60. def map[B](f: (V) ⇒ B): Iterator[B]

    Permalink
    Definition Classes
    Iterator
  61. def max[B >: V](implicit cmp: Ordering[B]): V

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce
  62. def maxBy[B](f: (V) ⇒ B)(implicit cmp: Ordering[B]): V

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce
  63. lazy val maxSteps: Option[Long]

    Permalink
  64. def min[B >: V](implicit cmp: Ordering[B]): V

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce
  65. def minBy[B](f: (V) ⇒ B)(implicit cmp: Ordering[B]): V

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce
  66. def mkString: String

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce
  67. def mkString(sep: String): String

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce
  68. def mkString(start: String, sep: String, end: String): String

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce
  69. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  70. def next(): V

    Permalink
    Definition Classes
    QueueBasedTraverser → Iterator
  71. def nonEmpty: Boolean

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce
  72. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  73. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  74. var numEnqueuedEver: Long

    Permalink

    Number of nodes ever enqueued in the queue.

    Number of nodes ever enqueued in the queue.

    Attributes
    protected
  75. def padTo[A1 >: V](len: Int, elem: A1): Iterator[A1]

    Permalink
    Definition Classes
    Iterator
  76. def partition(p: (V) ⇒ Boolean): (Iterator[V], Iterator[V])

    Permalink
    Definition Classes
    Iterator
  77. def patch[B >: V](from: Int, patchElems: Iterator[B], replaced: Int): Iterator[B]

    Permalink
    Definition Classes
    Iterator
  78. lazy val prevNbrCounter: Option[PrevNbrCounter]

    Permalink

    Optional counter of previous nodes to a given node.

  79. def processNode(node: Node): Unit

    Permalink

    Performs action needed when visiting a node.

    Performs action needed when visiting a node.

    Attributes
    protected
  80. def product[B >: V](implicit num: Numeric[B]): B

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce
  81. val queue: FIFO[Int]

    Permalink

    Queue that stores nodes to be visited next.

    Queue that stores nodes to be visited next.

    Attributes
    protected
  82. def reduce[A1 >: V](op: (A1, A1) ⇒ A1): A1

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce
  83. def reduceLeft[B >: V](op: (B, V) ⇒ B): B

    Permalink
    Definition Classes
    TraversableOnce
  84. def reduceLeftOption[B >: V](op: (B, V) ⇒ B): Option[B]

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce
  85. def reduceOption[A1 >: V](op: (A1, A1) ⇒ A1): Option[A1]

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce
  86. def reduceRight[B >: V](op: (V, B) ⇒ B): B

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce
  87. def reduceRightOption[B >: V](op: (V, B) ⇒ B): Option[B]

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce
  88. def reversed: List[V]

    Permalink
    Attributes
    protected[this]
    Definition Classes
    TraversableOnce
  89. def sameElements(that: Iterator[_]): Boolean

    Permalink
    Definition Classes
    Iterator
  90. def scanLeft[B](z: B)(op: (B, V) ⇒ B): Iterator[B]

    Permalink
    Definition Classes
    Iterator
  91. def scanRight[B](z: B)(op: (V, B) ⇒ B): Iterator[B]

    Permalink
    Definition Classes
    Iterator
  92. def seq: Iterator[V]

    Permalink
    Definition Classes
    Iterator → TraversableOnce → GenTraversableOnce
  93. val shouldBeDequeuedBeforeProcessing: Boolean

    Permalink

    Set to true to deque a node from the queue before processing.

  94. def size: Int

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce
  95. def slice(from: Int, until: Int): Iterator[V]

    Permalink
    Definition Classes
    Iterator
  96. def sliding[B >: V](size: Int, step: Int): GroupedIterator[B]

    Permalink
    Definition Classes
    Iterator
  97. def span(p: (V) ⇒ Boolean): (Iterator[V], Iterator[V])

    Permalink
    Definition Classes
    Iterator
  98. def sum[B >: V](implicit num: Numeric[B]): B

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce
  99. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  100. def take(n: Int): Iterator[V]

    Permalink
    Definition Classes
    Iterator
  101. def takeWhile(p: (V) ⇒ Boolean): Iterator[V]

    Permalink
    Definition Classes
    Iterator
  102. def to[Col[_]](implicit cbf: CanBuildFrom[Nothing, V, Col[V]]): Col[V]

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce
  103. def toArray[B >: V](implicit arg0: ClassTag[B]): Array[B]

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce
  104. def toBuffer[B >: V]: Buffer[B]

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce
  105. def toIndexedSeq: IndexedSeq[V]

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce
  106. def toIterable: Iterable[V]

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce
  107. def toIterator: Iterator[V]

    Permalink
    Definition Classes
    Iterator → GenTraversableOnce
  108. def toList: List[V]

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce
  109. def toMap[T, U](implicit ev: <:<[V, (T, U)]): Map[T, U]

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce
  110. def toSeq: Seq[V]

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce
  111. def toSet[B >: V]: Set[B]

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce
  112. def toStream: Stream[V]

    Permalink
    Definition Classes
    Iterator → GenTraversableOnce
  113. def toString(): String

    Permalink
    Definition Classes
    Iterator → AnyRef → Any
  114. def toTraversable: Traversable[V]

    Permalink
    Definition Classes
    Iterator → TraversableOnce → GenTraversableOnce
  115. def toVector: Vector[V]

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce
  116. def visitNode(node: Node): Unit

    Permalink

    Action performed when visiting node node (before iteratur retuns node).

    Action performed when visiting node node (before iteratur retuns node). Should be implemented in subclass.

  117. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  118. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  119. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  120. def withFilter(p: (V) ⇒ Boolean): Iterator[V]

    Permalink
    Definition Classes
    Iterator
  121. def zip[B](that: Iterator[B]): Iterator[(V, B)]

    Permalink
    Definition Classes
    Iterator
  122. def zipAll[B, A1 >: V, B1 >: B](that: Iterator[B], thisElem: A1, thatElem: B1): Iterator[(A1, B1)]

    Permalink
    Definition Classes
    Iterator
  123. def zipWithIndex: Iterator[(V, Int)]

    Permalink
    Definition Classes
    Iterator

Inherited from Traverser[V]

Inherited from Iterator[V]

Inherited from TraversableOnce[V]

Inherited from GenTraversableOnce[V]

Inherited from AnyRef

Inherited from Any

Ungrouped