Trait

framian.reduce

Reducer

Related Doc: package reduce

Permalink

trait Reducer[-A, +B] extends AnyRef

A low level trait for implementing reductions.

TODO: All reducers should return Cell[B].

A

the input type of the reducer, which is the value type of the input Column

B

the ouput type of the reducer, which is the value type of the output Cell

Source
Reducer.scala
Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Reducer
  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

Abstract Value Members

  1. abstract def reduce(column: Column[A], indices: Array[Int], start: Int, end: Int): Cell[B]

    Permalink

    Reduce the given column of values to a cell using only the indexes in given array slice.

    Reduce the given column of values to a cell using only the indexes in given array slice.

    indices, start, and end represent an array slice. The following must hold:

    • 0 <= start
    • end <= indices.length
    • start <= end

    and the slice is [start:end), inclusive of start and exclusive of end.

    Let i: Int where start <= i and i < end, then

    column(indices(i)) match {
        case Value(v) => // 1.
        case NA => // 2.
        case NM => // 3.
    }
    1. In the case of a Value, the value should be included in the reduction.
    2. In the case of NA, the reduction should skip.
    3. In the case of NM, the reduction should terminate with NM.
    column

    the column of values is the source of the reduction

    indices

    the array of column indexes to reduce over

    start

    the start of the array slice on the indices

    end

    the end of the array slice on the indices

    returns

    the result of the reduction as a Cell

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 +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Reducer[A, B] to any2stringadd[Reducer[A, B]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Reducer[A, B], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Reducer[A, B] to ArrowAssoc[Reducer[A, B]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def ensuring(cond: (Reducer[A, B]) ⇒ Boolean, msg: ⇒ Any): Reducer[A, B]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Reducer[A, B] to Ensuring[Reducer[A, B]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (Reducer[A, B]) ⇒ Boolean): Reducer[A, B]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Reducer[A, B] to Ensuring[Reducer[A, B]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): Reducer[A, B]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Reducer[A, B] to Ensuring[Reducer[A, B]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): Reducer[A, B]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Reducer[A, B] to Ensuring[Reducer[A, B]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Reducer[A, B] to StringFormat[Reducer[A, B]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  17. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  20. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  22. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  23. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. def [B](y: B): (Reducer[A, B], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Reducer[A, B] to ArrowAssoc[Reducer[A, B]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Reducer[A, B] to any2stringadd[Reducer[A, B]]

Inherited by implicit conversion StringFormat from Reducer[A, B] to StringFormat[Reducer[A, B]]

Inherited by implicit conversion Ensuring from Reducer[A, B] to Ensuring[Reducer[A, B]]

Inherited by implicit conversion ArrowAssoc from Reducer[A, B] to ArrowAssoc[Reducer[A, B]]

Ungrouped