monix-tail/monix.tail.batches/BatchCursor

BatchCursor

object BatchCursor

BatchCursor builders.

BatchCursor builders.

Companion
class
class Object
trait Matchable
class Any

Value members

Concrete methods

def apply[A](elems: A*): BatchCursor[A]

Given a list of cursor, builds an array-backed BatchCursor out of it.

Given a list of cursor, builds an array-backed BatchCursor out of it.

def booleans(array: Array[Boolean]): BooleansCursor

Returns a BatchCursor specialized for Boolean.

Returns a BatchCursor specialized for Boolean.

Value Params
array

is the underlying reference to use for traversing and transformations

def booleans(array: Array[Boolean], offset: Int, length: Int): BooleansCursor

Returns a BatchCursor specialized for Boolean.

Returns a BatchCursor specialized for Boolean.

Value Params
array

is the underlying reference to use for traversing and transformations

length

is the length of created cursor, which would have been array.length by default

offset

is the offset to start from, which would have been zero by default

def bytes(array: Array[Byte]): BytesCursor

Returns a BatchCursor specialized for Byte.

Returns a BatchCursor specialized for Byte.

Value Params
array

is the underlying reference to use for traversing and transformations

def bytes(array: Array[Byte], offset: Int, length: Int): BytesCursor

Returns a BatchCursor specialized for Byte.

Returns a BatchCursor specialized for Byte.

Value Params
array

is the underlying reference to use for traversing and transformations

length

is the length of created cursor, which would have been array.length by default

offset

is the offset to start from, which would have been zero by default

def chars(array: Array[Char]): CharsCursor

Returns a BatchCursor specialized for Char.

Returns a BatchCursor specialized for Char.

Value Params
array

is the underlying reference to use for traversing and transformations

def chars(array: Array[Char], offset: Int, length: Int): CharsCursor

Returns a BatchCursor specialized for Char.

Returns a BatchCursor specialized for Char.

Value Params
array

is the underlying reference to use for traversing and transformations

length

is the length of created cursor, which would have been array.length by default

offset

is the offset to start from, which would have been zero by default

def continually[A](f: => A): BatchCursor[A]

Creates an infinite-length iterator returning the results of evaluating an expression. The expression is recomputed for every element.

Creates an infinite-length iterator returning the results of evaluating an expression. The expression is recomputed for every element.

Value Params
f

the computation to repeatedly evaluate

Returns

the iterator containing an infinite number of results of evaluating f

def doubles(array: Array[Double]): DoublesCursor

Returns a BatchCursor specialized for Double.

Returns a BatchCursor specialized for Double.

Value Params
array

is the underlying reference to use for traversing and transformations

def doubles(array: Array[Double], offset: Int, length: Int): DoublesCursor

Returns a BatchCursor specialized for Double.

Returns a BatchCursor specialized for Double.

Value Params
array

is the underlying reference to use for traversing and transformations

length

is the length of created cursor, which would have been array.length by default

offset

is the offset to start from, which would have been zero by default

def empty[A]: BatchCursor[A]

Returns a generic, empty cursor instance.

Returns a generic, empty cursor instance.

def fromAnyArray[A](array: Array[_], offset: Int, length: Int): ArrayCursor[A]

Builds an ArrayCursor instance from any array of boxed values.

Builds an ArrayCursor instance from any array of boxed values.

   This will have lower performance than working with
   [[BatchCursor.fromArray[A](array:Array[A])* BatchCursor.fromArray]],
   since the values are boxed, however there is no requirement for a
   `ClassTag` and thus it can be used in any generic context.
Value Params
array

is the underlying reference to use for traversing and transformations

length

is the length of created cursor, which would have been array.length by default

offset

is the offset to start from, which would have been zero by default

def fromAnyArray[A](array: Array[_]): ArrayCursor[A]

Builds an ArrayCursor instance from any array of boxed values.

