Packages

c

com.nvidia.spark.rapids.RmmRapidsRetryIterator

AutoCloseableAttemptSpliterator

class AutoCloseableAttemptSpliterator[T <: AutoCloseable, K] extends Spliterator[K]

A spliterator that takes an input iterator of auto closeable T, and a function fn that can map T to K, with an additional splitPolicy that can split T into a Seq[T]

It assumes the type T is AutoCloseable, and that if a split policy is specified, that it is capable of handling splitting one T into a sequence of them.

When an attempt to invoke function fn is successful, the item T in input will be closed. In the case of a failure, all attempts will be closed. It is the responsibility of the caller to close any remaining items in input that have not been attempted.

fn must be idempotent: this is a requirement because we may call fn multiple times while handling retries.

T

element type that must be AutoCloseable

K

fn result type

Linear Supertypes
Spliterator[K], AutoCloseable, Iterator[K], TraversableOnce[K], GenTraversableOnce[K], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AutoCloseableAttemptSpliterator
  2. Spliterator
  3. AutoCloseable
  4. Iterator
  5. TraversableOnce
  6. GenTraversableOnce
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AutoCloseableAttemptSpliterator(input: Iterator[T], fn: (T) ⇒ K)
  2. new AutoCloseableAttemptSpliterator(input: Iterator[T], fn: (T) ⇒ K, splitPolicy: (T) ⇒ Seq[T])

    input

    an iterator of T

    fn

    a function that takes T and produces K

    splitPolicy

    a function that can split an item of type T into a Seq[T]. The split function must close the item passed to it.

