Class

framian.reduce

Exists

Related Doc: package reduce

Permalink

final class Exists[A] extends Reducer[A, Boolean]

A Reducer that exististentially quantifies a predicate as a reduction over a collection of Cells.

This reducer will return true upon encountering the first value that is available and meaningful and applying the predicate p to that value returns true. Otherwise, returns false.

This reducer is unusual in that it will ignore NonValues, in particular, it will not propogate NM. If the predicate can be satisfied by a value that is available and meaningful elsewhere in the collection, then this reduction should still return true.

This reducer will only traverse the entire collection if it never encounters an available and meaningful value that satisfies the predicate p.

A

the value type of the column to reduce.

Source
predicates.scala
Example:
  1. Series.empty[Int, Int].reduce(new Exists[Int](i => true)) == Value(false)
    Series(1 -> 1, 2 -> 2).reduce(new Exists[Int](i => i < 2)) == Value(true)
    Series.fromCells[Int, Int](1 -> NA, 2 -> 1).reduce(new Exists[Int](i => i < 2)) == Value(true)
    Series.fromCells[Int, Int](1 -> NM, 2 -> 1).reduce(new Exists[Int](i => i < 2)) == Value(true)
Note

This reducer will always return precisely Value[Boolean], rather than Cell[Boolean]. This in constrast to most reducers that will also return NonValues.

See also

ForAll

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Exists
  2. Reducer
  3. AnyRef
  4. 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

Instance Constructors

  1. new Exists(p: (A) ⇒ Boolean)

    Permalink

    Create a existential quantifier reducer from a predicate p.

    Create a existential quantifier reducer from a predicate p.

    p

    the predicate to apply to the values of the column.

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

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

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

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

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

    Permalink
    Implicit information
    This member is added by an implicit conversion from Exists[A] to Ensuring[Exists[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. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Exists[A] to StringFormat[Exists[A]] 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. def reduce(column: Column[A], indices: Array[Int], start: Int, end: Int): Value[Boolean]

    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

    Definition Classes
    ExistsReducer
  23. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

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

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

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

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

Inherited from Reducer[A, Boolean]

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped