Trait/Object

framian

Column

Related Docs: object Column | package framian

Permalink

sealed trait Column[+A] extends AnyRef

Source
Column.scala
Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Column
  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 apply(row: Int): Cell[A]

    Permalink

    Returns the Cell at row row.

  2. abstract def filter(p: (A) ⇒ Boolean): Column[A]

    Permalink

    Filters the values of this Column so that any value for which p is true remains a value and all other values are turned into NAs.

    Filters the values of this Column so that any value for which p is true remains a value and all other values are turned into NAs.

    p

    predicate to filter this column's values with

  3. abstract def flatMap[B](f: (A) ⇒ Cell[B]): Column[B]

    Permalink

    Map the values of this Column to a new Cell.

    Map the values of this Column to a new Cell. All NA and NM values remain the same.

    f

    function use to transform this column's values

  4. abstract def force(len: Int): Column[A]

    Permalink

    Returns a column which has had all rows between 0 and len (exclusive) forced (evaluated) and stored in memory, while all rows outside of 0 and len are set to NA.

    Returns a column which has had all rows between 0 and len (exclusive) forced (evaluated) and stored in memory, while all rows outside of 0 and len are set to NA. The returned column is *dense* and unboxed.

    len

    the upper bound of the range of values to force

  5. abstract def map[B](f: (A) ⇒ B): Column[B]

    Permalink

    Map all values of this Column using f.

    Map all values of this Column using f. All NA and NM values remain as they were.

  6. abstract def mask(na: Mask): Column[A]

    Permalink

    Returns a column with rows contained in na masked to NAs.

    Returns a column with rows contained in na masked to NAs.

    na

    the rows to mask in the column

  7. abstract def memoize(optimistic: Boolean = false): Column[A]

    Permalink

    Returns a copy of this column whose values will be memoized if they are evaluated.

    Returns a copy of this column whose values will be memoized if they are evaluated. That is, if this column is an *eval* column, then memoizing it will ensure that, for each row, the value is only computed once, regardless of the number of times it is accessed.

    By default, the memoization is always pessimistic (guaranteed at-most-once evaluation). If optimistic is true, then the memoizing may use an optimistic update strategy, which means a value *may* be evaluated more than once if it accessed concurrently.

    For dense, empty, and previously-memoized columns, this just returns the column itself.

    optimistic

    if true, memoized column may use optimistic updates

  8. abstract def orElse[A0 >: A](that: Column[A0]): Column[A0]

    Permalink

    Returns a column that will fallback to that for any row that is NA, or if the row is NM and the row in that is a Value, then that is returned, otherwise NM is returned.

    Returns a column that will fallback to that for any row that is NA, or if the row is NM and the row in that is a Value, then that is returned, otherwise NM is returned. That is, row i is defined as this(i) orElse that(i), though may be more efficient.

    To put the definition in more definite terms:

    Value(a) orElse Value(b) == Value(a)
    Value(a) orElse       NA == Value(a)
    Value(a) orElse       NM == Value(a)
          NA orElse Value(b) == Value(b)
          NA orElse       NA ==       NA
          NA orElse       NM ==       NM
          NM orElse Value(b) == Value(b)
          NM orElse       NM ==       NM
          NM orElse       NA ==       NM
    that

    the column to fallback on for NA values

  9. abstract def reindex(index: Array[Int]): Column[A]

    Permalink

    Returns a column whose i-th row maps to row index(i) in this column.

    Returns a column whose i-th row maps to row index(i) in this column. If i < 0 or i >= index.length then the returned column returns NA. This always forces all rows in index and the returned column is *dense* and unboxed.

  10. abstract def setNA(row: Int): Column[A]

    Permalink

    Returns a column with a single row forced to NA and all others remaining the same.

    Returns a column with a single row forced to NA and all others remaining the same. This is equivalent to, but possibly more efficient than col.mask(Mask(row)).

    row

    the row that will be forced to NA

  11. abstract def shift(rows: Int): Column[A]

    Permalink

    Shifts all values in the column up by rows rows.

    Shifts all values in the column up by rows rows. So, col.shift(n).apply(row) == col(row - n). If this is a dense column, then it will only remain dense if rows is non-negative.

  12. abstract def zipMap[B, C](that: Column[B])(f: (A, B) ⇒ C): Column[C]

    Permalink

    For each row in the resulting column, this will return this(row).zipMap(that(row)).

    For each row in the resulting column, this will return this(row).zipMap(that(row)). Specifically, if this(row) or that(row) is NA, then the row is NA, if both sides are values, then the row is the result of applying f, otherwise the row is NM.

    that

    the column to zip this column with

    f

    the function to use to combine 2 values to a single value

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 Column[A] to any2stringadd[Column[A]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Column[A], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Column[A] to ArrowAssoc[Column[A]] 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: (Column[A]) ⇒ Boolean, msg: ⇒ Any): Column[A]

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

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

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

    Permalink
    Implicit information
    This member is added by an implicit conversion from Column[A] to Ensuring[Column[A]] 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. macro def foldRow[B](row: Int)(na: B, nm: B, f: (A) ⇒ B): B

    Permalink
  16. macro def foreach[U](from: Int, until: Int, rows: (Int) ⇒ Int, abortOnNM: Boolean)(f: (Int, A) ⇒ U): Boolean

    Permalink

    Iterates from from until until, and for each value i in this range, it retreives a row via rows(i).

    Iterates from from until until, and for each value i in this range, it retreives a row via rows(i). If this row is NM and abortOnNM is true, then iteration stops immediately and false is returned. Otherwise, if the row is a value, it calls f with i and the value of the row. If iteration terminates normally (ie. no NMs), then true is returned.

    This is implemented as a macro and desugars into a while loop that access the column using apply if it is a BoxedColumn and isValueAt/valueAt/nonValueAt if it is an UnboxedColumn. It will also inline rows and f if they are function literals.

    from

    the value to start iterating at (inclusive)

    until

    the value to stop iterating at (exclusive)

    rows

    the function used to retrieve the row for an iteration

    abortOnNM

    terminate early if an NM is found

    f

    the function to call at each value

    returns

    true if no NMs were found (or abortOnNM is false) and terminate completed successfully, false otherwise

  17. macro def foreach[U](from: Int, until: Int, rows: (Int) ⇒ Int)(f: (Int, A) ⇒ U): Boolean

    Permalink

    Equivalent to calling foreach(from, until, rows, true)(f).

  18. def formatted(fmtstr: String): String

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

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

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

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

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

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

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

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

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

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

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

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

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

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Column[A] to any2stringadd[Column[A]]

Inherited by implicit conversion StringFormat from Column[A] to StringFormat[Column[A]]

Inherited by implicit conversion Ensuring from Column[A] to Ensuring[Column[A]]

Inherited by implicit conversion ArrowAssoc from Column[A] to ArrowAssoc[Column[A]]

Ungrouped