Builds an ArrayCursor instance from any array of boxed values.

   This will have lower performance than working with
   [[BatchCursor.fromArray[A](array:Array[A])* BatchCursor.fromArray]],
   since the values are boxed, however there is no requirement for a
   `ClassTag` and thus it can be used in any generic context.
Value Params
array

is the underlying reference to use for traversing and transformations

def fromArray[A](array: Array[A]): ArrayCursor[A]

Builds a BatchCursor from a standard Array, with strict semantics on transformations.

Builds a BatchCursor from a standard Array, with strict semantics on transformations.

Value Params
array

is the underlying reference to use for traversing and transformations

def fromArray[A](array: Array[A], offset: Int, length: Int): ArrayCursor[A]

Builds a BatchCursor from a standard Array, with strict semantics on transformations.

Builds a BatchCursor from a standard Array, with strict semantics on transformations.

Value Params
array

is the underlying reference to use for traversing and transformations

length

is the length of created cursor, which would have been array.length by default

offset

is the offset to start from, which would have been zero by default

def fromIndexedSeq[A](seq: IndexedSeq[A]): BatchCursor[A]

Builds a BatchCursor from a Scala IndexedSeq, with strict semantics on transformations.

Builds a BatchCursor from a Scala IndexedSeq, with strict semantics on transformations.

def fromIterator[A](iter: Iterator[A]): BatchCursor[A]

Converts a Scala scala.collection.Iterator into a BatchCursor.

Converts a Scala scala.collection.Iterator into a BatchCursor.

Value Params
iter

is the Iterator to wrap in a BatchCursor instance

def fromIterator[A](iter: Iterator[A], recommendedBatchSize: Int): BatchCursor[A]

Converts a Scala scala.collection.Iterator into a BatchCursor.

Converts a Scala scala.collection.Iterator into a BatchCursor.

Value Params
iter

is the Iterator to wrap in a BatchCursor instance

recommendedBatchSize

specifies the BatchCursor.recommendedBatchSize for the resulting BatchCursor instance, specifying the batch size when doing eager processing.

def fromSeq[A](seq: Seq[A]): BatchCursor[A]

Builds a BatchCursor from a Scala Seq, with lazy semantics on transformations.

Builds a BatchCursor from a Scala Seq, with lazy semantics on transformations.

def fromSeq[A](seq: Seq[A], recommendedBatchSize: Int): BatchCursor[A]

Builds a BatchCursor from a Scala Seq, with lazy semantics on transformations.

Builds a BatchCursor from a Scala Seq, with lazy semantics on transformations.

def integers(array: Array[Int]): IntegersCursor

Returns a BatchCursor specialized for Int.

Returns a BatchCursor specialized for Int.

Value Params
array

is the underlying reference to use for traversing and transformations

def integers(array: Array[Int], offset: Int, length: Int): IntegersCursor

Returns a BatchCursor specialized for Int.

Returns a BatchCursor specialized for Int.

Value Params
array

is the underlying reference to use for traversing and transformations

length

is the length of created cursor, which would have been array.length by default

offset

is the offset to start from, which would have been zero by default

def longs(array: Array[Long]): LongsCursor

Returns a BatchCursor specialized for Long.

Returns a BatchCursor specialized for Long.

Value Params
array

is the underlying reference to use for traversing and transformations

def longs(array: Array[Long], offset: Int, length: Int): LongsCursor

Returns a BatchCursor specialized for Long.

Returns a BatchCursor specialized for Long.

Value Params
array

is the underlying reference to use for traversing and transformations

length

is the length of created cursor, which would have been array.length by default

offset

is the offset to start from, which would have been zero by default

def range(from: Int, until: Int, step: Int): BatchCursor[Int]

A cursor producing equally spaced values in some integer interval.

A cursor producing equally spaced values in some integer interval.

Value Params
from

the start value of the cursor

step

the increment value of the cursor (must be positive or negative)

until

the end value of the cursor (the first value NOT returned)

Returns

the cursor producing values from, from + step, ... up to, but excluding end