Type Members

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

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def ++[B >: K](that: ⇒ GenTraversableOnce[B]): Iterator[B]
    Definition Classes
    Iterator
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. def addString(b: StringBuilder): StringBuilder
    Definition Classes
    TraversableOnce
  6. def addString(b: StringBuilder, sep: String): StringBuilder
    Definition Classes
    TraversableOnce
  7. def addString(b: StringBuilder, start: String, sep: String, end: String): StringBuilder
    Definition Classes
    TraversableOnce
  8. def aggregate[B](z: ⇒ B)(seqop: (B, K) ⇒ B, combop: (B, B) ⇒ B): B
    Definition Classes
    TraversableOnce → GenTraversableOnce
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. val attemptStack: ArrayStack[T]
    Attributes
    protected
  11. def buffered: BufferedIterator[K]
    Definition Classes
    Iterator
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  13. def close(): Unit
    Definition Classes
    AutoCloseableAttemptSpliterator → Spliterator → AutoCloseable
  14. def collect[B](pf: PartialFunction[K, B]): Iterator[B]
    Definition Classes
    Iterator
    Annotations
    @migration
    Migration

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

  15. def collectFirst[B](pf: PartialFunction[K, B]): Option[B]
    Definition Classes
    TraversableOnce
  16. def contains(elem: Any): Boolean
    Definition Classes
    Iterator
  17. def copyToArray[B >: K](xs: Array[B], start: Int, len: Int): Unit
    Definition Classes
    Iterator → TraversableOnce → GenTraversableOnce
  18. def copyToArray[B >: K](xs: Array[B]): Unit
    Definition Classes
    TraversableOnce → GenTraversableOnce
  19. def copyToArray[B >: K](xs: Array[B], start: Int): Unit
    Definition Classes
    TraversableOnce → GenTraversableOnce
  20. def copyToBuffer[B >: K](dest: Buffer[B]): Unit
    Definition Classes
    TraversableOnce
  21. def corresponds[B](that: GenTraversableOnce[B])(p: (K, B) ⇒ Boolean): Boolean
    Definition Classes
    Iterator
  22. def count(p: (K) ⇒ Boolean): Int
    Definition Classes
    TraversableOnce → GenTraversableOnce
  23. def drop(n: Int): Iterator[K]
    Definition Classes
    Iterator
  24. def dropWhile(p: (K) ⇒ Boolean): Iterator[K]
    Definition Classes
    Iterator
  25. def duplicate: (Iterator[K], Iterator[K])
    Definition Classes
    Iterator
  26. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  28. def exists(p: (K) ⇒ Boolean): Boolean
    Definition Classes
    Iterator → TraversableOnce → GenTraversableOnce
  29. def filter(p: (K) ⇒ Boolean): Iterator[K]
    Definition Classes
    Iterator
  30. def filterNot(p: (K) ⇒ Boolean): Iterator[K]
    Definition Classes
    Iterator
  31. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  32. def find(p: (K) ⇒ Boolean): Option[K]
    Definition Classes
    Iterator → TraversableOnce → GenTraversableOnce
  33. def flatMap[B](f: (K) ⇒ GenTraversableOnce[B]): Iterator[B]
    Definition Classes
    Iterator
  34. def fold[A1 >: K](z: A1)(op: (A1, A1) ⇒ A1): A1
    Definition Classes
    TraversableOnce → GenTraversableOnce
  35. def foldLeft[B](z: B)(op: (B, K) ⇒ B): B
    Definition Classes
    TraversableOnce → GenTraversableOnce
  36. def foldRight[B](z: B)(op: (K, B) ⇒ B): B
    Definition Classes
    TraversableOnce → GenTraversableOnce
  37. def forall(p: (K) ⇒ Boolean): Boolean
    Definition Classes
    Iterator → TraversableOnce → GenTraversableOnce
  38. def foreach[U](f: (K) ⇒ U): Unit
    Definition Classes
    Iterator → TraversableOnce → GenTraversableOnce
  39. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  40. def grouped[B >: K](size: Int): GroupedIterator[B]
    Definition Classes
    Iterator
  41. def hasDefiniteSize: Boolean
    Definition Classes
    Iterator → TraversableOnce → GenTraversableOnce
  42. def hasNext: Boolean
    Definition Classes
    AutoCloseableAttemptSpliterator → Spliterator → Iterator
  43. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  44. def indexOf[B >: K](elem: B, from: Int): Int
    Definition Classes
    Iterator
  45. def indexOf[B >: K](elem: B): Int
    Definition Classes
    Iterator
  46. def indexWhere(p: (K) ⇒ Boolean, from: Int): Int
    Definition Classes
    Iterator
  47. def indexWhere(p: (K) ⇒ Boolean): Int
    Definition Classes
    Iterator
  48. def isEmpty: Boolean
    Definition Classes
    Iterator → TraversableOnce → GenTraversableOnce
  49. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  50. def isTraversableAgain: Boolean
    Definition Classes
    Iterator → GenTraversableOnce
  51. def length: Int
    Definition Classes
    Iterator
  52. def map[B](f: (K) ⇒ B): Iterator[B]
    Definition Classes
    Iterator
  53. def max[B >: K](implicit cmp: Ordering[B]): K
    Definition Classes
    TraversableOnce → GenTraversableOnce
  54. def maxBy[B](f: (K) ⇒ B)(implicit cmp: Ordering[B]): K
    Definition Classes
    TraversableOnce → GenTraversableOnce
  55. def min[B >: K](implicit cmp: Ordering[B]): K
    Definition Classes
    TraversableOnce → GenTraversableOnce
  56. def minBy[B](f: (K) ⇒ B)(implicit cmp: Ordering[B]): K
    Definition Classes
    TraversableOnce → GenTraversableOnce
  57. def mkString: String
    Definition Classes
    TraversableOnce → GenTraversableOnce
  58. def mkString(sep: String): String
    Definition Classes
    TraversableOnce → GenTraversableOnce
  59. def mkString(start: String, sep: String, end: String): String
    Definition Classes
    TraversableOnce → GenTraversableOnce
  60. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  61. def next(): K
    Definition Classes
    AutoCloseableAttemptSpliterator → Spliterator → Iterator
  62. def nonEmpty: Boolean
    Definition Classes
    TraversableOnce → GenTraversableOnce
  63. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  64. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  65. def padTo[A1 >: K](len: Int, elem: A1): Iterator[A1]
    Definition Classes
    Iterator
  66. def partition(p: (K) ⇒ Boolean): (Iterator[K], Iterator[K])
    Definition Classes
    Iterator
  67. def patch[B >: K](from: Int, patchElems: Iterator[B], replaced: Int): Iterator[B]
    Definition Classes
    Iterator
  68. def product[B >: K](implicit num: Numeric[B]): B
    Definition Classes
    TraversableOnce → GenTraversableOnce
  69. def reduce[A1 >: K](op: (A1, A1) ⇒ A1): A1
    Definition Classes
    TraversableOnce → GenTraversableOnce
  70. def reduceLeft[B >: K](op: (B, K) ⇒ B): B
    Definition Classes
    TraversableOnce
  71. def reduceLeftOption[B >: K](op: (B, K) ⇒ B): Option[B]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  72. def reduceOption[A1 >: K](op: (A1, A1) ⇒ A1): Option[A1]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  73. def reduceRight[B >: K](op: (K, B) ⇒ B): B
    Definition Classes
    TraversableOnce → GenTraversableOnce
  74. def reduceRightOption[B >: K](op: (K, B) ⇒ B): Option[B]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  75. def reversed: List[K]
    Attributes
    protected[this]
    Definition Classes
    TraversableOnce
  76. def sameElements(that: Iterator[_]): Boolean
    Definition Classes
    Iterator
  77. def scanLeft[B](z: B)(op: (B, K) ⇒ B): Iterator[B]
    Definition Classes
    Iterator
  78. def scanRight[B](z: B)(op: (K, B) ⇒ B): Iterator[B]
    Definition Classes
    Iterator
  79. def seq: Iterator[K]
    Definition Classes
    Iterator → TraversableOnce → GenTraversableOnce
  80. def size: Int
    Definition Classes
    TraversableOnce → GenTraversableOnce
  81. def sizeHintIfCheap: Int
    Attributes
    protected[collection]
    Definition Classes
    GenTraversableOnce
  82. def slice(from: Int, until: Int): Iterator[K]
    Definition Classes
    Iterator
  83. def sliceIterator(from: Int, until: Int): Iterator[K]
    Attributes
    protected
    Definition Classes
    Iterator
  84. def sliding[B >: K](size: Int, step: Int): GroupedIterator[B]
    Definition Classes
    Iterator
  85. def span(p: (K) ⇒ Boolean): (Iterator[K], Iterator[K])
    Definition Classes
    Iterator
  86. def split(isFromGpuOom: Boolean): Unit

    Split is a function that is invoked by RmmRapidsRetryIterator when GpuSplitAndRetryOOM or CpuSplitAndRetryOOM is thrown.

    Split is a function that is invoked by RmmRapidsRetryIterator when GpuSplitAndRetryOOM or CpuSplitAndRetryOOM is thrown. This function is implemented by Spliterator classes to attempt to handle this exception by reducing the size of attempts (the thing that .next is using as an input), usually by splitting a batch in half by number of rows, or splitting a collection of batches into smaller collections to be attempted separately, likely reducing GPU memory that needs to be manifested while calling .next.

    isFromGpuOom

    true if the split happened because of a GPU OOM. Otherwise it was a CPU off heap OOM.

    Definition Classes
    AutoCloseableAttemptSpliterator → Spliterator
  87. def sum[B >: K](implicit num: Numeric[B]): B
    Definition Classes
    TraversableOnce → GenTraversableOnce
  88. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  89. def take(n: Int): Iterator[K]
    Definition Classes
    Iterator
  90. def takeWhile(p: (K) ⇒ Boolean): Iterator[K]
    Definition Classes
    Iterator
  91. def to[Col[_]](implicit cbf: CanBuildFrom[Nothing, K, Col[K]]): Col[K]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  92. def toArray[B >: K](implicit arg0: ClassTag[B]): Array[B]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  93. def toBuffer[B >: K]: Buffer[B]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  94. def toIndexedSeq: IndexedSeq[K]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  95. def toIterable: Iterable[K]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  96. def toIterator: Iterator[K]
    Definition Classes
    Iterator → GenTraversableOnce
  97. def toList: List[K]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  98. def toMap[T, U](implicit ev: <:<[K, (T, U)]): Map[T, U]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  99. def toSeq: Seq[K]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  100. def toSet[B >: K]: Set[B]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  101. def toStream: Stream[K]
    Definition Classes
    Iterator → GenTraversableOnce
  102. def toString(): String
    Definition Classes
    Iterator → AnyRef → Any
  103. def toTraversable: Traversable[K]
    Definition Classes
    Iterator → TraversableOnce → GenTraversableOnce
  104. def toVector: Vector[K]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  105. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  106. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  107. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  108. def withFilter(p: (K) ⇒ Boolean): Iterator[K]
    Definition Classes
    Iterator
  109. def zip[B](that: Iterator[B]): Iterator[(K, B)]
    Definition Classes
    Iterator
  110. def zipAll[B, A1 >: K, B1 >: B](that: Iterator[B], thisElem: A1, thatElem: B1): Iterator[(A1, B1)]
    Definition Classes
    Iterator
  111. def zipWithIndex: Iterator[(K, Int)]
    Definition Classes
    Iterator

Deprecated Value Members

  1. def /:[B](z: B)(op: (B, K) ⇒ B): B
    Definition Classes
    TraversableOnce → GenTraversableOnce
    Annotations
    @deprecated
    Deprecated

    (Since version 2.12.10) Use foldLeft instead of /:

  2. def :\[B](z: B)(op: (K, B) ⇒ B): B
    Definition Classes
    TraversableOnce → GenTraversableOnce
    Annotations
    @deprecated
    Deprecated

    (Since version 2.12.10) Use foldRight instead of :\

Inherited from Spliterator[K]

Inherited from AutoCloseable

Inherited from Iterator[K]

Inherited from TraversableOnce[K]

Inherited from GenTraversableOnce[K]

Inherited from AnyRef

Inherited from Any

Ungrouped