Packages

object Scan extends Serializable

Linear Supertypes
Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Scan
  2. Serializable
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. type Aux[-I, S, +O] = Scan[I, O] { type State = S }

    Most consumers of Scan don't care about the type of the type State type variable.

    Most consumers of Scan don't care about the type of the type State type variable. But for those that do, we make an effort to expose it in all of our combinators.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. implicit def applicative[I]: Applicative[[β$0$]Scan[I, β$0$]]
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. def const[T](t: T): Aux[Any, Unit, T]

    The trivial scan that always returns the same value, regardless of input

  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  11. def from[I, S, O](initState: S)(presentAndNextStateFn: (I, S) => (O, S)): Aux[I, S, O]
  12. def fromAggregator[A, B, C](aggregator: Aggregator[A, B, C], initState: B): Aux[A, B, C]

    returns

    A scan which, when given [a_1, ..., a_n] outputs [c_1, ..., c_n] where c_i = initState + aggregator.prepare(a_1) + ... + aggregator.prepare(a_i)

  13. def fromFunction[I, O](f: (I) => O): Aux[I, Unit, O]
  14. def fromMonoidAggregator[A, B, C](monoidAggregator: MonoidAggregator[A, B, C]): Aux[A, B, C]

    returns

    A scan which, when given [a_1, ..., a_n] outputs [c_1, ..., c_n] where c_i = monoidAggregator.monoid.zero + aggregator.prepare(a_1) + ... + aggregator.prepare(a_i)

  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def identity[A]: Aux[A, Unit, A]
  18. val index: Aux[Any, Long, Long]

    A Scan whose Nth output is the number N (starting from 0).

  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. def iterate[S, O](initState: S)(destructor: (S) => (O, S)): Aux[Any, S, O]

    Scans take streams of inputs to streams of outputs, but some scans have trivial inputs and just produce a stream of outputs.

    Scans take streams of inputs to streams of outputs, but some scans have trivial inputs and just produce a stream of outputs. Streams can be thought of as being a hidden state that is queryable for a head element, and another hidden state that represents the rest of the stream.

    S

    The hidden state of the stream that we are turning into a Scan.

    O

    The type of the elments of the stream that we are turning into a Scan

    initState

    The initial state of the scan; think of this as an infinite stream.

    destructor

    This function decomposes a stream into the its head-element and tail-stream.

    returns

    A Scan whose inputs are irrelevant, and whose outputs are those that we would get from implementing a stream using the information provided to this method.

  21. def mutable[I, S, O](initStateCreator: => S)(presentAndUpdateStateFn: (I, S) => O): Aux[I, S, O]

    initStateCreator

    A call-by-name method that allocates new mutable state

    presentAndUpdateStateFn

    A function that both presents the output value, and has the side-effect of updating the mutable state

    returns

    A Scan that safely encapsulates state while it's doing its thing.

  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. def toString(): String
    Definition Classes
    AnyRef → Any
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped